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

All Known Subinterfaces:
Activity, AddToListAction, ApproveAction, AttachDocumentAction, ConsumeAction, CreateAssetActivity, DeleteAction, DeleteNotificationAction, DownloadDocumentAction, EditAction, ExportAction, NewVersionAction, RejectAction, RemoveFromListAction, RevertAction, SaveAction, UnwatchAction, ViewReportAction, WatchAction

public interface CSOAction

The CSOAction interface represents any action that can be performed on a CentraSiteObject.

This section lists the predefined actions that are supported by CentraSite and configured in the system level:


Method Summary
 java.lang.String cancel()
          Cancels the execution of remaining steps and moves the state to 'complete' for this action.
 java.lang.String executeNextStep()
          Executes the next step of this action.
 java.lang.String executePreviousStep()
          Executes the previous step of this action(roll back from current state).
 java.lang.String finishAllSteps()
          Executes the remaining steps of this action.
 java.lang.String getCurrentState()
          Gets the current state of this action.
 java.lang.String getGroup()
          Gets the group Id to which this action belongs.
 java.lang.String getIconURL()
          Gets the URL of the icon defined for this action.
 java.lang.String getId()
          Gets the Id of this action.
 java.lang.String getName()
          Gets the name of this action.
 java.util.Map<CentraSiteObject,java.lang.String> getSkippedObjectsWithReason()
          Gets the skipped objects with the reason to be skipped.
 boolean isAllowed()
          Verifies if the logged in user can execute this action on a collection of CentraSiteObject(s).
 boolean isApplicable()
          Verifies if the action can be applied on the specified collection of CentraSiteObject(s).
 void setObjects(java.util.Collection<CentraSiteObject> centraSiteObjects)
          Sets the collection of CentraSiteObject(s) on which this
action can be executed.
 

Method Detail

getId

java.lang.String getId()
Gets the Id of this action.

Returns:
the unique identifier of the action.
Throws:
CLLException - in case of a failure to get the action Id.

getName

java.lang.String getName()
                         throws CLLException
Gets the name of this action.

Returns:
the name of the action.
Throws:
CLLException - in case of a failure to get the action name.

getIconURL

java.lang.String getIconURL()
Gets the URL of the icon defined for this action.

Returns:
icon URL as String.
Throws:
CLLException - in case of a failure to get the icon URL.

getGroup

java.lang.String getGroup()
Gets the group Id to which this action belongs.

Returns:
the group Id.
Throws:
CLLException - in case of a failure to get the group Id to which this action belongs.

isAllowed

boolean isAllowed()
                  throws CLLException
Verifies if the logged in user can execute this action on a collection of CentraSiteObject(s).

Returns:
'true' if this action is allowed for execution on all the given CentraSiteObject(s), else 'false'.
Throws:
CLLException - in case of a failure to verify if the logged in user can execute this action on the given CentraSte Object(s).

setObjects

void setObjects(java.util.Collection<CentraSiteObject> centraSiteObjects)
                throws CLLException
Sets the collection of CentraSiteObject(s) on which this
action can be executed.

Parameters:
centraSiteObjects - the collection of CentraSiteObject(s).
Throws:
CLLException - in case of a failure to set the collection of CentraSiteObject(s).

executeNextStep

java.lang.String executeNextStep()
                                 throws CLLException
Executes the next step of this action.

Returns:
string indicating the current state of the action post execution.
Throws:
CLLException - in case of a failure to execute the next step of the action.

executePreviousStep

java.lang.String executePreviousStep()
                                     throws CLLException
Executes the previous step of this action(roll back from current state).

Returns:
string indicating the current state of the action post execution.
Throws:
CLLException - in case of a failure to execute the next step of the action.

finishAllSteps

java.lang.String finishAllSteps()
                                throws CLLException
Executes the remaining steps of this action.
In case of a successful execution, this returns a string indicating the state 'complete'.

Returns:
string indicating the current state of the action post execution.
Throws:
CLLException - in case of a failure to execute any of the remaining steps of the action.

getCurrentState

java.lang.String getCurrentState()
                                 throws CLLException
Gets the current state of this action.

Returns:
string indicating the current state of the action.
Throws:
CLLException - in case of a failure to get the current state of the action.

cancel

java.lang.String cancel()
                        throws CLLException
Cancels the execution of remaining steps and moves the state to 'complete' for this action.

Returns:
string indicating the state 'complete' of the action.
Throws:
CLLException - in case of a failure to cancel the execution of remaining steps of the action.

isApplicable

boolean isApplicable()
                     throws CLLException
Verifies if the action can be applied on the specified collection of CentraSiteObject(s).

Returns:
'true' if this action is applicable for execution on all the given CentraSiteObject(s), else 'false'.
Throws:
CLLException - in case of a failure to verify if this action is applicable for execution on all the given CentraSite Object(s).

getSkippedObjectsWithReason

java.util.Map<CentraSiteObject,java.lang.String> getSkippedObjectsWithReason()
                                                                             throws CLLException
Gets the skipped objects with the reason to be skipped.

Returns:
a map with skipped objects and the reasons.
Throws:
CLLException - in case of failure to get the skipped objects.