com.ibm.commerce.ubf.commands

Class BusinessFlowCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.CacheableCommandImpl
      • com.ibm.commerce.command.MeasuredCacheableCommandImpl
        • com.ibm.commerce.command.AbstractECTargetableCommand
          • com.ibm.commerce.command.ControllerCommandImpl
            • com.ibm.commerce.ubf.commands.BusinessFlowCmdImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.security.Protectable, BusinessFlowCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command
    Direct Known Subclasses:
    ContractSubmitPostApprovalCmdImpl, ContractSubmitPostCancelCmdImpl, ContractSubmitPostRejectCmdImpl, ContractSubmitPreApprovalCmdImpl, ContractSubmitResponseCmdImpl


    public class BusinessFlowCmdImpl
    extends com.ibm.commerce.command.ControllerCommandImpl
    implements BusinessFlowCmd
    ControllerCommandImpl is an abstrart controller command which implements the BusinessFlowCmd interface. Action commands, which are controller commands, on state machine transitions are expected to extend this class, so developers do not need to implement methods related the BusinessFlowCmd interface again.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      • Fields inherited from interface com.ibm.commerce.command.ECCommand

        defaultCommandClassName
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Long getEntityId()
      Get the Id of the business flow entity.
      BusinessFlowEntityBean getEntityObject()
      Get the business flow entity object.
      java.lang.String getFlowContext()
      Get the flow context which is set up by the action cmd and to be stored into the FLINSTANCE table by UBF.
      java.lang.Integer getStateIdentifier()
      Get the state identifier.
      boolean isReadyToCallExecute()
      Check whether this commmand is ready for execution.
      void reset()
      Reset all parameters.
      void setEntityId(java.lang.Long newEntityId)
      Set the Id of the business flow entity.
      void setEntityObject(BusinessFlowEntityBean newEntityObject)
      Set the business flow entity object.
      void setFlowContext(java.lang.String newFlowContext)
      Insert the method's description here.
      void setStateIdentifier(java.lang.Integer newStateIdentifier)
      Set the state identifier.
      • Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

        checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setRequestProperties, setResponseProperties, setRetriable, setViewInputProperties
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

        accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
      • Methods inherited from interface com.ibm.commerce.command.ControllerCommand

        execute
      • Methods inherited from interface com.ibm.commerce.command.AccCommand

        accessControlCheck, getAccCheck, setAccCheck
      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • BusinessFlowCmdImpl

        public BusinessFlowCmdImpl()
    • Method Detail

      • getEntityId

        public java.lang.Long getEntityId()
        Get the Id of the business flow entity.
        Specified by:
        getEntityId in interface BusinessFlowCmd
        Returns:
        The Id of the business flow entity.
      • getFlowContext

        public java.lang.String getFlowContext()
        Description copied from interface: BusinessFlowCmd
        Get the flow context which is set up by the action cmd and to be stored into the FLINSTANCE table by UBF. This method will be called after the action cmd of a transition is executed.
        Specified by:
        getFlowContext in interface BusinessFlowCmd
        Returns:
        flow context
      • getStateIdentifier

        public java.lang.Integer getStateIdentifier()
        Get the state identifier.
        Returns:
        The state identifier.
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Check whether this commmand is ready for execution.
        Overrides:
        isReadyToCallExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Returns:
        true if condictions are met.
      • reset

        public void reset()
        Reset all parameters.
        Overrides:
        reset in class com.ibm.commerce.command.AbstractECTargetableCommand
      • setEntityId

        public void setEntityId(java.lang.Long newEntityId)
        Set the Id of the business flow entity.
        Parameters:
        newEntityId - The Id of the business flow entity.
      • setEntityObject

        public void setEntityObject(BusinessFlowEntityBean newEntityObject)
        Set the business flow entity object.
        Parameters:
        newEntityObject - The business flow entity object.
      • setFlowContext

        public void setFlowContext(java.lang.String newFlowContext)
        Insert the method's description here. Creation date: (8/10/2001 10:35:10 AM)
        Specified by:
        setFlowContext in interface BusinessFlowCmd
        Parameters:
        newFlowContext - java.lang.String
      • setStateIdentifier

        public void setStateIdentifier(java.lang.Integer newStateIdentifier)
        Set the state identifier.
        Specified by:
        setStateIdentifier in interface BusinessFlowCmd
        Parameters:
        newStateIdentifier - The state identifier.