|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Selection
Interface representing Selection objects. Selections return a list of items or categories which can be used for viewing and editing items or to export a group of items or categories to a specific destination.
StaticSelection
,
DynamicSelection
Nested Class Summary | |
---|---|
static class |
Selection.Type
Enumeration listing types of Selections |
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
delete()
Deletes the selection |
AccessControlGroup |
getAccessControlGroup()
Fetches the access control group for the selection |
int |
getCount()
Returns the number of items/categories in a selection |
java.lang.String |
getName()
Fetches the name of the selection |
Selection.Type |
getType()
Fetches the type of this selection |
void |
save()
Persists the changes to the selection. |
void |
setAccessControlGroup(AccessControlGroup accessControlGroup)
Sets the AccessControlGroup for the selection |
void |
setName(java.lang.String name)
Sets the name for the Selection |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getName()
PIMInternalException
- If an internal error occursAccessControlGroup getAccessControlGroup()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.Selection.Type getType()
PIMInternalException
- If an internal error occursint getCount()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid setName(java.lang.String name)
name
- Name of the selection
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 the name is empty.void setAccessControlGroup(AccessControlGroup accessControlGroup)
accessControlGroup
- the AccessControlGroup to be set for the selection
PIMInternalException
- If an internal error occurs or if an AccessControlGroup
object without SELECTION_LIST permission is passed
Permission.SELECTION_LIST
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
java.lang.IllegalArgumentException
- If the accessControlGroup is null
java.lang.IllegalStateException
- If the API object passed in as parameter has not been saved.void save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_EDIT_RULE
void delete()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
Permission.SELECTION_DELETE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |