com.ibm.commerce.approval.commands

Interface ApprovalCheckApproverForEntityCmd

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

    public interface ApprovalCheckApproverForEntityCmd
extends com.ibm.commerce.command.TaskCommand
    Checks whether a user is an approver for a particular submission.

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

  • setFlowType()
  • setApproverId()
  • setBusinessEntityIdentifier()

    • Upon completion of the command, the following should be called to retrieve boolean result

  • isApprover()

    • Behaviour

    This command will check if there is an approval record for the given approver ID and entity (flow type and BusinessEntityId).

    • 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
      boolean isApprover()
      Returns whether or not the user is an approver.
      void setApproverId(java.lang.Long approverId)
      Sets the user ID to check for approver status of the entity.
      void setBusinessEntityId(java.lang.Long businessEntityId)
      Sets the ID of the business entity object for which the approval is being requested.
      void setBusinessFlowTypeIdentifier(java.lang.String businessFlowTypeIdentifier)
      Sets the identifier of the type of business flow for the 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

      • isApprover

        boolean isApprover()
        Returns whether or not the user is an approver.
        Returns:
        boolean

      • setApproverId

        void setApproverId(java.lang.Long approverId)
        Sets the user ID to check for approver status of the entity.
        Parameters:
        approverId - A user id

      • setBusinessEntityId

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

      • setBusinessFlowTypeIdentifier

        void setBusinessFlowTypeIdentifier(java.lang.String businessFlowTypeIdentifier)
        Sets the identifier of the type of business flow for the approvable action.
        Parameters:
        businessFlowTypeIdentifier - The type of flow for this approval