com.ibm.pim.collaboration
Interface CollaborationArea

All Known Subinterfaces:
CategoryCollaborationArea, ItemCollaborationArea

public interface CollaborationArea

The JAVA API interface CollaborationArea lets you access a Collaboration Area in MDMPIM, as seen by the user. A Collaboration Area represents an actual instance of a particular workflow design through which items or categories can be moved and modified. All methods that are not specific to the type of the collaboration object (ie item or category) are included here. Item or category-specific methods are included in ItemCollaborationArea and CategoryCollaborationArea respectively.

A new collaboration area is created based on an existing container (like Catalog, or Hierarchy), and an existing workflow of the same container type. Just a reminder that, a Catalog container lets you to store and manipulate items, whereas a Hierarchy container lets you to store and manipulate categories.

When a collaboration area (based on a Catalog or Hierarchy container) is created an empty container with the same name as the collaboration area is also created. The original container is called the Source Container (can be a Catalog or a Hierarchy) and the container within the collaboration area is called the collaboration container.

When you need to modify either source container objects (items or categories) with in the collaboration area, you would need to move (or checkout) the source container objects (items or categories) first into the collaboration area, which would result in these source container objects (items or categories) being copied into the collaboration container.

See Also:
Catalog, Hierarchy, Item, Category, ItemCollaborationArea, CategoryCollaborationArea

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void delete()
          Deletes the current collaboration area.
 AccessControlGroup getAccessControlGroup()
          Gets the access control group on the current collaboration area.
 java.util.List<CollaborationStep> getAccessibleSteps(Performer performer)
          Get the steps accessible by the given performer.
 java.util.Collection<Performer> getAdministrators()
          Gets the collection of Administrators for the current collaboration area.
 Document getBuildScript()
          Retrieves the script document associated with an invocation point defined by the collaboration area
 java.lang.String getDescription()
          Gets the description for the current collaboration area.
 java.lang.String getName()
          Gets the name for the current collaboration area.
 java.util.List<CollaborationStep> getNonEmptySteps()
          Gets the list of all non-empty steps in the current collaboration area.
 Document getPostSaveScript()
          Retrieves the script document associated with an invocation point defined by the Collaboration area.
 Document getPostScript()
          Retrieves the script document associated with an invocation point defined by the collaboration area.
 Document getPreScript()
          Retrieves the script document associated with an invocation point defined by the collaboration area
 ProcessingOptions getProcessingOptions()
          Provide temporary ways to change the default behavior for performance reasons.
 CollaborationStep getStep(java.lang.String stepName)
          Gets the step with a specified step name on the current collaboration area.
 java.util.List<CollaborationStep> getSteps()
          Gets the list of all steps in the current collaboration area.
 java.util.List<CollaborationStep> getSteps(Performer performer)
          Returns the list of steps upon which the specified performer is a member of the performers list
 java.util.List<CollaborationStep> getSteps(WorkflowStep.Type stepType)
          Gets the list of steps of a given step type on the current collaboration area.
 CollaborationObject.Type getType()
          Gets the object type of the current collaboration area.
 AttributeCollection getUserDefinedAttributeCollection()
          Retrieves the User Defined Core Attribute Collection for this collaboration area
 Workflow getWorkflow()
          Gets the workflow associated with the current collaboration area.
 boolean isLocked()
          Checks of the current collaboration area is locked.
 void lock()
          Locks the collaboration area.
 void save()
          Saves changes to collaboration area such as description, administrators, timeout.
 void setAccessControlGroup(AccessControlGroup accessControlGroup)
          Sets the specified access control group on the current collaboration area.
 void setAdministrators(java.util.Collection<Performer> performers)
          Override/set the administrators for the collaboration area.
 void setBuildScript(Document docStoreDoc)
          Describes the location of a script with an invocation point defined by the Catalog
 void setDescription(java.lang.String description)
          Sets the specified description for the current collaboration area.
 void setPostSaveScript(Document docStoreDoc)
          Describes the location of a script with an invocation point defined by the collaboration area.
 void setPostScript(Document docStoreDoc)
          Describes the location of a script with an invocation point defined by the collaboration area.
 void setPreScript(Document docStoreDoc)
          Describes the location of a script with an invocation point defined by the collaboration area
 void setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
          Specifies the User Defined Core Attribute Collection for this Catalog
 void unlock()
          Unlocks the collaboration area.
 

Field Detail

copyright

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

getType

CollaborationObject.Type getType()
Gets the object type of the current collaboration area.

Returns:
the type of object that this collaboration area allows collaboration on
Throws:
PIMInternalException - if an internal error occurs.

getWorkflow

Workflow getWorkflow()
Gets the workflow associated with the current collaboration area.

Returns:
the workflow associated with this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getAdministrators

java.util.Collection<Performer> getAdministrators()
Gets the collection of Administrators for the current collaboration area.

Returns:
a Collection of Performers that are the administrators for this collaboration area.
Throws:
PIMInternalException - if an internal error occurs.

setAdministrators

void setAdministrators(java.util.Collection<Performer> performers)
Override/set the administrators for the collaboration area.

Parameters:
performers - a Collection of Users/Roles that will be the administrator(s) for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getProcessingOptions

