com.ibm.commerce.approval.commands
Interface ApprovalSetUpCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
ApprovalSetUpCmdImpl

public interface ApprovalSetUpCmd
extends TaskCommand

Delegates to the ApprovalSetUpRecordsCmd to set up for an action needing approval.

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

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

Behaviour

This command will set up for and call the ApprovalSetUpRecordsCmd.


Field Summary
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
 java.lang.String getEventIdentifier()
          Gets the event that needs to be processed when an automatic approval is required.
 boolean isApprovalNeeded()
          Specifies whether or not an approval is needed.
 void setApproverGroupName(java.lang.String approverGroupName)
          Sets the approver group name from which the approvers are to be derived.
 void setBusinessFlowEventData(BusinessFlowEventData businessFlowEventData)
          Sets the data related to the business flow event.
 void setBusinessFlowStateId(java.lang.Long businessFlowStateId)           Sets the state of the business flow for this approvable action.
 

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

NAME

public static final java.lang.String NAME
The name of the Command Interface class.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values
Method Detail

getEventIdentifier

public java.lang.String getEventIdentifier()
Gets the event that needs to be processed when an automatic approval is required.
Returns:
The event identifier of an automatic approval that needs to be processed because of the lack of an approval member group

isApprovalNeeded

public boolean isApprovalNeeded()
Specifies whether or not an approval is needed. If not an automatic approval can be performed.
Returns:
true if an approval is needed; false if the action should be automatically approved

setApproverGroupName

public 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

setBusinessFlowEventData

public void setBusinessFlowEventData(BusinessFlowEventData businessFlowEventData)
Sets the data related to the business flow event.
Parameters:
businessFlowEventData - The data included as part of the event

setBusinessFlowStateId

public 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