com.ibm.pim.collaboration
Interface CategoryCollaborationArea

All Superinterfaces:
CollaborationArea

public interface CategoryCollaborationArea
extends CollaborationArea

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.

See Also:
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, getName, getNonEmptySteps, getPostSaveScript, getPostScript, getPreScript, getProcessingOptions, getStep, getSteps, getSteps, getSteps, getType, getUserDefinedAttributeCollection, getWorkflow, isLocked, lock, save, setAccessControlGroup, setAdministrators, setBuildScript, setPostSaveScript, setPostScript, setPreScript, setUserDefinedAttributeCollection, unlock
 

Method Detail

getSourceHierarchy

Hierarchy getSourceHierarchy()
Gets the source hierarchy upon which this collaboration area is based

Returns:
the source hierarchy upon which this collaboration area is based
Throws:
PIMInternalException - if an internal error occurs

checkout

void checkout(java.util.Collection<Category> categories)
Checks out the specified categories to the collaboration area. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
categories - a Collection of categories to be checked out
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.

checkout

void checkout(java.util.Collection<Category> categories,
              java.lang.String commentString)
Checks out the specified categories to the collaboration area. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
categories - a Collection of categories to be checked out
commentString - a string comment describing the current action
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.

checkout

void checkout(java.util.Collection<Category> categories,
              CollaborationStep checkoutStep)
Checks out the specified categories to the collaboration area into the specified step. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
categories - a Collection of categories to be checked out
checkoutStep - the step to check out into. This step must have "Allow import into step" enabled
Throws:
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

checkout

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. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
categories - a Collection of categories to be checked out
checkoutStep - the step to check out into. This step must have "Allow import into step" enabled
commentString - a string comment describing the current action
Throws:
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

checkoutAndWaitForStatus

java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Category> categories)
Checks out the specified categories to the collaboration area. The categories will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
categories - a Collection of categories to be checked out
Returns:
a map of String primary key to CheckoutStatus
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.
See Also:
CheckoutStatus

checkoutAndWaitForStatus

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. The categories will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
categories - a Collection of categories to be checked out
commentString - a string comment describing the current action
Returns:
a map of String primary key to CheckoutStatus
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.
See Also:
CheckoutStatus

checkoutAndWaitForStatus

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. The categories will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
categories - a Collection of categories to be checked out
Returns:
a map of String primary key to CheckoutStatus
Throws:
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
See Also:
CheckoutStatus

checkoutAndWaitForStatus

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. The categories will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
categories - a Collection of categories to be checked out
commentString - a string comment describing the current action
Returns:
a map of String primary key to CheckoutStatus
Throws:
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
See Also:
CheckoutStatus

checkout

void checkout(Category category)
Checks out the specified category to the collaboration area. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
category - the category to be checked out
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.

checkout

void checkout(Category category,
              java.lang.String commentString)
Checks out the specified category to the collaboration area. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
category - the category to be checked out
commentString - a string comment describing the current action
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.

checkout

void checkout(Category category,
              CollaborationStep checkoutStep)
Checks out the specified category to the collaboration area into the specified step. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
category - the category to be checked out
checkoutStep - the step to check out into. This step must have "Allow import into step" enabled
Throws:
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.

checkout

void checkout(Category category,
              CollaborationStep checkoutStep,
              java.lang.String commentString)
Checks out the specified category to the collaboration area into the specified step. You cannot assume the checkout has completed or succeeded after calling this method.

Parameters:
category - the category to be checked out
checkoutStep - the step to check out into. This step must have "Allow import into step" enabled
commentString - a string comment describing the current action
Throws:
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.

checkoutAndWaitForStatus

CheckoutStatus checkoutAndWaitForStatus(Category category)
Checks out the specified category to the collaboration area. The category will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
category - the category to be checked out
Returns:
CheckoutStatus
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.
See Also:
CheckoutStatus

checkoutAndWaitForStatus

CheckoutStatus checkoutAndWaitForStatus(Category category,
                                        java.lang.String commentString)
Checks out the specified category to the collaboration area. The category will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
category - the category to be checked out
commentString - a string comment describing the current action
Returns:
CheckoutStatus
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES.
See Also:
CheckoutStatus

checkoutAndWaitForStatus

CheckoutStatus checkoutAndWaitForStatus(Category category,
                                        CollaborationStep checkoutStep)
