|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
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 |
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
CollaborationObject.Type getType()
PIMInternalException
- if an internal error occurs.Workflow getWorkflow()
PIMInternalException
- if an internal error occurs.java.util.Collection<Performer> getAdministrators()
PIMInternalException
- if an internal error occurs.void setAdministrators(java.util.Collection<Performer> performers)
performers
- a Collection of Users/Roles that will be the administrator(s)
for this collaboration area
PIMInternalException
- if an internal error occurs.ProcessingOptions getProcessingOptions()
PIMInternalException
- if an internal error occurs.Document getPostSaveScript()
PIMInternalException
- if an internal error occurs.Document getPostScript()
PIMInternalException
- if an internal error occurs.Document getPreScript()
PIMInternalException
- if an internal error occurs.AttributeCollection getUserDefinedAttributeCollection()
PIMInternalException
- if an internal error occurs.Document getBuildScript()
PIMInternalException
- if an internal error occurs.void setPostSaveScript(Document docStoreDoc)
docStoreDoc
- the post script document for this collaboration area
PIMInternalException
- if an internal error occurs.void setPostScript(Document docStoreDoc)
docStoreDoc
- the post script document for this collaboration area
PIMInternalException
- If an internal error occursvoid setPreScript(Document docStoreDoc)
docStoreDoc
- the post script document for this collaboration area
PIMInternalException
- if an internal error occurs.void setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
attributeCollection
- the attribute collection.
PIMInternalException
- if an internal error occurs.void setBuildScript(Document docStoreDoc)
docStoreDoc
- the post script document for this collaboration area
PIMInternalException
- if an internal error occurs.java.lang.String getName()
PIMInternalException
- if an internal error occurs.java.util.List<CollaborationStep> getSteps(Performer performer)
performer
- the user or role to return steps for
PIMInternalException
- if an internal error occurs.CollaborationStep
java.util.List<CollaborationStep> getNonEmptySteps()
PIMInternalException
- if an internal error occurs.java.util.List<CollaborationStep> getSteps()
PIMInternalException
- if an internal error occurs.java.util.List<CollaborationStep> getSteps(WorkflowStep.Type stepType)
stepType
- the type of step to retrieve
PIMInternalException
- if an internal error occurs.WorkflowStep
java.util.List<CollaborationStep> getAccessibleSteps(Performer performer)
performer
-
PIMInternalException
- if an internal error occurs.CollaborationStep getStep(java.lang.String stepName)
stepName
- the name of the step to retrieve (this could be obtained from
the WorkflowStep)
PIMInternalException
- if an internal error occurs.boolean isLocked()
PIMInternalException
- if an internal error occurs.void lock()
PIMInternalException
- if an internal error occurs.void unlock()
PIMInternalException
- if an internal error occurs.void save()
PIMInternalException
- if an internal error occurs.void delete()
PIMInternalException
- if an internal error occurs.void setAccessControlGroup(AccessControlGroup accessControlGroup)
accessControlGroup
- the access control group to set for this collaboration area
PIMInternalException
- if an internal error occurs.AccessControlGroup getAccessControlGroup()
PIMInternalException
- if an internal error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |