|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CategoryCollaborationArea
The JAVA API interface CategoryCollaborationArea
lets you
access a category Collaboration Area.
A Category Collaboration Area represents an actual instance of a particular workflow design through which categories can be moved and modified.
A new category collaboration area is created based on an existing Hierarchy and an existing hierarchy workflow. Just a reminder that, a hierarchy lets you to store and manipulate categories.
When an category collaboration area (based on a Hierarchy container) is created, an empty Hierarchy with the same name as the collaboration area is also created. The original Hierarchy is called the Source Hierarchy and the hierarchy within the collaboration area is called the collaboration Hierarchy. Thus, the root category for a category collaboration has the same name as the collaboration area.
When you need to modify source hierarchy categories with in the collaboration area, you would need to move (or checkout) the source hierarchy categories first into the collaboration area, which would result in these source hierarchy categories being copied into the collaboration hierarchy.
Hierarchy
,
Category
,
CollaborationArea
Field Summary |
---|
Fields inherited from interface com.ibm.pim.collaboration.CollaborationArea |
---|
copyright |
Method Summary | |
---|---|
boolean |
addIntoCollaborationArea(CollaborationCategory category)
Allows a newly created category to be saved directly into a collaboration area, into the Initial step, instead of saving to a source hierarchy, for example during an import. |
boolean |
addIntoCollaborationArea(CollaborationCategory category,
CollaborationStep destinationStep)
Allows a newly created category to be saved directly into a collaboration area, into a particular step, instead of saving to a source hierarchy, for example during an import. |
boolean |
addIntoCollaborationArea(CollaborationCategory category,
CollaborationStep destinationStep,
java.lang.String commentString)
Allows a newly created category to be saved directly into a collaboration area, into a particular step, instead of saving to a source hierarchy, for example during an import. |
boolean |
addIntoCollaborationArea(CollaborationCategory category,
java.lang.String commentString)
Allows a newly created category to be saved directly into a collaboration area, into the Initial step, instead of saving to a source hierarchy, for example during an import. |
void |
checkout(Category category)
Checks out the specified category to the collaboration area. |
void |
checkout(Category category,
CollaborationStep checkoutStep)
Checks out the specified category to the collaboration area into the specified step. |
void |
checkout(Category category,
CollaborationStep checkoutStep,
java.lang.String commentString)
Checks out the specified category to the collaboration area into the specified step. |
void |
checkout(Category category,
java.lang.String commentString)
Checks out the specified category to the collaboration area. |
void |
checkout(java.util.Collection<Category> categories)
Checks out the specified categories to the collaboration area. |
void |
checkout(java.util.Collection<Category> categories,
CollaborationStep checkoutStep)
Checks out the specified categories to the collaboration area into the specified step. |
void |
checkout(java.util.Collection<Category> categories,
CollaborationStep checkoutStep,
java.lang.String commentString)
Checks out the specified categories to the collaboration area into the specified step. |
void |
checkout(java.util.Collection<Category> categories,
java.lang.String commentString)
Checks out the specified categories to the collaboration area. |
CheckoutStatus |
checkoutAndWaitForStatus(Category category)
Checks out the specified category to the collaboration area. |
CheckoutStatus |
checkoutAndWaitForStatus(Category category,
CollaborationStep checkoutStep)
Checks out the specified category to the collaboration area into the specified step. |
CheckoutStatus |
checkoutAndWaitForStatus(Category category,
CollaborationStep checkoutStep,
java.lang.String commentString)
Checks out the specified category to the collaboration area into the specified step. |
CheckoutStatus |
checkoutAndWaitForStatus(Category category,
java.lang.String commentString)
Checks out the specified category to the collaboration area. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Category> categories)
Checks out the specified categories to the collaboration area. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Category> categories,
CollaborationStep checkoutStep)
Checks out the specified categories to the collaboration area into the specified step. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Category> categories,
CollaborationStep checkoutStep,
java.lang.String commentString)
Checks out the specified categories to the collaboration area into the specified step. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Category> categories,
java.lang.String commentString)
Checks out the specified categories to the collaboration area. |
CollaborationCategory |
createCollaborationCategory(java.lang.String parentCategoryPath,
java.lang.String delimiter,
java.lang.String pathValue)
Returns a new collaboration category object. |
CollaborationCategory |
createCollaborationCategory(java.lang.String parentCategoryPath,
java.lang.String delimiter,
java.lang.String pathValue,
java.lang.String primaryKeyValue)
Returns a new collaboration category object. |
void |
drop(CollaborationCategory category)
Drops the specified categories from the collaboration area. |
void |
drop(CollaborationCategory category,
java.lang.String commentString)
Drops the specified categories from the collaboration area. |
void |
drop(java.util.Collection<CollaborationCategory> categories)
Drops the specified categories from the collaboration area. |
void |
drop(java.util.Collection<CollaborationCategory> categories,
java.lang.String commentString)
Drops the specified categories from the collaboration area. |
PIMCollection<CollaborationCategory> |
getCheckedOutCategories()
Gets the collection of all checked out categories in the current category collaboration area. |
java.util.Collection<CollaborationCategory> |
getCheckedOutCategories(java.util.List<java.lang.String> primaryKeys)
Gets the collection of checked out categories with the specified primary keys in the current category collaboration area. |
CollaborationCategory |
getCheckedOutCategory(java.lang.String primaryKey)
Gets the checked out category with the specified primary key in the current category collaboration area. |
int |
getNumberOfCheckedOutCategories()
Gets the number of checked out categories in the collaboration area. |
CollaborationCategory |
getRootCategory()
Returns the root collaboration category for this Category Collaboration Area |
Hierarchy |
getSourceHierarchy()
Gets the source hierarchy upon which this collaboration area is based |
boolean |
interimCheckin(java.util.Collection<CollaborationCategory> categories,
CollaborationStep currentStep)
Temporarily publishes the current attribute values for each category in the collection of categories in the collaboration area back to the source category tree. |
boolean |
interimCheckin(java.util.Collection<CollaborationCategory> categories,
CollaborationStep currentStep,
java.lang.String commentString)
Temporarily publishes the current attribute values for each category in the collection of categories in the collaboration area back to the source category tree. |
boolean |
moveToNextStep(CollaborationCategory category,
CollaborationStep currentStep,
java.lang.String exitValue)
Moves the specified category to next step. |
boolean |
moveToNextStep(CollaborationCategory category,
CollaborationStep currentStep,
java.lang.String exitValue,
java.lang.String commentString)
Moves the specified category to next step. |
boolean |
moveToNextStep(java.util.Collection<CollaborationCategory> categories,
CollaborationStep currentStep,
java.lang.String exitValue)
Moves the specified categories to next step. |
boolean |
moveToNextStep(java.util.Collection<CollaborationCategory> categories,
CollaborationStep currentStep,
java.lang.String exitValue,
java.lang.String commentString)
Moves the specified categories to next step. |
Methods inherited from interface com.ibm.pim.collaboration.CollaborationArea |
---|
delete, getAccessControlGroup, getAccessibleSteps, getAdministrators, getBuildScript, getDescription, getName, getNonEmptySteps, getPostSaveScript, getPostScript, getPreScript, getProcessingOptions, getStep, getSteps, getSteps, getSteps, getType, getUserDefinedAttributeCollection, getWorkflow, isLocked, lock, save, setAccessControlGroup, setAdministrators, setBuildScript, setDescription, setPostSaveScript, setPostScript, setPreScript, setUserDefinedAttributeCollection, unlock |
Method Detail |
---|
Hierarchy getSourceHierarchy()
PIMInternalException
- if an internal error occursvoid checkout(java.util.Collection<Category> categories)
categories
- a Collection of categories to be checked out
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.void checkout(java.util.Collection<Category> categories, java.lang.String commentString)
categories
- a Collection of categories to be checked outcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.void checkout(java.util.Collection<Category> categories, CollaborationStep checkoutStep)
categories
- a Collection of categories to be checked outcheckoutStep
- the step to check out into. This step must have "Allow import
into step" enabled
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkoutvoid checkout(java.util.Collection<Category> categories, CollaborationStep checkoutStep, java.lang.String commentString)
categories
- a Collection of categories to be checked outcheckoutStep
- the step to check out into. This step must have "Allow import
into step" enabledcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkoutjava.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Category> categories)
categories
- a Collection of categories to be checked out
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.CheckoutStatus
java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Category> categories, java.lang.String commentString)
categories
- a Collection of categories to be checked outcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.CheckoutStatus
java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Category> categories, CollaborationStep checkoutStep)
categories
- a Collection of categories to be checked out
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkoutCheckoutStatus
java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Category> categories, CollaborationStep checkoutStep, java.lang.String commentString)
categories
- a Collection of categories to be checked outcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkoutCheckoutStatus
void checkout(Category category)
category
- the category to be checked out
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.void checkout(Category category, java.lang.String commentString)
category
- the category to be checked outcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.void checkout(Category category, CollaborationStep checkoutStep)
category
- the category to be checked outcheckoutStep
- the step to check out into. This step must have "Allow import
into step" enabled
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkout
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.void checkout(Category category, CollaborationStep checkoutStep, java.lang.String commentString)
category
- the category to be checked outcheckoutStep
- the step to check out into. This step must have "Allow import
into step" enabledcommentString
- a string comment describing the current action
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkout
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.CheckoutStatus checkoutAndWaitForStatus(Category category)
category
- the category to be checked out
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.CheckoutStatus
CheckoutStatus checkoutAndWaitForStatus(Category category, java.lang.String commentString)
category
- the category to be checked outcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.CheckoutStatus
CheckoutStatus checkoutAndWaitForStatus(Category category, CollaborationStep checkoutStep)
category
- the category to be checked out
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkout *CheckoutStatus
CheckoutStatus checkoutAndWaitForStatus(Category category, CollaborationStep checkoutStep, java.lang.String commentString)
category
- the category to be checked outcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.UnsupportedOperationException
- if the step does not have "Allow import into step" enabled or
is not valid for checkoutCheckoutStatus
void drop(java.util.Collection<CollaborationCategory> categories)
categories
- a Collection of categories to be dropped
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if one or more of the collaboration categories do not belong
to this collaboration areavoid drop(java.util.Collection<CollaborationCategory> categories, java.lang.String commentString)
categories
- a Collection of categories to be droppedcommentString
- a string comment describing the current action
java.lang.UnsupportedOperationException
- if one or more of the collaboration categories do not belong
to this collaboration area
PIMInternalException
- if an internal error occursvoid drop(CollaborationCategory category)
category
- the category to be dropped
java.lang.UnsupportedOperationException
- if the collaboration category does not belong to this
collaboration area
PIMInternalException
- if an internal error occursvoid drop(CollaborationCategory category, java.lang.String commentString)
category
- the category to be droppedcommentString
- a string comment describing the current action
java.lang.UnsupportedOperationException
- if the collaboration category does not belong to this
collaboration area
PIMInternalException
- if an internal error occursCollaborationCategory createCollaborationCategory(java.lang.String parentCategoryPath, java.lang.String delimiter, java.lang.String pathValue)
parentCategoryPath
- The path of the parent collaboration categorydelimiter
- The delimiter used in the provided parent Path.pathValue
- The value for the path attribute of the collaboration
category.
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- if any of the parameters is null or emptyCollaborationCategory createCollaborationCategory(java.lang.String parentCategoryPath, java.lang.String delimiter, java.lang.String pathValue, java.lang.String primaryKeyValue)
parentCategoryPath
- The path of the parent categorydelimiter
- The delimiter used in the provided parent Path.pathValue
- The value for the path attribute of the collaboration
category.primaryKeyValue
- Primary key value for the collaboration category
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- if any of the parameters is null or emptyCollaborationCategory getRootCategory()
PIMInternalException
- if an internal exception occursCollaborationCategory getCheckedOutCategory(java.lang.String primaryKey)
primaryKey
- the primary key to search on
PIMInternalException
- if an internal error occursPIMCollection<CollaborationCategory> getCheckedOutCategories()
PIMInternalException
- if an internal error occursjava.util.Collection<CollaborationCategory> getCheckedOutCategories(java.util.List<java.lang.String> primaryKeys)
primaryKeys
- a collection of category primary keys to retrieve
PIMInternalException
- if an internal error occursint getNumberOfCheckedOutCategories()
PIMInternalException
- if an internal error occursboolean interimCheckin(java.util.Collection<CollaborationCategory> categories, CollaborationStep currentStep)
categories
- the categories which should have their changed values copied
back to the source catalog of this collaboration areacurrentStep
- the step from which the category should be published, must not
be null.
PIMInternalException
- if an internal error occursboolean interimCheckin(java.util.Collection<CollaborationCategory> categories, CollaborationStep currentStep, java.lang.String commentString)
categories
- the categories which should have their changed values copied
back to the source catalog of this collaboration areacurrentStep
- the step from which the category should be published, must not
be null.commentString
- a string comment describing the current action
PIMInternalException
- if an internal error occursboolean addIntoCollaborationArea(CollaborationCategory category)
category
- the unsaved category to be added directly to a collaboration
area
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if the category is already saved to the source hierarchy, or
if the category is already checked out to this collaboration
area, or if the Initial step does not have "Allow import into
step" set, or if the category does not belong to this
collaboration area.boolean addIntoCollaborationArea(CollaborationCategory category, java.lang.String commentString)
category
- the unsaved category to be added directly to a collaboration
areacommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if the category is already saved to the source hierarchy, or
if the category is already checked out to this collaboration
area, or if the Initial step does not have "Allow import into
step" set, or if the category does not belong to this
collaboration area.boolean addIntoCollaborationArea(CollaborationCategory category, CollaborationStep destinationStep)
category
- the unsaved category to be added directly to a collaboration
areadestinationStep
- the step into which the category should be added
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if the category is already saved to the source hierarchy, or
if the category is already checked out to this collaboration
area, or if the destination step does not have "Allow import
into step" set, or if the category does not belong to this
collaboration area.boolean addIntoCollaborationArea(CollaborationCategory category, CollaborationStep destinationStep, java.lang.String commentString)
category
- the unsaved category to be added directly to a collaboration
areadestinationStep
- the step into which the category should be addedcommentString
- a string comment describing the current action
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if the category is already saved to the source hierarchy, or
if the category is already checked out to this collaboration
area, or if the destination step does not have "Allow import
into step" set, or if the category does not belong to this
collaboration area.boolean moveToNextStep(java.util.Collection<CollaborationCategory> categories, CollaborationStep currentStep, java.lang.String exitValue)
categories
- A Collection of categories in this collaboration area that are
to be movedcurrentStep
- the step from which the categories should be movedexitValue
- the exit value with which the categories should be moved out
of the current step
java.lang.UnsupportedOperationException
- if one or more categories do not belong to this collaboration
area
PIMInternalException
- if an internal error occursboolean moveToNextStep(java.util.Collection<CollaborationCategory> categories, CollaborationStep currentStep, java.lang.String exitValue, java.lang.String commentString)
categories
- A Collection of categories in this collaboration area that are
to be movedcurrentStep
- the step from which the categories should be movedexitValue
- the exit value with which the categories should be moved out
of the current stepcommentString
- a string comment describing the current action
java.lang.UnsupportedOperationException
- if one or more categories do not belong to this collaboration
area
PIMInternalException
- if an internal error occursboolean moveToNextStep(CollaborationCategory category, CollaborationStep currentStep, java.lang.String exitValue)
category
- An category in this collaboration area to be movedcurrentStep
- the step from which the category should be movedexitValue
- the exit value with which the category should be moved out of
the current step
java.lang.UnsupportedOperationException
- if the category does not belong to this collaboration area
PIMInternalException
- if an internal error occursboolean moveToNextStep(CollaborationCategory category, CollaborationStep currentStep, java.lang.String exitValue, java.lang.String commentString)
category
- An category in this collaboration area to be movedcurrentStep
- the step from which the category should be movedexitValue
- the exit value with which the category should be moved out of
the current stepcommentString
- a string comment describing the current action
java.lang.UnsupportedOperationException
- if the category does not belong to this collaboration area
PIMInternalException
- if an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |