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

All Superinterfaces:
CSOAction

public interface AddToListAction
extends CSOAction

The AddToListAction interface allows build a collection of objects that can display as a group. The interface contains various methods that facilitate to add a CentraSite object to an existing list or a newly added list.


Method Summary
 java.util.Collection<CentraSiteObject> getExistingLists()
           
 void setExistingList(CentraSiteObject list)
          Sets the objects to a given existing list.
 void setNewListName(java.lang.String listName)
          Sets the objects to a given new list.
 
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

getExistingLists

java.util.Collection<CentraSiteObject> getExistingLists()
                                                        throws CLLException
Returns:
the collection of lists owned by the logged in user.
Throws:
CLLException - if failed to retrieve an existing list.

setExistingList

void setExistingList(CentraSiteObject list)
                     throws CLLException
Sets the objects to a given existing list.

Parameters:
list - CentraSiteObject that represents the given existing list.
Throws:
CLLException - if failed to set the objects in the given existing list.

setNewListName

void setNewListName(java.lang.String listName)
Sets the objects to a given new list.

Parameters:
listName - Name of the list to be created.