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

All Superinterfaces:
CSOAction

public interface RemoveFromListAction
extends CSOAction

The RemoveFromListAction interface provides the facility to remove one or more CSROs from the selected list(s). This interface contains various methods that facilitate to remove a CentraSite object from the existing list(s).


Method Summary
 java.util.Collection<CentraSiteObject> getApplicableLists()
          Returns the user-specific "lists" that contain at least one selected CentraSite object.
 void setRemoveLists(java.util.Collection<CentraSiteObject> list)
          Sets the "lists" from which the object(s) should be removed.
 
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

getApplicableLists

java.util.Collection<CentraSiteObject> getApplicableLists()
                                                          throws CLLException
Returns the user-specific "lists" that contain at least one selected CentraSite object.

Returns:
collection of lists that are owned by the logged in user and contain at least one selected CentraSite object
Throws:
CLLException - if CLL fails to return the existing lists

setRemoveLists

void setRemoveLists(java.util.Collection<CentraSiteObject> list)
                    throws CLLException
Sets the "lists" from which the object(s) should be removed.

Parameters:
list - CentraSiteObject representing a given existing list
Throws:
CLLException - if CLL fails to set the given existing list