com.ibm.commerce.ubf.commands

Class ToolsBusinessFlowCmdImpl

  • 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.tools.command.ToolsControllerCommandImpl
              • com.ibm.commerce.ubf.commands.ToolsBusinessFlowCmdImpl
  • 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, com.ibm.commerce.tools.command.ToolsControllerCommand, BusinessFlowCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class ToolsBusinessFlowCmdImpl
extends com.ibm.commerce.tools.command.ToolsControllerCommandImpl
implements BusinessFlowCmd
    ToolsBusinessFlowCmdImpl is an abstract tools controller command which implments the BusinessFlowCmd interface. If Action commands, which are controller commands on state machine transitions, are used in WCS Tools environment, they 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.tools.command.ToolsControllerCommand

        NAME

      • 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()
      Gets the flow context.
      java.lang.Integer getStateIdentifier()
      Get the state identifier.
      boolean isReadyToCallExecute()
      Check whether or not this commmand is ready for execution.
      void reset()
      Reset the command so that it can be executed again.
      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)
      Sets the flow context.
      void setRequestPropterties(com.ibm.commerce.datatype.TypedProperty reqParms)
      Sets the request properties; delegates to the super class.
      void setStateIdentifier(java.lang.Integer newStateIdentifier)
      Set the state identifier.

      • Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl

        getViewInputProperties, setRequestProperties

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • 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, 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

        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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills, getOwner

    • Field Detail

      • COPYRIGHT

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

    • Constructor Detail

      • ToolsBusinessFlowCmdImpl

        public ToolsBusinessFlowCmdImpl()

    • 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()
        Gets the flow context.
        Specified by:
        getFlowContext in interface BusinessFlowCmd
        Returns:
        String The flow context.

      • getStateIdentifier

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

      • isReadyToCallExecute

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

      • reset

        public void reset()
        Reset the command so that it can be executed again.
        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)
        Sets the flow context.
        Specified by:
        setFlowContext in interface BusinessFlowCmd
        Parameters:
        newFlowContext - String The flow context.

      • setRequestPropterties

        public void setRequestPropterties(com.ibm.commerce.datatype.TypedProperty reqParms)
                           throws com.ibm.commerce.exception.ECException
        Sets the request properties; delegates to the super class.
        Parameters:
        reqParms - The requestProperties.
        Throws:
        com.ibm.commerce.exception.ECException

      • setStateIdentifier

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