com.ibm.commerce.approval.commands
Class ApprovalCheckApproverForEntityCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.approval.commands.ApprovalCheckApproverForEntityCmdImpl
All Implemented Interfaces:
ApprovalCheckApproverForEntityCmd, ECCommand, ECTargetableCommand, TaskCommand

public class ApprovalCheckApproverForEntityCmdImpl
extends TaskCommandImpl
implements ApprovalCheckApproverForEntityCmd

This task commadn 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 + BusinessEntityId).

This command uses the following AccessBeans:

See Also:
Serialized Form

Field Summary
protected  java.lang.Long approverId
          Approver id
protected  java.lang.Long businessEntityId
          Entity id
protected  java.lang.String businessFlowTypeIdentifier
          Flow type identifier
protected  boolean canApprove
          Whether or not the user can approve
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.approval.commands. ApprovalCheckApproverForEntityCmd
defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
ApprovalCheckApproverForEntityCmdImpl()
          Default constructor
 
Method Summary
 boolean isApprover()
          Returns whether or not the user is an approver for this submission.
 boolean isReadyToCallExecute()
          Check if the command is ready to be executed.
 void performExecute()
          The main logic.
 void setApproverId(java.lang.Long newApproverId)
          Sets the ID of a user to check to see if approver of entity.
 void setBusinessEntityId(java.lang.Long newBusinessEntityId)
          Sets the ID of the business entity object for which the approval is being requested.
 void setBusinessFlowTypeIdentifier(java.lang.String newBusinessFlowTypeIdentifier)
          Sets the identifier of the type of business flow for the approvable action.
 
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
IBM copyright notice field.
See Also:
Constant Field Values

canApprove

protected boolean canApprove
Whether or not the user can approve

approverId

protected java.lang.Long approverId
Approver id

businessFlowTypeIdentifier

protected java.lang.String businessFlowTypeIdentifier
Flow type identifier

businessEntityId

protected java.lang.Long businessEntityId
Entity id
Constructor Detail

ApprovalCheckApproverForEntityCmdImpl

public ApprovalCheckApproverForEntityCmdImpl()
Default constructor
Method Detail

isApprover

public boolean isApprover()
Returns whether or not the user is an approver for this submission.
Specified by:
isApprover in interface ApprovalCheckApproverForEntityCmd
Returns:
boolean Whether the user is an approver.

isReadyToCallExecute

public boolean isReadyToCallExecute()
Check if the command is ready to be executed.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
boolean

performExecute

public void performExecute()
                    throws ECException
The main logic. Checks to see if the specified user is an approver for a particular flow and business entity type.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException.
ECException

setApproverId

public void setApproverId(java.lang.Long newApproverId)
Sets the ID of a user to check to see if approver of entity.
Specified by:
setApproverId in interface ApprovalCheckApproverForEntityCmd
Parameters:
newApproverId - A user id

setBusinessEntityId

public void setBusinessEntityId(java.lang.Long newBusinessEntityId)
Sets the ID of the business entity object for which the approval is being requested.
Specified by:
setBusinessEntityId in interface ApprovalCheckApproverForEntityCmd
Parameters:
newBusinessEntityId - The entity on which the approval is being requested

setBusinessFlowTypeIdentifier

public void setBusinessFlowTypeIdentifier(java.lang.String newBusinessFlowTypeIdentifier)
Sets the identifier of the type of business flow for the approvable action.
Specified by:
setBusinessFlowTypeIdentifier in interface ApprovalCheckApproverForEntityCmd
Parameters:
newBusinessFlowTypeIdentifier - The type of flow for this approval