com.ibm.commerce.approval.commands

Interface ApprovalSetUpRecordsCmd

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

    public interface ApprovalSetUpRecordsCmd
extends com.ibm.commerce.command.TaskCommand
    Set up for an action needing approval.

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

  • setApproverGroupName()
  • either setApproverOrgId() or setUserIdFromApproverOrg()
  • setBusinessEntityId()
  • setBusinessFlowId()
  • setBusinessFlowTypeId()

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

  • isApprovalNeeded()
  • getEventIdentifier()

    • Behaviour

    This command will create one APRVSTATUS record for each potential approver of the action.

    • 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 identifier.
      boolean isApprovalNeeded()
      Specifies whether the approval is needed.
      void setApproverGroupName(java.lang.String approverGroupName)
      Sets the approver group name from which the approvers are to be derived
      void setApproverOrgId(java.lang.Long approverOrgId)
      Sets the ID of the organization that needs to do the approval
      void setBusinessEntityId(java.lang.Long businessEntityId)
      The ID of the object being acted on.
      void setBusinessFlowId(java.lang.Long businessFlowId)
      Sets the flow being used for this approval process.
      void setBusinessFlowStateId(java.lang.Long businessFlowStateId)
      Sets the state of the business flow for this approvable action.
      void setBusinessFlowTypeId(java.lang.Long businessFlowTypeId)
      Sets the ID of the type of business flow for the approvable action.
      void setUserIdFromApproverOrg(java.lang.Long userIdFromApproverOrg)
      Sets the ID of a user from the organization that needs to do 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

      • getEventIdentifier

        java.lang.String getEventIdentifier()
        Gets the event identifier.
        Returns:
        String The event identifier.

      • isApprovalNeeded

        boolean isApprovalNeeded()
        Specifies whether the approval is needed.
        Returns:
        boolean

      • 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

      • setApproverOrgId

        void setApproverOrgId(java.lang.Long approverOrgId)
        Sets the ID of the organization that needs to do the approval
        Parameters:
        approverOrgId - The organization which may need to approve

      • setBusinessEntityId

        void setBusinessEntityId(java.lang.Long businessEntityId)
        The ID of the object being acted on.
        Parameters:
        businessEntityId - The entity on which the approval is being requested

      • setBusinessFlowId

        void setBusinessFlowId(java.lang.Long businessFlowId)
        Sets the flow being used for this approval process.
        Parameters:
        businessFlowId - The flow being used for this approval

      • 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

      • setBusinessFlowTypeId

        void setBusinessFlowTypeId(java.lang.Long businessFlowTypeId)
        Sets the ID of the type of business flow for the approvable action.
        Parameters:
        businessFlowTypeId - The type of flow for this approval

      • setUserIdFromApproverOrg

        void setUserIdFromApproverOrg(java.lang.Long userIdFromApproverOrg)
        Sets the ID of a user from the organization that needs to do the approval.
        Parameters:
        userIdApproverOrg - A user id from organization which may need to approve