ProcessingOptions getProcessingOptions()
Provide temporary ways to change the default behavior for performance reasons.

Returns:
processingOptions specific for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getPostSaveScript

Document getPostSaveScript()
Retrieves the script document associated with an invocation point defined by the Collaboration area.

Returns:
the post script Document object for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getPostScript

Document getPostScript()
Retrieves the script document associated with an invocation point defined by the collaboration area.

Returns:
the post script Document object for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getPreScript

Document getPreScript()
Retrieves the script document associated with an invocation point defined by the collaboration area

Returns:
the post script Document object for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getUserDefinedAttributeCollection

AttributeCollection getUserDefinedAttributeCollection()
Retrieves the User Defined Core Attribute Collection for this collaboration area

Returns:
the attribute collection object for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getBuildScript

Document getBuildScript()
Retrieves the script document associated with an invocation point defined by the collaboration area

Returns:
the post script Document object for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

setPostSaveScript

void setPostSaveScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the collaboration area.

Parameters:
docStoreDoc - the post script document for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

setPostScript

void setPostScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the collaboration area.

Parameters:
docStoreDoc - the post script document for this collaboration area
Throws:
PIMInternalException - If an internal error occurs

setPreScript

void setPreScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the collaboration area

Parameters:
docStoreDoc - the post script document for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

setUserDefinedAttributeCollection

void setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
Specifies the User Defined Core Attribute Collection for this Catalog

Parameters:
attributeCollection - the attribute collection.
Throws:
PIMInternalException - if an internal error occurs.

setBuildScript

void setBuildScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Catalog

Parameters:
docStoreDoc - the post script document for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getName

java.lang.String getName()
Gets the name for the current collaboration area.

Returns:
the name of the collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getDescription

java.lang.String getDescription()
Gets the description for the current collaboration area.

Returns:
the description of the collaboration area
Throws:
PIMInternalException - if an internal error occurs.

setDescription

void setDescription(java.lang.String description)
Sets the specified description for the current collaboration area.

Parameters:
description - the description to set for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getSteps

java.util.List<CollaborationStep> getSteps(Performer performer)
Returns the list of steps upon which the specified performer is a member of the performers list

Parameters:
performer - the user or role to return steps for
Returns:
a List of CollaborationSteps for which the specified user/role is a performer
Throws:
PIMInternalException - if an internal error occurs.
See Also:
CollaborationStep

getNonEmptySteps

java.util.List<CollaborationStep> getNonEmptySteps()
Gets the list of all non-empty steps in the current collaboration area. A collaboration area is no-empty if it has atleast one entry with in it.

Returns:
a List of all CollaborationSteps in this collaboration area which are not empty
Throws:
PIMInternalException - if an internal error occurs.

getSteps

java.util.List<CollaborationStep> getSteps()
Gets the list of all steps in the current collaboration area.

Returns:
a List of all CollaborationSteps in this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getSteps

java.util.List<CollaborationStep> getSteps(WorkflowStep.Type stepType)
Gets the list of steps of a given step type on the current collaboration area.

Parameters:
stepType - the type of step to retrieve
Returns:
a List of all CollaborationSteps in this collaboration area with the specified type. If there are no matches, an empty List will be returned
Throws:
PIMInternalException - if an internal error occurs.
See Also:
WorkflowStep

getAccessibleSteps

java.util.List<CollaborationStep> getAccessibleSteps(Performer performer)
Get the steps accessible by the given performer. A step is accessible if the performer is authorized to perform the step and the step is not automatic.

Parameters:
performer -
Returns:
a List of steps accessible by the given performer
Throws:
PIMInternalException - if an internal error occurs.

getStep

CollaborationStep getStep(java.lang.String stepName)
Gets the step with a specified step name on the current collaboration area.

Parameters:
stepName - the name of the step to retrieve (this could be obtained from the WorkflowStep)
Returns:
the CollaborationStep with that name. Returns null if no step exists with that name.
Throws:
PIMInternalException - if an internal error occurs.

isLocked

boolean isLocked()
Checks of the current collaboration area is locked.

Returns:
true if the collaboration area is locked, false otherwise
Throws:
PIMInternalException - if an internal error occurs.

lock

void lock()
Locks the collaboration area. Has no effect if collaboration area is already locked.

Throws:
PIMInternalException - if an internal error occurs.

unlock

void unlock()
Unlocks the collaboration area. Has no effect if collaboration area is already locked.

Throws:
PIMInternalException - if an internal error occurs.

save

void save()
Saves changes to collaboration area such as description, administrators, timeout.

Throws:
PIMInternalException - if an internal error occurs.

delete

void delete()
Deletes the current collaboration area.

Throws:
PIMInternalException - if an internal error occurs.

setAccessControlGroup

void setAccessControlGroup(AccessControlGroup accessControlGroup)
Sets the specified access control group on the current collaboration area.

Parameters:
accessControlGroup - the access control group to set for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.

getAccessControlGroup

AccessControlGroup getAccessControlGroup()
Gets the access control group on the current collaboration area.

Returns:
the AccessControlGroup for this collaboration area
Throws:
PIMInternalException - if an internal error occurs.