com.softwareag.centrasite.api.csom.action
Interface ApproveAction

All Superinterfaces:
CSOAction

public interface ApproveAction
extends CSOAction

The ApproveAction interface contains various methods that enable defining and retrieving comments for approving a request.


Method Summary
 java.lang.String getApprovalRequestReason()
          Get the reason for approval request if action is triggered for pending approval.
 java.lang.String getApprovalWorkflowName()
          Get the approval workflow name if action is triggered for pending approval.
 java.lang.String getApproveComments()
          Get the comments for approving a request.
 User getConsumerRegistrationRequestor()
          Get the user who requested a consumer registration if action is triggered.
 boolean isPendingApproval()
          Check if action is triggered for pending approval.
 boolean isPendingConsumerRegistration()
          Check if action is triggered for pending consumer registration.
 void setApproveComments(java.lang.String comments)
          Set the comments for approving a request.
 
Methods inherited from interface com.softwareag.centrasite.api.csom.action.CSOAction
cancel, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
 

Method Detail

setApproveComments

void setApproveComments(java.lang.String comments)
Set the comments for approving a request.

Parameters:
comments - Comment from the approver for approving a request.

getApproveComments

java.lang.String getApproveComments()
Get the comments for approving a request.

Returns:
Comment from the approver for approving a request.

isPendingApproval

boolean isPendingApproval()
                          throws CLLException
Check if action is triggered for pending approval.

Returns:
true if action was triggered for a pending approval; else false.
Throws:
CLLException - if CLL fails to check the action status

isPendingConsumerRegistration

boolean isPendingConsumerRegistration()
                                      throws CLLException
Check if action is triggered for pending consumer registration.

Returns:
true if action was triggered for a pending consumer registration; else false.
Throws:
CLLException - if CLL fails to check the action status

getApprovalWorkflowName

java.lang.String getApprovalWorkflowName()
                                         throws CLLException
Get the approval workflow name if action is triggered for pending approval.

Returns:
Name of the approval workflow
Throws:
CLLException - if CLL fails to return the approval workflow name

getApprovalRequestReason

java.lang.String getApprovalRequestReason()
                                          throws CLLException
Get the reason for approval request if action is triggered for pending approval.

Returns:
Reason for the approval request
Throws:
CLLException - if CLL fails the return the reason for approval request

getConsumerRegistrationRequestor

User getConsumerRegistrationRequestor()
                                      throws CLLException
Get the user who requested a consumer registration if action is triggered.

Returns:
User who requested the consumer registration
Throws:
CLLException - if CLL fails to return the user who requested for consumer registration