com.ibm.commerce.approval.commands

Interface ApproversNotifyCmd

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

    public interface ApproversNotifyCmd
extends com.ibm.commerce.command.TaskCommand
    Task command to notify approvers of request for approval. Before executing this task command, the following sets should be performed:
  • setEntityId()
  • setFlowTypeId()
    • Behaviour
  • Looks up the IDs of the approvers from the associated approver group
  • Adds IDs as recipients of the message
  • Uses view to generate subject and body of the message
  • Queues message for delivery

    • 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 setEntityId(java.lang.Long lngEntityId)
      Sets the Entity ID.
      void setFlowId(java.lang.Long lngFlowId)
      Sets the Flow ID.
      void setFlowTypeId(java.lang.Long lngFlowTypeId)
      Sets the Flow Type ID.

      • 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

      • setEntityId

        void setEntityId(java.lang.Long lngEntityId)
        Sets the Entity ID.
        Parameters:
        The - Entity ID

      • setFlowId

        void setFlowId(java.lang.Long lngFlowId)
        Sets the Flow ID.
        Parameters:
        The - Flow ID

      • setFlowTypeId

        void setFlowTypeId(java.lang.Long lngFlowTypeId)
        Sets the Flow Type ID.
        Parameters:
        The - Flow Type ID