com.ibm.commerce.foundation.server.command.bod

Interface BusinessObjectDocumentCmd

All Superinterfaces:

com.ibm.websphere.command.Command, java.io.Serializable

All Known Subinterfaces:

ChangeActivityCmd, ChangeCampaignCmd, ChangeCatalogFilterCmd, ChangeClientLocationCmd, ChangeGiftListCmd, ChangeInstallmentRuleCmd, ChangeInventoryAvailabilityCmd, ChangeLayoutCmd, ChangeMarketingContentCmd, ChangeMarketingEmailTemplateCmd, ChangeMarketingSpotCmd, ChangeMemberGroupCmd, ChangeOnlineStoreCmd, ChangePageCmd, ChangePointOfInterestCmd, ChangeSearchTermAssociationCmd, ChangeSubscriptionCmd, ChangeWalletCmd, ChangeWalletItemCmd, GetActivityCmd, GetBusinessAccountCmd, GetCampaignCmd, GetCampaignElementTemplateCmd, GetCatalogEntryInstallmentPriceCmd, GetCatalogFilterCmd, GetClientLocationCmd, GetGeoNodeCmd, GetGiftListCmd, GetInstallmentRuleCmd, GetInventoryAvailabilityCmd, GetLayoutCmd, GetMarketingContentCmd, GetMarketingEmailTemplateCmd, GetMarketingSpotCmd, GetMarketingSpotDataCmd, GetOrderInstallmentPriceCmd, GetPageCmd, GetPageDesignCmd, GetPhysicalStoreCmd, GetPointOfInterestCmd, GetSearchTermAssociationCmd, GetSubscriptionCmd, GetWalletCmd, GetWalletItemCmd, GetWidgetDefinitionCmd, ProcessActivityCmd, ProcessCampaignCmd, ProcessCatalogFilterCmd, ProcessClientLocationCmd, ProcessGiftListCmd, ProcessInstallmentRuleCmd, ProcessInventoryRequirementCmd, ProcessLayoutCmd, ProcessMarketingContentCmd, ProcessMarketingEmailTemplateCmd, ProcessMarketingSpotCmd, ProcessMarketingTriggerCmd, ProcessMemberGroupCmd, ProcessOnlineStoreCmd, ProcessPageCmd, ProcessPointOfInterestCmd, ProcessSearchTermAssociationCmd, ProcessSubscriptionCmd, ProcessWalletCmd, ProcessWalletItemCmd, SyncInventoryAvailabilityCmd, SyncWalletCmd, SyncWalletItemCmd

All Known Implementing Classes:

