com.ibm.commerce.approval.commands
Interface ApprovalCheckApproverForEntityCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
ApprovalCheckApproverForEntityCmdImpl

public interface ApprovalCheckApproverForEntityCmd
extends TaskCommand

Checks whether a user is an approver for a particular submission.

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

Upon completion of the command, the following should be called to retrieve boolean result

Behaviour

This command will check if there is an approval record for the given approver ID and entity (flowtype and BusinessEntityId).


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
 boolean isApprover()
          Returns whether or not the user is an approver.
 void setApproverId(java.lang.Long approverId)
          Sets the user ID to check for approver status of the entity.
 void setBusinessEntityId(java.lang.Long businessEntityId)
          Sets the ID of the business entity object for which the approval is being requested.
 void setBusinessFlowTypeIdentifier(java.lang.String businessFlowTypeIdentifier)           Sets the identifier of the type of business flow for the 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

isApprover

public boolean isApprover()
Returns whether or not the user is an approver.
Returns:
boolean

setApproverId

public void setApproverId(java.lang.Long approverId)
Sets the user ID to check for approver status of the entity.
Parameters:
approverId - A user id

setBusinessEntityId

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

setBusinessFlowTypeIdentifier

public void setBusinessFlowTypeIdentifier(java.lang.String businessFlowTypeIdentifier)
Sets the identifier of the type of business flow for the approvable action.
Parameters:
businessFlowTypeIdentifier - The type of flow for this approval