com.ibm.commerce.tools.command
Class ToolsControllerCommandImpl

java.lang.Object
  CacheableCommandImpl
      com.ibm.commerce.command.AbstractECTargetableCommand
          com.ibm.commerce.command.ControllerCommandImpl
              com.ibm.commerce.tools.command.ToolsControllerCommandImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, ToolsControllerCommand
Direct Known Subclasses:
AccessSpaceCtrlCmdImpl, AddMemberToSpaceCtrlCmdImpl, AdminBidDeleteCmdImpl, AttributeCreateControllerCmdImpl, AttributeDeleteImpl, AttributeSequenceMoveDownImpl, AttributeSequenceMoveUpImpl, AttributeUpdateControllerCmdImpl, AttributeUpdateImpl, AttributeValueDialogCreateImpl, AttributeValueDialogUpdateImpl, AttributeValueSequenceMoveDownImpl, AttributeWizardCreateImpl, AuctionBaseCmdImpl, BidRuleBaseCmdImpl, CampaignInitiativeSaveControllerCmdImpl, CategoryCreateImpl, CategoryDeleteImpl, CategoryUpdateImpl, ChangeSpaceCtrlCmdImpl, ChangeUserRoleCtrlCmdImpl, CloseBiddingCmdImpl, CreateForumMessageCmdImpl, CreateSpaceCtrlCmdImpl, CSRBaseControllerCommandImpl, CSRCustomerAddressAddCmdImpl, CSRCustomerEnableAccountCmdImpl, CSRCustomerInfoCreateCmdImpl, CSRCustomerInfoUpdateCmdImpl, CSREmailOrderCmdImpl, CSROrderAdjustmentUpdateCmdImpl, CSROrderCancelCmdImpl, CSROrderCommentsAddCmdImpl, CSROrderCopyCmdImpl, CSROrderItemAddCmdImpl, CSROrderItemAddressUpdateCmdImpl, CSROrderItemSplitCmdImpl, CSROrderItemUpdateCmdImpl, CSROrderProductContractPriceCmdImpl, CSROrderRollBackCmdImpl, DeleteAuctionCmdImpl, DeleteAuctionStyleCmdImpl, DeleteSpaceCtrlCmdImpl, DiscountSaveCmdImpl, EmailActivityConfigurationSaveCmdImpl, EmailActivityDeleteCmdImpl, EmailActivitySaveCmdImpl, EmailEventCmdImpl, ExpectedInventoryRecordCloseCmdImpl, ExpectedInventoryRecordCreateCmdImpl, ExpectedInventoryRecordDeleteCmdImpl, ExpectedInventoryRecordUpdateCmdImpl, FulfillmentCenterCreateCmdImpl, FulfillmentCenterDeleteCmdImpl, FulfillmentCenterUpdateCmdImpl, HandleApprovalsCmdImpl, InventoryAdjustCmdImpl, ItemCreateImpl, ItemDeleteImpl, ItemGenerateImpl, ItemPriceDeleteImpl, ItemUpdateImpl, ModifyForumMessageCmdImpl, OfferingBaseCmdImpl, PAttributeBaseCmdImpl, PAttributeDeleteCmdImpl, PickBatchGenerateCmdImpl, ProcessToolsControllerCmdImpl, ProductAttributeValueDeleteImpl, ProductDeleteImpl, ProductNotebookUpdateImpl, ProductPricingControllerCmdImpl, ProductWizardCreateImpl, PromotionChooseCmdImpl, PromotionPublishCmdImpl, ReceiptCreateCmdImpl, ReleaseManifestCmdImpl, ReleaseShipConfirmCmdImpl, ReleaseShipDeleteCmdImpl, ReleaseShipUpdateCmdImpl, RemoveMemberFromSpaceCtrlCmdImpl, ReturnItemComponentDisposeCmdImpl, ReturnItemComponentReceiveCmdImpl, ReturnReasonCodeCreateCmdImpl, ReturnReasonCodeDeleteCmdImpl, ReturnReasonCodeUpdateCmdImpl, RFQCancelCmdImpl, RFQCloseCmdImpl, RFQCompleteCmdImpl, RFQCopyCmdImpl, RFQResponseAcceptCmdImpl, RFQResponseRejectCmdImpl, RFQSubmitCmdImpl, RLPromotionDeleteControllerCmdImpl, RLPromotionDuplicateControllerCmdImpl, RLPromotionPublishControllerCmdImpl, RLPromotionSaveControllerCmdImpl, SegmentSaveControllerCmdImpl, SetApprovalsDetailsViewCmdImpl, StoreCreationWizardCmdImpl, VendorCreateCmdImpl, VendorDeleteCmdImpl, VendorUpdateCmdImpl

public class ToolsControllerCommandImpl
extends ControllerCommandImpl
implements ToolsControllerCommand

Controller command to be used by Tools Framework, for example, command used inside WebSphere Commerce Accelerator.

See Also:
Serialized Form

Field Summary
Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext
Fields inherited from interface com.ibm.commerce.tools.command.ToolsControllerCommand
NAME
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
Constructor Summary
ToolsControllerCommandImpl()
Method Summary
TypedProperty getViewInputProperties()
This method is called by the WebController to retrieve the request properties set by the setRequestProperties() method.
void setRequestProperties(TypedProperty viewParm)
Sets request properties for for view command.
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

Constructor Detail

ToolsControllerCommandImpl

public ToolsControllerCommandImpl()
Method Detail

getViewInputProperties

public TypedProperty getViewInputProperties()
This method is called by the WebController to retrieve the request properties set by the setRequestProperties() method.

The tools need to override this method because otherwise the properties passed into the controller command would be then passed onto the view command. This is unnecessary for the tools and actually will break the flow when using the ReDirectView command because the URL to re-direct to cannot be more than 500 chars. The XML parameter alone passed into the controller command is longer than this and therefore without overriding this method we couldn't re-direct to the view command.

Specified by:
getViewInputProperties in interface ControllerCommand
Overrides:
getViewInputProperties in class ControllerCommandImpl
Returns:
The request properties to be passed to the viewCommand.

setRequestProperties

public void setRequestProperties(TypedProperty viewParm)
                          throws ECApplicationException
Sets request properties for for view command.

In the default implementation, this method simply saves the request properties.

Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
viewParm - Reuest properties to be set.
Throws:
ECApplicationException - If the request properties can't be processed

Feedback