com.ibm.commerce.approval.commands

Interface ApprovalSetUpCmd

  • 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:
    ApprovalSetUpCmdImpl

    public interface ApprovalSetUpCmd
extends com.ibm.commerce.command.TaskCommand
    Delegates to the ApprovalSetUpRecordsCmd to set up for an action needing approval.

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

  • setApproverGroupName()
  • setBusinessFlowEventData()

    • After executing this task command, the following should be called:

  • isApprovalNeeded()
  • getEventIdentifier()

    • Behaviour

    This command will set up for and call the ApprovalSetUpRecordsCmd.

    • 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
      java.lang.String getEventIdentifier()
      Gets the event that needs to be processed when an automatic approval is required.
      boolean isApprovalNeeded()
      Specifies whether or not an approval is needed.
      void setApproverGroupName(java.lang.String approverGroupName)
      Sets the approver group name from which the approvers are to be derived.
      void setBusinessFlowEventData(BusinessFlowEventData businessFlowEventData)
      Sets the data related to the business flow event.
      void setBusinessFlowStateId(java.lang.Long businessFlowStateId)
      Sets the state of the business flow for this approvable action.

      • 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

      • getEventIdentifier

        java.lang.String getEventIdentifier()
        Gets the event that needs to be processed when an automatic approval is required.
        Returns:
        The event identifier of an automatic approval that needs to be processed because of the lack of an approval member group

      • isApprovalNeeded

        boolean isApprovalNeeded()
        Specifies whether or not an approval is needed. If not an automatic approval can be performed.
        Returns:
        true if an approval is needed; false if the action should be automatically approved

      • setApproverGroupName

        void setApproverGroupName(java.lang.String approverGroupName)
        Sets the approver group name from which the approvers are to be derived.
        Parameters:
        approverGroupName - The approval member group name from which the approvers are chosen

      • setBusinessFlowEventData

        void setBusinessFlowEventData(BusinessFlowEventData businessFlowEventData)
        Sets the data related to the business flow event.
        Parameters:
        businessFlowEventData - The data included as part of the event

      • setBusinessFlowStateId

        void setBusinessFlowStateId(java.lang.Long businessFlowStateId)
        Sets the state of the business flow for this approvable action.
        Parameters:
        businessFlowStateId - the state of the business flow for this approvable action