com.ibm.pim.selection
Interface DynamicItemSelection

All Superinterfaces:
DynamicSelection, Selection

public interface DynamicItemSelection
extends DynamicSelection

Interface representing DynamicSelection for items.
DynamicItemSelection represents a list of items based on a query.

Since:
6.0.0
See Also:
DynamicSelection

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.pim.selection.Selection
Selection.Type
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 Catalog getCatalog()
          Fetches the catalog with which this selection is associated
 PIMCollection<Item> getItems()
          Fetches the items in the selection
 void setQuery(java.lang.String query)
          Sets the query for the dynamic selection.
 
Methods inherited from interface com.ibm.pim.selection.DynamicSelection
getQuery
 
Methods inherited from interface com.ibm.pim.selection.Selection
delete, getAccessControlGroup, getCount, getName, getType, save, setAccessControlGroup, setName
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getItems

PIMCollection<Item> getItems()
Fetches the items in the selection

Returns:
A PIMCollection of items. The collection is empty if the query returns zero items.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of Permission.CATALOG_VIEW_ITEMS or Permission.SELECTION_MEMBERS_VIEW_ITEMS

getCatalog

Catalog getCatalog()
Fetches the catalog with which this selection is associated

Returns:
A Catalog object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of Permission.CATALOG_LIST

setQuery

void setQuery(java.lang.String query)
Sets the query for the dynamic selection.

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