|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CollaborationAreaManager
Read-write interface for the manager of Collaboration Area objects.
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> |
getNonEmptyCollaborationAreas()
Retrieve all collaboration areas that are not empty and are available in the current context, or an empty collection if there are none. |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Method Detail |
---|
ItemCollaborationArea createItemCollaborationArea(java.lang.String collaborationAreaName, Workflow workflow, Catalog catalog)
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.
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 persistedWorkflow
,
Item
,
Catalog
,
CollaborationArea
CategoryCollaborationArea createCategoryCollaborationArea(java.lang.String collaborationAreaName, Workflow workflow, Hierarchy hierarchy)
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.
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 persistedWorkflow
,
Category
,
Hierarchy
,
CollaborationArea
java.util.Collection<CollaborationArea> getCollaborationAreas()
Permission.COLLABORATION_AREA_LIST
.
PIMInternalException
- if an internal error occurs.java.util.Collection<CollaborationArea> getNonEmptyCollaborationAreas()
Permission.COLLABORATION_AREA_LIST
.
PIMInternalException
- if an internal error occurs.java.util.Collection<CollaborationArea> getCollaborationAreas(Performer performer)
Permission.COLLABORATION_AREA_LIST
.
performer
- the performer (role or user), must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalArgumentException
- if the argument is null.CollaborationArea getCollaborationArea(java.lang.String collaborationAreaName)
collaborationAreaName
- the name of the collaboration area to be retrieved, must not
be null or empty.
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |