com.ibm.pim.selection
Interface Selection

All Known Subinterfaces:
DynamicCollaborationItemSelection, DynamicItemSelection, DynamicSelection, StaticItemSelection, StaticSelection

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.

Since:
6.0.0
See Also:
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

copyright

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

getName

java.lang.String getName()
Fetches the name of the selection

Returns:
The selection name
Throws:
PIMInternalException - If an internal error occurs

getAccessControlGroup

AccessControlGroup getAccessControlGroup()
Fetches the access control group for the selection

Returns:
The access control group for the selection
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getType

Selection.Type getType()
Fetches the type of this selection

Returns:
A SelectionType value
Throws:
PIMInternalException - If an internal error occurs

getCount

int getCount()
Returns the number of items/categories in a selection

Returns:
an int value giving the count of items/categories
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

setName

void setName(java.lang.String name)
Sets the name for the Selection

Parameters:
name - Name of the selection
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 the name is empty.

setAccessControlGroup

void setAccessControlGroup(AccessControlGroup accessControlGroup)
Sets the AccessControlGroup for the selection

Parameters:
accessControlGroup - the AccessControlGroup to be set for the selection
Throws:
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.

save

void save()
Persists the changes to the selection.

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of Permission.SELECTION_EDIT_RULE

delete

void delete()
Deletes the selection

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of Permission.SELECTION_DELETE