com.ibm.pim.selection
Interface DynamicCollaborationItemSelection
- All Superinterfaces:
- DynamicSelection, Selection
public interface DynamicCollaborationItemSelection
- extends DynamicSelection
Interface representing DynamicSelection on collaboration items in a
CollaborationArea.
DynamicCollaborationItemSelection represents a collection of collaboration
items in a collaboration area as a result of a search specified by the
given query.
- Since:
- 6.0.0.FP001
- See Also:
DynamicSelection
Field Summary |
static java.lang.String |
copyright
|
copyright
static final java.lang.String copyright
- See Also:
- Constant Field Values
getCollaborationArea
ItemCollaborationArea getCollaborationArea()
- Fetches the CollaborationArea on which this selection is based
- Returns:
- A CollaborationArea object
- Throws:
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
setQuery
void setQuery(java.lang.String query)
- Sets the query for the dynamic selection on CollaborationObject.
- Parameters:
query
- Query for dynamic selection. This query must select items from
a catalog.
- Throws:
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
java.lang.IllegalArgumentException
- If query is null or empty
getCollaborationItems
PIMCollection<CollaborationItem> getCollaborationItems()
- Fetches a collection of
CollaborationItem
objects in the selection
As prescribed via
Permission.SELECTION_MEMBERS_VIEW_ITEMS
- Returns:
- A PIMCollection of CollaborationItem. The collection is empty if the query
returns zero CollaborationObject.
- Throws:
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.