|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 thisaction can be executed. |
Method Detail |
---|
java.lang.String getId()
CLLException
- in case of a failure to get the action Id.java.lang.String getName() throws CLLException
CLLException
- in case of a failure to get the action name.java.lang.String getIconURL()
String
.
CLLException
- in case of a failure to get the icon URL.java.lang.String getGroup()
CLLException
- in case of a failure to get the group Id to which this action belongs.boolean isAllowed() throws CLLException
CentraSiteObject
(s).
CentraSiteObject
(s), else 'false'.
CLLException
- in case of a failure to verify if the logged in user can execute this action on the given CentraSte Object(s).void setObjects(java.util.Collection<CentraSiteObject> centraSiteObjects) throws CLLException
CentraSiteObject
(s) on which this
centraSiteObjects
- the collection of CentraSiteObject
(s).
CLLException
- in case of a failure to set the collection of CentraSiteObject
(s).java.lang.String executeNextStep() throws CLLException
CLLException
- in case of a failure to execute the next step of the action.java.lang.String executePreviousStep() throws CLLException
CLLException
- in case of a failure to execute the next step of the action.java.lang.String finishAllSteps() throws CLLException
CLLException
- in case of a failure to execute any of the remaining steps of the action.java.lang.String getCurrentState() throws CLLException
CLLException
- in case of a failure to get the current state of the action.java.lang.String cancel() throws CLLException
CLLException
- in case of a failure to cancel the execution of remaining steps of the action.boolean isApplicable() throws CLLException
CentraSiteObject
(s).
CentraSiteObject
(s), else 'false'.
CLLException
- in case of a failure to verify if this action is applicable for execution on all the given CentraSite Object(s).java.util.Map<CentraSiteObject,java.lang.String> getSkippedObjectsWithReason() throws CLLException
CLLException
- in case of failure to get the skipped objects.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |