com.ibm.commerce.approval.commands

Class ApprovalNotifyCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.CacheableCommandImpl
      • com.ibm.commerce.command.MeasuredCacheableCommandImpl
        • com.ibm.commerce.command.AbstractECTargetableCommand
          • com.ibm.commerce.command.TaskCommandImpl
            • com.ibm.commerce.approval.commands.ApprovalNotifyCmdImpl
  • All Implemented Interfaces:
    ApprovalNotifyCmd, com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, EntryActionCmd, com.ibm.commerce.ubf.util.BusinessFlowConstants, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class ApprovalNotifyCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements EntryActionCmd, ApprovalNotifyCmd, com.ibm.commerce.ubf.util.BusinessFlowConstants
    Calls the EntryActionCmd command which notifies approvers of the request for approval.

    Before executing this task command, the following must be ensured:

  • EntityID and FlowID have been provided in the BusinessFlowEventData object

    • Behaviour

  • Calls the ApproversNotifyCmd task command to build and send the approval message.

    • This command calls the following TaskCommands:

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String ERRTASK_NAME
      The error task name.

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

        defaultCommandClassName

      • Fields inherited from interface com.ibm.commerce.ubf.util.BusinessFlowConstants

        EC_APPLICATION_DEPENDENT, EC_APPROVAL, EC_APPROVAL_STATUS_CLASS, EC_APPROVAL_STATUS_DONE, EC_APPROVAL_STATUS_PENDING, EC_BUSINESS_FLOW_EVENT_IDENTIFIER, EC_CHILD_PROCESS, EC_COMMENTS, EC_COMPOSITE_FLOW, EC_ENTITY_ID, EC_ENTITY_OBJECT, EC_ERROR_VIEW, EC_FLOWCONTEXT, EC_FLOWDOMAIN_ID, EC_FLOWDOMAIN_IDENTIFIER, EC_FLOWID, EC_FLOWSTAGES, EC_FLOWTYPE_ID, EC_FLOWTYPE_IDENTIFIER, EC_MULTIROUND, EC_MULTISTAGE, EC_NO_APPROVAL, EC_NO_EVENT, EC_NO_SPAWNING, EC_NULL_EVENT, EC_NULLSTRING, EC_PRE_EXISTING_ENTITY_ID, EC_REJCET, EC_RESOURCE, EC_RESOURCE_ID, EC_RESOURCE_ID_DEFAULT, EC_RESOURCE_ID_NAME, EC_START_STATE, EC_UBF_ERROR, EC_UBF_FINAL_STATE, EC_UBF_GENERIC_ERROR_TASK, EC_UBF_NORMAL, EC_UBF_NORMAL_STATE, EC_UBF_START_STATE, EC_VERSIONING, FLOW_COMPOSE_TABLE, FLOW_DESCRIPTION_TABLE, FLOW_DOMAIN_DESCRIPTION_TABLE, FLOW_DOMAIN_TABLE, FLOW_INSTANCE_TABLE, FLOW_STATE_DESCRIPTION_TABLE, FLOW_STATE_GROUP_DESCRIPTION_TABLE, FLOW_STATE_GROUP_TABLE, FLOW_STATE_REL_TABLE, FLOW_STATE_TABLE, FLOW_TABLE, FLOW_TYPE_DESCRIPTION_TABLE, FLOW_TYPE_TABLE, TEXT_SEPARATOR, TRANSITION_DESCRIPTION_TABLE, TRANSITION_TABLE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      BusinessFlowEventData getBusinessFlowEventData()
      Returns the business flow event data.
      java.lang.Long getEntityId()
      Returns the entity ID.
      java.lang.Object getEntityObject()
      Returns the entity object.
      java.lang.String getEventIdentifier()
      Returns the event identifier.
      void performExecute()
      Calls the task command which will create the notification message.
      void setBusinessFlowEventData(BusinessFlowEventData newBusinessFlowEventData)
      Sets the business flow event data.
      void setEntityId(java.lang.Long newEntityId)
      Sets the entity ID.
      void setEntityObject(java.lang.Object newEntityObject)
      Sets the entity object.
      void setEventIdentifier(java.lang.String newEventIdentifier)
      Sets the event identifier.
      void validateParameters()
      Verifies that EntityID and FlowID have been provided in the BusinessFlowEventData object.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

        accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

      • 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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

    • Field Detail

      • COPYRIGHT

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

      • ERRTASK_NAME

        public static final java.lang.String ERRTASK_NAME
        The error task name.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ApprovalNotifyCmdImpl

        public ApprovalNotifyCmdImpl()

    • Method Detail

      • getBusinessFlowEventData

        public BusinessFlowEventData getBusinessFlowEventData()
        Returns the business flow event data.
        Returns:
        BusinessFlowEventData

      • getEntityId

        public java.lang.Long getEntityId()
        Returns the entity ID.
        Returns:
        EntityID.

      • getEntityObject

        public java.lang.Object getEntityObject()
        Returns the entity object.
        Returns:
        entityObject

      • getEventIdentifier

        public java.lang.String getEventIdentifier()
        Returns the event identifier.
        Specified by:
        getEventIdentifier in interface EntryActionCmd
        Returns:
        eventIdentifier

      • performExecute

        public void performExecute()
                    throws com.ibm.commerce.exception.ECException
        Calls the task command which will create the notification message.

      • Sets EventIdentifier to EC_NO_EVENT
      • Creates and calls ApproversNotifyCmd; which will create the Approval Notification Message
Specified by:
performExecute in interface com.ibm.commerce.command.ECCommand
Overrides:
performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
Throws:
com.ibm.commerce.exception.ECException - If an error occurs while calling ApproversNotifyCmd.