|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ItemCollaborationArea
The Java API interface ItemCollaborationArea lets you access an item collaboration area.
An Item Collaboration Area represents an actual instance of a particular workflow design through which items can be moved and modified.
A new item collaboration area is created based on an existing Catalog and an existing Catalog workflow. Just a reminder that, a Catalog container lets you to store and manipulate items.
When an item collaboration area (based on a Catalog container) is created, an empty Catalog with the same name as the collaboration area is also created. The original Catalog is called the Source Catalog and the catalog within the collaboration area is called the collaboration Catalog.
When you need to modify source catalog items with in the collaboration area, you would need to move (or checkout) the source catalog items first into the collaboration area, which would result in these source catalog items being copied into the collaboration catalog.
Catalog
,
Item
,
CollaborationArea
Field Summary |
---|
Fields inherited from interface com.ibm.pim.collaboration.CollaborationArea |
---|
copyright |
Method Summary | |
---|---|
boolean |
addIntoCollaborationArea(CollaborationItem item)
Allow a newly created item to be saved directly into a collaboration area, into the Initial step, instead of saving to a source catalog, for example during an import. |
boolean |
addIntoCollaborationArea(CollaborationItem item,
CollaborationStep destinationStep)
Allow a newly created item to be saved directly into a collaboration area, into a particular step, instead of saving to a source catalog, for example during an import. |
boolean |
addIntoCollaborationArea(CollaborationItem item,
CollaborationStep destinationStep,
java.lang.String comment)
Allow a newly created item to be saved directly into a collaboration area, into a particular step, instead of saving to a source catalog, for example during an import, with a comment. |
boolean |
addIntoCollaborationArea(CollaborationItem item,
java.lang.String comment)
Allow a newly created item to be saved directly into a collaboration area, into the Initial step, instead of saving to a source catalog, for example during an import, with a comment. |
void |
checkout(java.util.Collection<Item> items)
Checks out the specified items to the collaboration area. |
void |
checkout(java.util.Collection<Item> items,
CollaborationStep checkoutStep)
Checks out the specified items to the collaboration area into the specified step. |
void |
checkout(java.util.Collection<Item> items,
CollaborationStep checkoutStep,
java.lang.String comment)
Checks out the specified items to the collaboration area into a specified step. |
void |
checkout(java.util.Collection<Item> items,
java.lang.String comment)
Checks out the specified items to the collaboration area, with a comment. |
void |
checkout(Item item)
Checks out the specified item to the collaboration area. |
void |
checkout(Item item,
CollaborationStep checkoutStep)
Checks out the specified item to the collaboration area into a specified step. |
void |
checkout(Item item,
CollaborationStep checkoutStep,
java.lang.String comment)
Checks out the specified item to the collaboration area into a specified step, with a comment. |
void |
checkout(Item item,
java.lang.String comment)
Checks out the specified item to the collaboration area, with a comment. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Item> items)
Schedule the concurrent checkout of the specified items to the collaboration area. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Item> items,
CollaborationStep checkoutStep)
Schedule the concurrent checkout of the specified items to the collaboration area into a specified step. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Item> items,
CollaborationStep checkoutStep,
java.lang.String comment)
Schedule the concurrent checkout of the specified items to a collaboration area into a specified step, with a comment. |
java.util.Map<java.lang.String,CheckoutStatus> |
checkoutAndWaitForStatus(java.util.Collection<Item> items,
java.lang.String comment)
Schedule the concurrent checkout of the specified items to the collaboration area, with a comment. |
CheckoutStatus |
checkoutAndWaitForStatus(Item item)
Schedule the concurrent checkout of the specified items to a collaboration area. |
CheckoutStatus |
checkoutAndWaitForStatus(Item item,
CollaborationStep checkoutStep)
Schedule the concurrent checkout of the specified item to a collaboration area into a specified step. |
CheckoutStatus |
checkoutAndWaitForStatus(Item item,
CollaborationStep checkoutStep,
java.lang.String comment)
Schedule the concurrent checkout of the specified items to a collaboration area into a specified step, with a comment. |
CheckoutStatus |
checkoutAndWaitForStatus(Item item,
java.lang.String comment)
Schedule the concurrent checkout of the specified items to a collaboration area, with a comment. |
CollaborationItem |
createCollaborationItem(java.lang.String primaryKey)
Create a collaboration item in the current item collaboration area. |
void |
drop(CollaborationItem item)
Drops the specified item from the collaboration area. |
void |
drop(CollaborationItem item,
java.lang.String comment)
Drops the specified item from the collaboration area, with a comment. |
void |
drop(java.util.Collection<CollaborationItem> items)
Drops the specified items from the collaboration area. |
void |
drop(java.util.Collection<CollaborationItem> items,
java.lang.String comment)
Drops the specified items from the collaboration area, with a comment. |
CollaborationItem |
getCheckedOutItem(java.lang.String primaryKey)
Get the checked out item with the specified primary key in the current item collaboration area. |
PIMCollection<CollaborationItem> |
getCheckedOutItems()
Get a collection of all checked out items in the current item collaboration area. |
java.util.Collection<CollaborationItem> |
getCheckedOutItems(java.util.List<java.lang.String> primaryKeys)
Get the collection of checked out items with the specified primary keys in the current item collaboration area. |
int |
getNumberOfCheckedOutItems()
Get the number of checked out items in the collaboration area. |
Catalog |
getSourceCatalog()
Get the source catalog upon which this collaboration area is based. |
java.lang.String |
getWorkflowStepsXMLByAttributeValue(AttributeDefinition attrPath,
java.lang.Object attrValue)
Returns xml representation of workflow steps accessible by the user. |
java.lang.String |
getWorkflowStepsXMLByAttributeValue(AttributeDefinition attrPath,
java.lang.Object attrValue,
Role role)
Returns xml representation of workflow steps accessible by the given role. |
boolean |
interimCheckin(java.util.Collection<CollaborationItem> items,
CollaborationStep currentStep)
Temporarily publish the current attribute values for each item in the collection of items in the collaboration area back to the source catalog. |
boolean |
interimCheckin(java.util.Collection<CollaborationItem> items,
CollaborationStep currentStep,
java.lang.String comment)
Temporarily publish the current attribute values for each item in the collection of items in the collaboration area back to the source catalog, with a comment. |
boolean |
moveItemsToOtherCollaborationArea(java.util.Collection<CollaborationItem> items,
CollaborationArea destinationCollaborationArea)
Move the specified items to another collaboration area. |
boolean |
moveItemsToOtherCollaborationArea(java.util.Collection<CollaborationItem> items,
CollaborationArea destinationCollaborationArea,
java.lang.String comment)
Move the specified items to another collaboration area. |
boolean |
moveItemToOtherCollaborationArea(CollaborationItem item,
CollaborationArea destinationCollaborationArea)
Move the specified item to another collaboration area. |
boolean |
moveItemToOtherCollaborationArea(CollaborationItem item,
CollaborationArea destinationCollaborationArea,
java.lang.String comment)
Move the specified item to another collaboration area, with a comment. |
boolean |
moveToNextStep(CollaborationItem item,
CollaborationStep currentStep,
java.lang.String exitValue)
Move the specified item to next step. |
boolean |
moveToNextStep(CollaborationItem item,
CollaborationStep currentStep,
java.lang.String exitValue,
java.lang.String comment)
Move the specified item to next step. |
boolean |
moveToNextStep(java.util.Collection<CollaborationItem> items,
CollaborationStep currentStep,
java.lang.String exitValue)
Move the specified items to next step. |
boolean |
moveToNextStep(java.util.Collection<CollaborationItem> items,
CollaborationStep currentStep,
java.lang.String exitValue,
java.lang.String comment)
Move the specified items to next step, with a comment. |
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 |
---|
boolean addIntoCollaborationArea(CollaborationItem item)
The Initial step must have "Allow import into step" set to true.
item
- the unsaved item to be added directly to a collaboration area,
must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if the item is already saved to the source catalog, or if the
item is already checked out to this collaboration area, or if
the Initial step does not have "Allow import into step" set,
or if the item do not belong to this collaboration area.boolean addIntoCollaborationArea(CollaborationItem item, java.lang.String comment)
The Initial step must have "Allow import into step" set to true.
item
- the unsaved item to be added directly to a collaboration area,
must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if the item is already saved to the source catalog, or if the
item is already checked out to this collaboration area, or if
the Initial step does not have "Allow import into step" set,
or if the item do not belong to this collaboration area.
java.lang.IllegalArgumentException
- of the comment argument is null.boolean addIntoCollaborationArea(CollaborationItem item, CollaborationStep destinationStep)
The specified step must have "Allow import into step" set to true.
item
- the unsaved item to be added directly to a collaboration area,
must not be null.destinationStep
- the step into which the item should be added, must not be
null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if the item is already saved to the source catalog, or if the
item is already checked out to this collaboration area, or if
the destination step does not have "Allow import into step"
set, or if the item do not belong to this collaboration area.
java.lang.IllegalArgumentException
- if either argument is null.boolean addIntoCollaborationArea(CollaborationItem item, CollaborationStep destinationStep, java.lang.String comment)
The specified step must have "Allow import into step" set to true.
item
- the unsaved item to be added directly to a collaboration area,
must not be null.destinationStep
- the step into which the item should be added, must not be
null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if the item is already saved to the source catalog, or if the
item is already checked out to this collaboration area, or if
the destination step does not have "Allow import into step"
set, or if the item do not belong to this collaboration area.
java.lang.IllegalArgumentException
- if any argument is null.boolean moveItemsToOtherCollaborationArea(java.util.Collection<CollaborationItem> items, CollaborationArea destinationCollaborationArea)
Not recommended for general use. You cannot assume the items have been moved after this operation completes.
items
- A Collection of items in this collaboration area that are to
be moved, must not be null.destinationCollaborationArea
- the destination collaboration area to move the items to, must
not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if one or more items do not belong to this collaboration
area.
java.lang.IllegalArgumentException
- if either argument is null.boolean moveItemsToOtherCollaborationArea(java.util.Collection<CollaborationItem> items, CollaborationArea destinationCollaborationArea, java.lang.String comment)
Not recommended for general use. You cannot assume the items have been moved after this operation completes.
items
- A Collection of items in this collaboration area that are to
be moved, must not be null.destinationCollaborationArea
- the destination collaboration area to move the items to, must
not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if one or more items do not belong to this collaboration
area.
java.lang.IllegalArgumentException
- if any argument is null.boolean moveItemToOtherCollaborationArea(CollaborationItem item, CollaborationArea destinationCollaborationArea)
Not recommended for general use.
You cannot assume the item has been moved after this operation completes.
item
- an item in this collaboration area to be moved, must not be
null.destinationCollaborationArea
- the destination collaboration area to move the item to, must
not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if the items does not belong to this collaboration area.
java.lang.IllegalArgumentException
- if any argument is null.boolean moveItemToOtherCollaborationArea(CollaborationItem item, CollaborationArea destinationCollaborationArea, java.lang.String comment)
Not recommended for general use.
You cannot assume the item has been moved after this operation completes.
item
- an item in this collaboration area to be moved, must not be
null.destinationCollaborationArea
- the destination collaboration area to move the item to, must
not be null.comment
- a comment describing the current action.
PIMInternalException
- if an internal error occurs
java.lang.UnsupportedOperationException
- if the items does not belong to this collaboration area.
java.lang.IllegalArgumentException
- if any argument is null.Catalog getSourceCatalog()
PIMInternalException
- if an internal error occurs.void checkout(java.util.Collection<Item> items)
You cannot assume the checkout has completed or succeeded after calling this method.
items
- a Collection of items to be checked out, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if the argument is null.void checkout(java.util.Collection<Item> items, java.lang.String comment)
You cannot assume the checkout has completed or succeeded after calling this method.
items
- a collection of items to be checked out, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if either argument is null.void checkout(java.util.Collection<Item> items, CollaborationStep checkoutStep)
You cannot assume the checkout has completed or succeeded after calling this method.
items
- a collection of items to be checked out, must not be null.checkoutStep
- the step to check out into, must not be null. 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 checkout.
java.lang.IllegalArgumentException
- if either argument is null.void checkout(java.util.Collection<Item> items, CollaborationStep checkoutStep, java.lang.String comment)
You cannot assume the checkout has completed or succeeded after calling this method.
items
- a collection of items to be checked out, must not be null.checkoutStep
- the step to check out into, must not be null. This step must
have "Allow import into step" enabled, must not be null.comment
- a comment describing the current action, must not be null.
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.
java.lang.IllegalArgumentException
- if any argument is null.java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Item> items)
The items will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
items
- a collection of items to be checked out, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if the argument is null.CheckoutStatus
java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Item> items, java.lang.String comment)
The items will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
items
- a collection of items to be checked out, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if either argument is null.CheckoutStatus
java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Item> items, CollaborationStep checkoutStep)
The items will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
items
- a collection of items to be checked out, must not be null.checkoutStep
- the step to check out into, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if either argument is null.CheckoutStatus
java.util.Map<java.lang.String,CheckoutStatus> checkoutAndWaitForStatus(java.util.Collection<Item> items, CollaborationStep checkoutStep, java.lang.String comment)
The items will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
items
- a collection of items to be checked out, must not be null.checkoutStep
- the step to check out into, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if any argument is null.CheckoutStatus
void checkout(Item item)
You cannot assume the checkout has completed or succeeded after calling this method.
item
- the item to be checked out, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if the argument is null.void checkout(Item item, java.lang.String comment)
You cannot assume the checkout has completed or succeeded after calling this method.
item
- the item to be checked out, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if either argument is null.void checkout(Item item, CollaborationStep checkoutStep)
You cannot assume the checkout has completed or succeeded after calling this method.
item
- the item to be checked out, must not be null.checkoutStep
- the step to check out into. This step must have "Allow import
into step" enabled and must not be null.
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.
java.lang.IllegalArgumentException
- if either argument is null.void checkout(Item item, CollaborationStep checkoutStep, java.lang.String comment)
You cannot assume the checkout has completed or succeeded after calling this method.
item
- the item to be checked out, must not be null.checkoutStep
- the step to check out into. This step must have "Allow import
into step" enabled and must not be null.comment
- a comment describing the current action, must not be null.
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.
java.lang.IllegalArgumentException
- if any argument is null.CheckoutStatus checkoutAndWaitForStatus(Item item)
The item will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
item
- the item to be checked out, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if the argument is null.CheckoutStatus
CheckoutStatus checkoutAndWaitForStatus(Item item, java.lang.String comment)
The item will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
item
- the item to be checked out, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if either argument is null.CheckoutStatus
CheckoutStatus checkoutAndWaitForStatus(Item item, CollaborationStep checkoutStep)
The item will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
item
- the item to be checked out, must not be null.checkoutStep
- the step to check out into, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if either argument is null.CheckoutStatus
CheckoutStatus checkoutAndWaitForStatus(Item item, CollaborationStep checkoutStep, java.lang.String comment)
The item will be checked out immediately and the current program will suspend until checkout completes, at which point status will be available.
item
- the item to be checked out, must not be null.checkoutStep
- the step to check out into, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if any argument is null.CheckoutStatus
void drop(java.util.Collection<CollaborationItem> items)
You cannot assume the drop has completed or succeeded after calling this method.
items
- a collection of items to be dropped, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if one or more of the collaboration items do not belong to
this collaboration area.
java.lang.IllegalArgumentException
- if the argument is null.void drop(java.util.Collection<CollaborationItem> items, java.lang.String comment)
You cannot assume the drop has completed or succeeded after calling this method.
items
- a collection of items to be dropped, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if one or more of the collaboration items do not belong to
this collaboration area.
java.lang.IllegalArgumentException
- if either argument is null.void drop(CollaborationItem item)
You cannot assume the drop has completed or succeeded after calling this method.
item
- the item to be dropped, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if one or more of the collaboration items do not belong to
this collaboration area.
java.lang.IllegalArgumentException
- if the argument is null.void drop(CollaborationItem item, java.lang.String comment)
You cannot assume the drop has completed or succeeded after calling this method.
item
- the item to be dropped, must not be null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.UnsupportedOperationException
- if one or more of the collaboration items do not belong to
this collaboration area.
java.lang.IllegalArgumentException
- if either argument is null.CollaborationItem createCollaborationItem(java.lang.String primaryKey)
primaryKey
- the primary key for the new collaboration item, must not be
null or empty.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalArgumentException
- if any argument is null, or if the first is empty.CollaborationItem
CollaborationItem getCheckedOutItem(java.lang.String primaryKey)
primaryKey
- the primary key to search on, must not be null or empty.
PIMInternalException
- if an internal error occurs
java.lang.IllegalArgumentException
- if the argument is null or empty.PIMCollection<CollaborationItem> getCheckedOutItems()
PIMInternalException
- if an internal error occurs.java.util.Collection<CollaborationItem> getCheckedOutItems(java.util.List<java.lang.String> primaryKeys)
primaryKeys
- a collection of primary keys to retrieve.
PIMInternalException
- if an internal error occurs.int getNumberOfCheckedOutItems()
PIMInternalException
- if an internal error occurs.boolean interimCheckin(java.util.Collection<CollaborationItem> items, CollaborationStep currentStep)
items
- the items which should have their changed values copied back
to the source catalog of this collaboration area, must not be
null.currentStep
- the step from which the item should be published, must not be
null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if the argument is null.boolean interimCheckin(java.util.Collection<CollaborationItem> items, CollaborationStep currentStep, java.lang.String comment)
items
- the items which should have their changed values copied back
to the source catalog of this collaboration area, must not be
null.currentStep
- the step from which the item should be published, must not be
null.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_CHECKOUT_ENTRIES
.
java.lang.IllegalArgumentException
- if the argument is null.boolean moveToNextStep(java.util.Collection<CollaborationItem> items, CollaborationStep currentStep, java.lang.String exitValue)
You cannot assume the items have been moved after this operation completes.
items
- a collection of items in this collaboration area that are to
be moved, must not be null.currentStep
- the step from which the items should be moved, must not be
null.exitValue
- the exit value with which the items should be moved out of the
current step, must not be null or empty.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalArgumentException
- if any of the arguments is null, or if the exit value is
empty.
java.lang.UnsupportedOperationException
- if one or more items do not belong to this collaboration
area.boolean moveToNextStep(java.util.Collection<CollaborationItem> items, CollaborationStep currentStep, java.lang.String exitValue, java.lang.String comment)
You cannot assume the items have been moved after this operation completes.
items
- a collection of items in this collaboration area that are to
be moved, must not be null.currentStep
- the step from which the items should be moved, must not be
null.exitValue
- the exit value with which the items should be moved out of the
current step, must not be null or empty.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalArgumentException
- if any of the arguments is null, or if the exit value is
empty.
java.lang.UnsupportedOperationException
- if one or more items do not belong to this collaboration
area.boolean moveToNextStep(CollaborationItem item, CollaborationStep currentStep, java.lang.String exitValue)
You cannot assume the item has been moved after this operation completes.
item
- the item in this collaboration area that is to be moved, must
not be null.currentStep
- the step from which the item should be moved, must not be
null.exitValue
- the exit value with which the item should be moved out of the
current step, must not be null or empty.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalArgumentException
- if any of the arguments is null, or if the exit value is
empty.
java.lang.UnsupportedOperationException
- if the item does not belong to this collaboration area.boolean moveToNextStep(CollaborationItem item, CollaborationStep currentStep, java.lang.String exitValue, java.lang.String comment)
You cannot assume the item has been moved after this operation completes.
item
- the item in this collaboration area that is to be moved, must
not be null.currentStep
- the step from which the item should be moved, must not be
null.exitValue
- the exit value with which the item should be moved out of the
current step, must not be null or empty.comment
- a comment describing the current action, must not be null.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalArgumentException
- if any of the arguments is null, or if the exit value is
empty.
java.lang.UnsupportedOperationException
- if the item does not belong to this collaboration area.java.lang.String getWorkflowStepsXMLByAttributeValue(AttributeDefinition attrPath, java.lang.Object attrValue)
attrPath
- -
Attribute Definition object.attrValue
- -
Attribute Value.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalStateException
- if the object is not in a stable persisted state.
java.lang.IllegalArgumentException
- if argument passed is null.java.lang.String getWorkflowStepsXMLByAttributeValue(AttributeDefinition attrPath, java.lang.Object attrValue, Role role)
attrPath
- -
AttributeDefinition object.attrValue
- -
Attribute Value.role
- -
Role.
PIMInternalException
- if an internal error occurs.
java.lang.IllegalStateException
- if the object is not in a stable persisted state.
java.lang.IllegalArgumentException
- if argument passed is null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |