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


public interface CSOActionManager

The CSOActionManager interface manages all actions that are defined
for CentraSiteObject(s).

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

Sample code to instantiate CSOActionManager:
  CentraSiteServiceFactory csServiceFactory = CentraSiteServiceFactory.getInstance();
        CentraSiteService centraSiteService = csServiceFactory.createService();
        CentraSiteSession session = centraSiteService.createSession();
        CSOActionManager actionManager = session.getActionManager();


Method Summary
 CSOAction getAction(java.lang.String actionId)
          Returns the CSOAction for the specified action Id.
 java.util.List<CSOAction> getBulkActions()
          Returns the list of CSOAction(s) that can be executed on a collection of CentraSiteObject(s).
 java.util.List<CSOAction> getInboxActions()
          Returns a list of "Inbox" specific actions.
 java.util.List<CSOAction> getSingleObjectActions()
          Returns the list of CSOAction(s) that can only be executed on a single CentraSiteObject(s).
 java.util.List<CSOAction> getSingleObjectActions(CentraSiteObject cso)
          Returns the list of CSOAction(s) that are allowed for the given object.
 

Method Detail

getBulkActions

java.util.List<CSOAction> getBulkActions()
                                         throws CLLException
Returns the list of CSOAction(s) that can be executed on a collection of CentraSiteObject(s).

i.e., the actions that have a value as 'true' for the attribute bulk.

Returns:
list of CSOAction(s).
Throws:
CLLException - if CLL fails to get the actions that can be performed on a given collection of CentraSite objects.

getSingleObjectActions

java.util.List<CSOAction> getSingleObjectActions()
                                                 throws CLLException
Returns the list of CSOAction(s) that can only be executed on a single CentraSiteObject(s).

ie. the actions that have a value as 'false' for the attribute bulk.

Returns:
list of CSOAction(s).
Throws:
CLLException - if CLL fails to get the actions that can be performed on a given CentraSite object.

getSingleObjectActions

java.util.List<CSOAction> getSingleObjectActions(CentraSiteObject cso)
                                                 throws CLLException
Returns the list of CSOAction(s) that are allowed for the given object. This will implicitly perform CSOAction.isAllowed()

Parameters:
cso - CentraSiteObject
Returns:
list of CSOAction(s)that are allowed for the given object.
Throws:
CLLException - if CLL fails to return the list of CSOAction(s) that are allowed for the given object.

getAction

CSOAction getAction(java.lang.String actionId)
                    throws CLLException
Returns the CSOAction for the specified action Id.

Parameters:
actionId - unique identifier of the action.
Returns:
CSOAction
Throws:
CLLException - if CLL fails to return the action.

getInboxActions

java.util.List<CSOAction> getInboxActions()
                                          throws CLLException
Returns a list of "Inbox" specific actions.

Returns:
list of "Inbox" specific actions.
Throws:
CLLException - if CLL fails to return the list of "Inbox" specific actions.