Checks out the specified category to the collaboration area into the specified step. The category will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
category - the category to be checked out
Returns:
CheckoutStatus
Throws:
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 *
See Also:
CheckoutStatus

checkoutAndWaitForStatus

CheckoutStatus checkoutAndWaitForStatus(Category category,
                                        CollaborationStep checkoutStep,
                                        java.lang.String commentString)
Checks out the specified category to the collaboration area into the specified step. The category will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.

Parameters:
category - the category to be checked out
commentString - a string comment describing the current action
Returns:
CheckoutStatus
Throws:
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
See Also:
CheckoutStatus

drop

void drop(java.util.Collection<CollaborationCategory> categories)
Drops the specified categories from the collaboration area. You cannot assume the drop has completed or succeeded after calling this method.

Parameters:
categories - a Collection of categories to be dropped
Throws:
PIMInternalException - if an internal error occurs
java.lang.UnsupportedOperationException - if one or more of the collaboration categories do not belong to this collaboration area

drop

void drop(java.util.Collection<CollaborationCategory> categories,
          java.lang.String commentString)
Drops the specified categories from the collaboration area. You cannot assume the drop has completed or succeeded after calling this method.

Parameters:
categories - a Collection of categories to be dropped
commentString - a string comment describing the current action
Throws:
java.lang.UnsupportedOperationException - if one or more of the collaboration categories do not belong to this collaboration area
PIMInternalException - if an internal error occurs

drop

void drop(CollaborationCategory category)
Drops the specified categories from the collaboration area. You cannot assume the drop has completed or succeeded after calling this method.

Parameters:
category - the category to be dropped
Throws:
java.lang.UnsupportedOperationException - if the collaboration category does not belong to this collaboration area
PIMInternalException - if an internal error occurs

drop

void drop(CollaborationCategory category,
          java.lang.String commentString)
Drops the specified categories from the collaboration area. You cannot assume the drop has completed or succeeded after calling this method.

Parameters:
category - the category to be dropped
commentString - a string comment describing the current action
Throws:
java.lang.UnsupportedOperationException - if the collaboration category does not belong to this collaboration area
PIMInternalException - if an internal error occurs

createCollaborationCategory

CollaborationCategory createCollaborationCategory(java.lang.String parentCategoryPath,
                                                  java.lang.String delimiter,
                                                  java.lang.String pathValue)
Returns a new collaboration category object. The collaboration category object must be persisted by calling save() on the containing category collaboration area.

Parameters:
parentCategoryPath - The path of the parent collaboration category
delimiter - The delimiter used in the provided parent Path.
pathValue - The value for the path attribute of the collaboration category.
Returns:
CollaborationCategory object
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - if any of the parameters is null or empty

createCollaborationCategory

CollaborationCategory createCollaborationCategory(java.lang.String parentCategoryPath,
                                                  java.lang.String delimiter,
                                                  java.lang.String pathValue,
                                                  java.lang.String primaryKeyValue)
Returns a new collaboration category object. The collaboration category object must be persisted by calling save() on the containing category collaboration area.

Parameters:
parentCategoryPath - The path of the parent category
delimiter - 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
Returns:
CollaborationCategory object
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - if any of the parameters is null or empty

getRootCategory

CollaborationCategory getRootCategory()
Returns the root collaboration category for this Category Collaboration Area

Returns:
the root collaboration Category object for this Category Collaboration Area
Throws:
PIMInternalException - if an internal exception occurs

getCheckedOutCategory

CollaborationCategory getCheckedOutCategory(java.lang.String primaryKey)
Gets the checked out category with the specified primary key in the current category collaboration area. Returns null if no collaboration category exists with that primary key in this collaboration area.

Parameters:
primaryKey - the primary key to search on
Returns:
the category in this collaboration area with that primary key
Throws:
PIMInternalException - if an internal error occurs

getCheckedOutCategories

PIMCollection<CollaborationCategory> getCheckedOutCategories()
Gets the collection of all checked out categories in the current category collaboration area.

Returns:
a PIMCollection of all collaboration categories in this collaboration area If none are found, an empty collection will be returned Please note this is a lazily instantiated collection
Throws:
PIMInternalException - if an internal error occurs

getCheckedOutCategories

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. Returns null if no collaboration categories exist with any of the specified primary keys in this collaboration area.

Parameters:
primaryKeys - a collection of category primary keys to retrieve
Returns:
a Collection of categories in this collaboration area with those primary keys. If none are matched, an exception will be thrown. If only some are matched, a partial collection will be returned
Throws:
PIMInternalException - if an internal error occurs

