com.ibm.commerce.approval.commands

Interface ApprovalProcessCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    ApprovalProcessCmdImpl

    public interface ApprovalProcessCmd
extends com.ibm.commerce.command.TaskCommand
    Delegates to ApprovalProcessRecordsCmd to process an approval action. Processes an approval action with respect to the approval records. Approval actions include the approver approving or rejecting or the submitter canceling. The approver may supply an optional comment which will be stored in the approval request's record in the APRVSTATUS table.

    Before executing this task command the following sets should be performed:

  • setBusinessFlowEventData(): Pass the information about the approval records being worked on
  • setAction(): what type of approval action is being processed: approve, reject, cancel

    • Behaviour

    This command will set up for and call ApprovalProcessRecordsCmd.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The default implementation class.
      static java.lang.String NAME
      The name of the Command Interface class.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setAction(java.lang.Integer action)
      Sets the list of approval status IDs to be acted on.
      void setBusinessFlowEventData(BusinessFlowEventData businessFlowEventData)
      Sets the data structure used to process the approval.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute

      • Methods inherited from interface com.ibm.commerce.command.ECCommand

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

    • Field Detail

      • COPYRIGHT

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

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class.
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        The name of the Command Interface class.
        See Also:
        Constant Field Values

    • Method Detail

      • setAction

        void setAction(java.lang.Integer action)
        Sets the list of approval status IDs to be acted on.
        Parameters:
        action - The type of approval action being taken: approve, reject, or cancel (represented by integers)

      • setBusinessFlowEventData

        void setBusinessFlowEventData(BusinessFlowEventData businessFlowEventData)
        Sets the data structure used to process the approval.
        Parameters:
        businessFlowEventData - The data for the event representing the approval action.