com.ibm.commerce.approval.commands
Interface ApprovalProcessRecordsCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
ApprovalProcessRecordsCmdImpl

public interface ApprovalProcessRecordsCmd
extends TaskCommand

Processes an approval action with respect to the approval records. Approval actions include the approver approving or rejecting or the submitter canceling. The approver may supply an optional comment which will be stored in the approval request's record in the APRVSTATUS table.

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

Behaviour

This command loop through the records in the APRVSTATUS table for the given entity. Records that are for the given entity, but whose approver_id does not match the actor, get deleted. If there is a record whose approver_id matches the actor for the given entity, the status and action timestamp are updated.


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
 void setAction(java.lang.Integer action)
          Sets the action being performed: approve, reject, or cancel.
 void setActorId(java.lang.Long actorId)
          Sets the user performing the action.
 void setBusinessEntityId(java.lang.Long businessEntityId)
          Sets the ID of the business entity object being acted on.
 void setBusinessFlowId(java.lang.Long businessFlowId)
          Sets the flow being used for this approval process.
 void setComment(java.lang.String comment)           Sets a comment that the actor wants included with the 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

setAction

public void setAction(java.lang.Integer action)
Sets the action being performed: approve, reject, or cancel. Represented as an integer.
Parameters:
action - The action being performed: approve, reject, or cancel

setActorId

public void setActorId(java.lang.Long actorId)
Sets the user performing the action.
Parameters:
actorId - The user acting on the approval

setBusinessEntityId

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

setBusinessFlowId

public void setBusinessFlowId(java.lang.Long businessFlowId)
Sets the flow being used for this approval process.
Parameters:
businessFlowId - The flow being used for this approval

setComment

public void setComment(java.lang.String comment)
Sets a comment that the actor wants included with the action.
Parameters:
comment - The reason supplied by actor for performing the action