java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.approval.commands.ApprovalSetUpRecordsCmdImpl
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 create one APRVSTATUS record for each potential approver of the action.
This command calls the following TaskCommands:
This command uses the following AccessBeans:
Field Summary | |
---|---|
protected
java.lang.String |
approverGroupName Approval group name. |
protected
java.lang.Long |
approverOrgId Approver Organization id. |
protected
java.lang.Long |
businessEntityId Entity id. |
protected
java.lang.Long |
businessFlowId Flow id. |
protected
java.lang.Long |
businessFlowStateId Flow state id. |
protected
java.lang.Long |
businessFlowTypeId Flow type id. |
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
protected
java.lang.String |
eventIdentifier Event identifier. |
protected
java.lang.Long |
userIdFromApproverOrg User id from approver organization. |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.approval.commands. ApprovalSetUpRecordsCmd |
defaultCommandClassName,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
ApprovalSetUpRecordsCmdImpl() Default constructor |
Method Summary | |
---|---|
java.lang.String |
getEventIdentifier() Gets the event identifier. |
boolean |
isApprovalNeeded() Specifies whether or not approval is needed. |
boolean |
isReadyToCallExecute() Check if the command is ready to be executed. |
void |
performExecute() The main logic. |
void |
setApproverGroupName(java.lang.String newApproverGroupName) Sets the approver group name from which the approvers are to be derived. |
void |
setApproverOrgId(java.lang.Long newApproverOrgId) Sets the ID of the organization that needs to do the approval. |
void |
setBusinessEntityId(java.lang.Long newBusinessEntityId) The ID of the object being acted on. |
void |
setBusinessFlowId(java.lang.Long newBusinessFlowId) Sets the flow being used for this approval process. |
void |
setBusinessFlowStateId(java.lang.Long newBusinessFlowStateId) Sets the state of the business flow for this approvable action. |
void |
setBusinessFlowTypeId(java.lang.Long newBusinessFlowTypeId) Sets the ID of the type of business flow for the approvable action. |
void |
setUserIdFromApproverOrg(java.lang.Long newUserIdFromApproverOrg) Sets the ID of a user from the organization that needs to do the approval. |
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,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected java.lang.String eventIdentifier
protected java.lang.String approverGroupName
protected java.lang.Long approverOrgId
protected java.lang.Long userIdFromApproverOrg
protected java.lang.Long businessFlowTypeId
protected java.lang.Long businessFlowId
protected java.lang.Long businessEntityId
protected java.lang.Long businessFlowStateId
Constructor Detail |
---|
public ApprovalSetUpRecordsCmdImpl()
Method Detail |
---|
public java.lang.String getEventIdentifier()
getEventIdentifier
in interface
ApprovalSetUpRecordsCmd
public boolean isApprovalNeeded()
isApprovalNeeded
in interface
ApprovalSetUpRecordsCmd
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException.
ECException
public void setApproverGroupName(java.lang.String newApproverGroupName)
setApproverGroupName
in interface
ApprovalSetUpRecordsCmd
newApproverGroupName
- The approval member group name from
which the approvers are chosenpublic void setApproverOrgId(java.lang.Long newApproverOrgId)
setApproverOrgId
in interface
ApprovalSetUpRecordsCmd
newApproverOrgId
- The organization which may need to
approvepublic void setBusinessEntityId(java.lang.Long newBusinessEntityId)
setBusinessEntityId
in interface
ApprovalSetUpRecordsCmd
newBusinessEntityId
- The entity on which the approval is
being requestedpublic void setBusinessFlowId(java.lang.Long newBusinessFlowId)
setBusinessFlowId
in interface
ApprovalSetUpRecordsCmd
newBusinessFlowId
- The flow being used for this
approvalpublic void setBusinessFlowStateId(java.lang.Long newBusinessFlowStateId)
setBusinessFlowStateId
in interface
ApprovalSetUpRecordsCmd
newBusinessFlowStateId
- the state of the business flow for
this approvable actionpublic void setBusinessFlowTypeId(java.lang.Long newBusinessFlowTypeId)
setBusinessFlowTypeId
in interface
ApprovalSetUpRecordsCmd
newBusinessFlowTypeId
- The type of flow for this
approvalpublic void setUserIdFromApproverOrg(java.lang.Long newUserIdFromApproverOrg)
setUserIdFromApproverOrg
in interface
ApprovalSetUpRecordsCmd
newUserIdFromApproverOrg
- A user id from organization which
may need to approve