AbstractActionBusinessObjectDocumentCmdImpl, AbstractChangeBusinessObjectDocumentCmdImpl, AbstractChangeNounUsingBusinessObjectMediatorCmdImpl, AbstractGetBusinessObjectDocumentCmdImpl, AbstractProcessBusinessObjectDocumentCmdImpl, AbstractProcessNounUsingBusinessObjectMediatorCmdImpl, AbstractSyncBusinessObjectDocumentCmdImpl, AbstractSyncNounUsingBusinessObjectMediatorCmdImpl, AttachmentMessageMappingCmdImpl, com.ibm.commerce.foundation.celadon.common.oagis.CeladonChangeNounUsingBusinessObjectMediatorCmdImpl, ChangeActivityCmdImpl, ChangeAttachmentCmdImpl, ChangeCampaignCmdImpl, ChangeCatalogCmdImpl, ChangeCatalogEntryCmdImpl, ChangeCatalogFilterCmdImpl, ChangeCatalogGroupCmdImpl, ChangeClientLocationCmdImpl, ChangeGiftListCmdImpl, ChangeInstallmentRuleCmdImpl, ChangeInventoryAvailabilityCmdImpl, ChangeLayoutCmdImpl, ChangeMarketingContentCmdImpl, ChangeMarketingEmailTemplateCmdImpl, ChangeMarketingSpotCmdImpl, ChangeMemberGroupCmdImpl, ChangeOnlineStoreCmdImpl, ChangePageCmdImpl, ChangePointOfInterestCmdImpl, ChangePromotionCmdImpl, ChangeSearchTermAssociationCmdImpl, ChangeSubscriptionCmdImpl, ChangeWalletCmdImpl, ChangeWalletItemCmdImpl, GetActivityCmdImpl, GetAttachmentCmdImpl, GetBusinessAccountCmdImpl, GetCampaignCmdImpl, GetCampaignElementTemplateCmdImpl, GetCatalogCmdImpl, GetCatalogEntryCmdImpl, GetCatalogEntryInstallmentPriceCmdImpl, GetCatalogFilterCmdImpl, GetCatalogGroupCmdImpl, GetClientLocationCmdImpl, GetConfigurationCmdImpl, GetContractCmdImpl, GetGeoNodeCmdImpl, GetGiftListCmdImpl, GetInstallmentRuleCmdImpl, GetInventoryAvailabilityCmdImpl, GetKitCmdImpl, GetLayoutCmdImpl, GetManagedDirectoryCmdImpl, GetManagedFileCmdImpl, GetMarketingContentCmdImpl, GetMarketingEmailTemplateCmdImpl, GetMarketingSpotCmdImpl, GetMarketingSpotDataCmdImpl, GetMemberGroupCmdImpl, GetOnlineStoreCmdImpl, GetOrderCmdImpl, GetOrderInstallmentPriceCmdImpl, GetOrganizationCmdImpl, GetPageCmdImpl, GetPageDesignCmdImpl, GetPersonCmdImpl, GetPhysicalStoreCmdImpl, GetPointOfInterestCmdImpl, GetPromotionCmdImpl, GetSearchTermAssociationCmdImpl, GetSubscriptionCmdImpl, GetWalletCmdImpl, GetWalletItemCmdImpl, GetWidgetDefinitionCmdImpl, ManagedDirectoryMessageMappingCmdImpl, MessageMappingCmdImpl, OrderMessageMappingCmdImpl, ProcessActivityCmdImpl, ProcessAttachmentCmdImpl, ProcessCampaignCmdImpl, ProcessCatalogCmdImpl, ProcessCatalogEntryCmdImpl, ProcessCatalogFilterCmdImpl, ProcessCatalogGroupCmdImpl, ProcessClientLocationCmdImpl, ProcessClientLocationCmdImplExtended, ProcessGiftListCmdImpl, ProcessInstallmentRuleCmdImpl, ProcessInventoryRequirementCmdImpl, ProcessLayoutCmdImpl, ProcessManagedDirectoryCmdImpl, ProcessManagedFileCmdImpl, ProcessMarketingContentCmdImpl, ProcessMarketingEmailTemplateCmdImpl, ProcessMarketingSpotCmdImpl, ProcessMarketingTriggerCmdImpl, ProcessMemberGroupCmdImpl, ProcessOnlineStoreCmdImpl, ProcessPageCmdImpl, ProcessPointOfInterestCmdImpl, ProcessPromotionCmdImpl, ProcessSearchTermAssociationCmdImpl, ProcessSubscriptionCmdImpl, ProcessWalletCmdImpl, ProcessWalletItemCmdImpl, SyncInventoryAvailabilityCmdImpl, SyncWalletCmdImpl, SyncWalletItemCmdImpl

public interface BusinessObjectDocumentCmd
extends com.ibm.websphere.command.Command

This interface represents any command that is invoked by the BusinessObjectDocumentProcessor to process a business object document. All top level commands should implement this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
BusinessObjectDocumentType	getResultBusinessObjectDocument() This method returns the response business object document.
void	handleException(java.lang.Exception exception) This method sets the exception as the result of executing the request.
void	setRequestBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument) This method sets the business object document to process.

Methods inherited from interface com.ibm.websphere.command.Command

execute, isReadyToCallExecute, reset

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Method Detail

getResultBusinessObjectDocument

BusinessObjectDocumentType getResultBusinessObjectDocument()

This method returns the response business object document. This generic method should delegate to the appropriate get method that returns the typed business object document the implementation returns.

Returns:

The business object document that is the response to the request.

setRequestBusinessObjectDocument

void setRequestBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument)

This method sets the business object document to process. This is the generic method that will call the appropriate set method that accepts a specific type of business object document that the command implementation will understand.

Parameters:

businessObjectDocument - The request business object document to be processed.

handleException

void handleException(java.lang.Exception exception)

This method sets the exception as the result of executing the request. The command implementation uses this call out method to populate the response business object document with the exception information. Although the getResultBusinessObjectDocument() will still be used to return the result, this call out will indicate that exception information is required to be populated.

Parameters:

exception - The application exception that occurred when executing the business object document.