|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StaticItemSelection
Interface representing a static item selection.
Static Item Selection represents a list of items. The list is created by the
user, by adding items using addItem(Item)
or adding all items in a category using addCategory(Category)
.
StaticSelection
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 | |
---|---|
void |
addCategory(Category category)
Adds a category to the selection. |
void |
addItem(Item item)
Adds an item to the selection. |
Catalog |
getCatalog()
Fetches the catalog with which this selection is associated |
PIMCollection<Category> |
getCategories()
Fetches the categories present in the selection |
int |
getCategoryCount()
Fetches the count of categories present in the selection |
Hierarchy |
getHierarchy()
Fetches the hierarchy used with the selection |
PIMCollection<Item> |
getItems()
Fetches the items in the selection |
void |
removeCategory(Category category)
Removes the category from the selection if it is present in the selection. |
void |
removeItem(Item item)
Removes the item from the selection if it is present in the selection. |
Methods inherited from interface com.ibm.pim.selection.Selection |
---|
delete, getAccessControlGroup, getCount, getName, getType, save, setAccessControlGroup, setName |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void addItem(Item item)
item
- The Item object to be added to the selection. The item has to
belong to the catalog for which the selection was created,
otherwise PIMInternalException will be thrown.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
java.lang.IllegalArgumentException
- If item is null
java.lang.IllegalStateException
- If item has not been persisted.void removeItem(Item item)
item
- The item to be removed from the selection
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
java.lang.IllegalArgumentException
- If item is null
java.lang.IllegalStateException
- If item has not been persisted.void addCategory(Category category)
category
- The category to be added to the selection
PIMInternalException
- If an internal error occurs or when the category does not
belong to the hierarchy associated with this selection.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
java.lang.IllegalArgumentException
- If category is null
java.lang.IllegalStateException
- If category has not been persisted.void removeCategory(Category category)
category
- The category to be removed from the selection
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
java.lang.IllegalArgumentException
- If category is null
java.lang.IllegalStateException
- If category has not been persisted.Hierarchy getHierarchy()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_LIST
PIMCollection<Category> getCategories()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
AND (Permission.HIERARCHY_VIEW_HIERARCHY_NODES
OR
Permission.SELECTION_MEMBERS_VIEW_HIERARCHY_NODES
)int getCategoryCount()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
AND (Permission.HIERARCHY_VIEW_HIERARCHY_NODES
OR
Permission.SELECTION_MEMBERS_VIEW_HIERARCHY_NODES
)PIMCollection<Item> getItems()
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
Catalog getCatalog()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_LIST
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |