|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SelectionManager
Manager for Selection objects
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
DynamicCollaborationItemSelection |
createDynamicCollaborationItemSelection(java.lang.String selectionName,
java.lang.String query)
Creates a DynamicCollaborationItemSelection. |
DynamicItemSelection |
createDynamicItemSelection(java.lang.String selectionName,
java.lang.String query)
Creates a DynamicItemSelection. |
StaticItemSelection |
createStaticItemSelection(Catalog catalog,
Hierarchy hierarchy,
java.lang.String selectionName)
Creates a StaticItemSelection. |
Selection |
getSelection(java.lang.String selectionName)
Fetches the selection with the given selectionName |
java.util.Collection<Selection> |
getSelections()
Fetches all Selection objects in this company, for which the user has the permission Permission.SELECTION_LIST . |
java.util.Collection<Selection> |
getSelections(Catalog catalog)
Fetches all Selection objects defined for this catalog, for which the user has the permission Permission.SELECTION_LIST . |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
StaticItemSelection createStaticItemSelection(Catalog catalog, Hierarchy hierarchy, java.lang.String selectionName)
Selection.save()
is invoked on it.
catalog
- The catalog object whose items the selection will containhierarchy
- The hierarchy object to be used with this selection.
Categories from this hierarchy can be addedselectionName
- The name of the selection
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
java.lang.IllegalArgumentException
- If catalog is null or hierarchy is null or selectionName is
empty.
java.lang.IllegalStateException
- If the catalog has not been persisted or the hierarchy has
not been persisted.DynamicItemSelection createDynamicItemSelection(java.lang.String selectionName, java.lang.String query)
Selection.save()
is invoked on it.
selectionName
- The name of the selectionquery
- The query that will be executed to fetch items in this
selection.
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
java.lang.IllegalArgumentException
- If the selectionName is empty or query is emptyDynamicCollaborationItemSelection createDynamicCollaborationItemSelection(java.lang.String selectionName, java.lang.String query)
Selection.save()
is invoked on it.
selectionName
- The name of the selectionquery
- The query that will be executed to fetch items in this
selection.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the selectionName is empty or query is emptyjava.util.Collection<Selection> getSelections(Catalog catalog)
Permission.SELECTION_LIST
. Both static
and dynamic selections are returned.
catalog
- The catalog object for which the associated selections has to
be fetched.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the catalog is null.
java.lang.IllegalStateException
- If the catalog has not been persisted.java.util.Collection<Selection> getSelections()
Permission.SELECTION_LIST
.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.Selection getSelection(java.lang.String selectionName)
selectionName
- The name of the selection
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_LIST
java.lang.IllegalArgumentException
- If selectionName is empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |