com.ibm.pim.collaboration
Interface CollaborationAreaManager

All Superinterfaces:
Manager

public interface CollaborationAreaManager
extends Manager

Read-write interface for the manager of Collaboration Area objects.

Since:
6.0.0

Field Summary
 
Fields inherited from interface com.ibm.pim.common.Manager
copyright
 
Method Summary
 CategoryCollaborationArea createCategoryCollaborationArea(java.lang.String collaborationAreaName, Workflow workflow, Hierarchy hierarchy)
          Create a collaboration area from a category workflow for the specified hierarchy.
 ItemCollaborationArea createItemCollaborationArea(java.lang.String collaborationAreaName, Workflow workflow, Catalog catalog)
          Create a collaboration area from an item workflow for the specified catalog.
 CollaborationArea getCollaborationArea(java.lang.String collaborationAreaName)
          Retrieve a collaboration area by name.
 java.util.Collection<CollaborationArea> getCollaborationAreas()
          Retrieve all collaboration areas available in the current context, or an empty collection if there are none.
 java.util.Collection<CollaborationArea> getCollaborationAreas(Performer performer)
          Retrieve all collaboration areas applicable to a particular role/user, or an empty collection if there are none.
 java.util.Collection<CollaborationArea> getCollaborationAreasWithNoACGFilter()
          Retrieve all collaboration areas available in the current context, or an empty collection if there are none.
 java.util.Collection<CollaborationArea> getNonEmptyCollaborationAreas()
           
 
Methods inherited from interface com.ibm.pim.common.Manager
getManagerName
 

Method Detail

createItemCollaborationArea

ItemCollaborationArea createItemCollaborationArea(java.lang.String collaborationAreaName,
                                                  Workflow workflow,
                                                  Catalog catalog)
Create a collaboration area from an item workflow for the specified catalog.

Parameters:
collaborationAreaName - the name for the new collaboration area, must not be null or empty.
workflow - the item workflow to be used, must not be null.
catalog - the catalog to which items are checked in or from which they are checked out, must not be null.
Returns:
the new collaboration area.
Throws:
PIMInternalException - if an internal error occurs.
java.lang.IllegalArgumentException - if any argument is null, or if the first is empty.
java.lang.IllegalStateException - If the Workflow or Catalog have not yet been persisted
See Also:
Workflow, Item, Catalog, CollaborationArea

createCategoryCollaborationArea

CategoryCollaborationArea createCategoryCollaborationArea(java.lang.String collaborationAreaName,
                                                          Workflow workflow,
                                                          Hierarchy hierarchy)
Create a collaboration area from a category workflow for the specified hierarchy.

Parameters:
collaborationAreaName - the name for the new collaboration area, must not be null or empty.
workflow - the category workflow to be used, must not be null.
hierarchy - the hierarchy to which categories are checked in or from which they are checked out, must not be null.
Returns:
the new collaboration area.
Throws:
PIMInternalException - if an internal error occurs.
java.lang.IllegalArgumentException - if any argument is null, or if the first is empty.
java.lang.IllegalStateException - If the Workflow or Hierarchy have not yet been persisted
See Also:
Workflow, Category, Hierarchy, CollaborationArea

getCollaborationAreas

java.util.Collection<CollaborationArea> getCollaborationAreas()
Retrieve all collaboration areas available in the current context, or an empty collection if there are none. The list of collaboration areas is filtered by the access control group privilege: Permission.COLLABORATION_AREA_LIST.

Returns:
A Collection of CollaborationAreas.
Throws:
PIMInternalException - if an internal error occurs.

getCollaborationAreasWithNoACGFilter

java.util.Collection<CollaborationArea> getCollaborationAreasWithNoACGFilter()
Retrieve all collaboration areas available in the current context, or an empty collection if there are none. The list of collaboration areas is filtered by the access control group privilege: Permission.COLLABORATION_AREA_LIST.

Returns:
A Collection of CollaborationAreas.
Throws:
PIMInternalException - if an internal error occurs.

getNonEmptyCollaborationAreas

java.util.Collection<CollaborationArea> getNonEmptyCollaborationAreas()

getCollaborationAreas

java.util.Collection<CollaborationArea> getCollaborationAreas(Performer performer)
Retrieve all collaboration areas applicable to a particular role/user, or an empty collection if there are none. The list of collaboration areas is filtered by the access control group privilege: Permission.COLLABORATION_AREA_LIST.

Parameters:
performer - the performer (role or user), must not be null.
Returns:
A Collection of CollaborationAreas.
Throws:
PIMInternalException - if an internal error occurs.
java.lang.IllegalArgumentException - if the argument is null.

getCollaborationArea

CollaborationArea getCollaborationArea(java.lang.String collaborationAreaName)
Retrieve a collaboration area by name. Returns null if no collaboration area exists with the given name.

Parameters:
collaborationAreaName - the name of the collaboration area to be retrieved, must not be null or empty.
Returns:
the collaboration area with the specified name.
Throws:
PIMInternalException - if an internal error occurs.
PIMAuthorizationException - If the user does not have the equivalent of Permission.COLLABORATION_AREA_LIST.
java.lang.IllegalArgumentException - if the argument is null or empty.