com.ibm.commerce.approval.commands
Class ApprovalNotifyCmdImpl

java.lang.Object
  CacheableCommandImpl
      com.ibm.commerce.command.AbstractECTargetableCommand
          com.ibm.commerce.command.TaskCommandImpl
              com.ibm.commerce.approval.commands.ApprovalNotifyCmdImpl
All Implemented Interfaces:
ApprovalNotifyCmd, ECCommand, ECTargetableCommand, TaskCommand

public class ApprovalNotifyCmdImpl
extends TaskCommandImpl
implements ApprovalNotifyCmd

Calls the EntryActionCmd command which notifies approvers of the request for approval.

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

Behaviour

This command calls the following TaskCommands:

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
IBM copyright notice field.
static java.lang.String ERRTASK_NAME
The error task name.
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext
Fields inherited from interface com.ibm.commerce.approval.commands.ApprovalNotifyCmd
defaultCommandClassName, NAME
Constructor Summary
ApprovalNotifyCmdImpl()
Method Summary
com.ibm.commerce.ubf.event.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(com.ibm.commerce.ubf.event.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 com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, 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 com.ibm.commerce.ubf.event.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.
Returns:
eventIdentifier

performExecute

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

setBusinessFlowEventData

public void setBusinessFlowEventData(com.ibm.commerce.ubf.event.BusinessFlowEventData newBusinessFlowEventData)
Sets the business flow event data.
Parameters:
newBusinessFlowEventData - BusinessFlowEventData
See Also:
EntryActionCmd

setEntityId

public void setEntityId(java.lang.Long newEntityId)
Sets the entity ID.
Parameters:
newEntityId - entity ID.
See Also:
EntryActionCmd

setEntityObject

public void setEntityObject(java.lang.Object newEntityObject)
Sets the entity object.
Parameters:
newEntityObject - entity object
See Also:
EntryActionCmd

setEventIdentifier

public void setEventIdentifier(java.lang.String newEventIdentifier)
Sets the event identifier.
Parameters:
newEventIdentifier - event identifier

validateParameters

public void validateParameters()
                        throws ECException
Verifies that EntityID and FlowID have been provided in the BusinessFlowEventData object.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException - If an error is found while verifying parameters.

Feedback