getNumberOfCheckedOutCategories

int getNumberOfCheckedOutCategories()
Gets the number of checked out categories in the collaboration area.

Returns:
the number of unique collaboration categories in the collaboration area. Note that this is different from adding together the number of categories in each step, since categories can be in more than one step.
Throws:
PIMInternalException - if an internal error occurs

interimCheckin

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.

Parameters:
categories - the categories which should have their changed values copied back to the source catalog of this collaboration area
currentStep - the step from which the category should be published, must not be null.
Returns:
boolean
Throws:
PIMInternalException - if an internal error occurs

interimCheckin

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.

Parameters:
categories - the categories which should have their changed values copied back to the source catalog of this collaboration area
currentStep - the step from which the category should be published, must not be null.
commentString - a string comment describing the current action
Returns:
boolean
Throws:
PIMInternalException - if an internal error occurs

addIntoCollaborationArea

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. The Initial step must have "Allow import into step" set to true.

Parameters:
category - the unsaved category to be added directly to a collaboration area
Throws:
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.

addIntoCollaborationArea

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. The Initial step must have "Allow import into step" set to true.

Parameters:
category - the unsaved category to be added directly to a collaboration area
commentString - a string comment describing the current action
Throws:
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.

addIntoCollaborationArea

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. The specified step must have "Allow import into step" set to true.

Parameters:
category - the unsaved category to be added directly to a collaboration area
destinationStep - the step into which the category should be added
Throws:
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.

addIntoCollaborationArea

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. The specified step must have "Allow import into step" set to true.

Parameters:
category - the unsaved category to be added directly to a collaboration area
destinationStep - the step into which the category should be added
commentString - a string comment describing the current action
Throws:
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.

moveToNextStep

boolean moveToNextStep(java.util.Collection<CollaborationCategory> categories,
                       CollaborationStep currentStep,
                       java.lang.String exitValue)
Moves the specified categories to next step. You cannot assume the categories have been moved after this operation completes.

Parameters:
categories - A Collection of categories in this collaboration area that are to be moved
currentStep - the step from which the categories should be moved
exitValue - the exit value with which the categories should be moved out of the current step
Returns:
true if the categories have been successfully scheduled for move, false otherwise.
Throws:
java.lang.UnsupportedOperationException - if one or more categories do not belong to this collaboration area
PIMInternalException - if an internal error occurs

moveToNextStep

boolean moveToNextStep(java.util.Collection<CollaborationCategory> categories,
                       CollaborationStep currentStep,
                       java.lang.String exitValue,
                       java.lang.String commentString)
Moves the specified categories to next step. You cannot assume the categories have been moved after this operation completes.

Parameters:
categories - A Collection of categories in this collaboration area that are to be moved
currentStep - the step from which the categories should be moved
exitValue - the exit value with which the categories should be moved out of the current step
commentString - a string comment describing the current action
Returns:
true if the categories have been successfully scheduled for move, false otherwise.
Throws:
java.lang.UnsupportedOperationException - if one or more categories do not belong to this collaboration area
PIMInternalException - if an internal error occurs

moveToNextStep

boolean moveToNextStep(CollaborationCategory category,
                       CollaborationStep currentStep,
                       java.lang.String exitValue)
Moves the specified category to next step. You cannot assume the category has been moved after this operation completes.

Parameters:
category - An category in this collaboration area to be moved
currentStep - the step from which the category should be moved
exitValue - the exit value with which the category should be moved out of the current step
Returns:
true if the category has been successfully scheduled for move, false otherwise.
Throws:
java.lang.UnsupportedOperationException - if the category does not belong to this collaboration area
PIMInternalException - if an internal error occurs

moveToNextStep

boolean moveToNextStep(CollaborationCategory category,
                       CollaborationStep currentStep,
                       java.lang.String exitValue,
                       java.lang.String commentString)
Moves the specified category to next step. You cannot assume the category has been moved after this operation completes.

Parameters:
category - An category in this collaboration area to be moved
currentStep - the step from which the category should be moved
exitValue - the exit value with which the category should be moved out of the current step
commentString - a string comment describing the current action
Returns:
true if the category has been successfully scheduled for move, false otherwise.
Throws:
java.lang.UnsupportedOperationException - if the category does not belong to this collaboration area
PIMInternalException - if an internal error occurs