|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CollaborationItem
The JAVA API interface CollaborationItem represents an item object that has been checked out to a collaboration area and collaborated upon.
CollaborationItem
,
Item
Nested Class Summary | |
---|---|
static class |
CollaborationItem.SaveResult
Describes the Item Status after a Save operation |
Nested classes/interfaces inherited from interface com.ibm.pim.collaboration.CollaborationObject |
---|
CollaborationObject.Type |
Field Summary |
---|
Fields inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
copyright |
Fields inherited from interface com.ibm.pim.collaboration.CollaborationObject |
---|
copyright |
Method Summary | |
---|---|
void |
addToCategory(Category category)
Add this item to a category. |
void |
delete()
Deletes the item from the Product Information Manager. |
java.util.Collection<Category> |
getCategories()
Returns all the categories to which this item belongs. |
java.lang.String |
getDisplayName()
Returns the display name. |
java.util.Collection<Hierarchy> |
getLocationHierarchies()
Returns all the location hierarchies which are available on this catalog for this item, regardless of whether it has stored any data in them. |
java.lang.String |
getPrimaryKey()
Returns the primary key. |
CollaborationItem.SaveResult |
getSaveResult()
Returns an enumeration of the net effect of the last save on this item UNKNOWN, ADDED, MODIFIED, DELETED |
Item |
getSourceItem()
Get the item in the source catalog corresponding to this checked out item. |
void |
mapToCategory(Category category)
Map an item to a category. |
void |
moveToCategories(java.util.Collection<Category> categories)
Move item from existing categories to new set of categories. |
void |
moveToCategoriesWithMapping(java.util.Collection<Category> categories)
Move item from existing categories to new set of categories and add mappings. |
void |
removeFromCategory(Category category)
Remove an item from a category. |
ExtendedValidationErrors |
save()
Saves the item. |
void |
setCategorySpecificAttributeProcessing(boolean setEnabled)
Set whether or not category specific attributes should be processed for the item Default would be true to process them |
void |
setPrimaryKey(java.lang.String primaryKey)
Sets the primary key. |
ExtendedValidationErrors |
validate()
Validates the item. |
Methods inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
getAttributeChangesComparedTo, getAttributeInstance, getAttributeValue, getOriginalAttributeOwner, getRootAttributeInstance, getRootAttributeInstances, getSpecs, isComparable, setAttributeValue |
Methods inherited from interface com.ibm.pim.collaboration.CollaborationObject |
---|
getCollaborationArea, getCollaborationHistory, getCollaborationHistory, getEntranceDate, getLatestComment, getSteps, getType, isReserved, isReserved |
Method Detail |
---|
Item getSourceItem()
PIMInternalException
- if an internal error occurs.void addToCategory(Category category)
category
- Must be one which belongs to a hierarchy contained by the
catalog which contains the item, and must not be null.
If the item was already mapped to the category then no change will take place.
java.lang.IllegalArgumentException
- if the argument is null.
PIMInternalException
- if an internal error occurs.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_ATTRIBUTES
.void delete()
PIMInternalException
- If an internal error occurs.java.util.Collection<Category> getCategories()
Collection
of Category
to which
this item belongs. If the item does not belong to any categories
(in other words, it is unassigned), then an empty
Collection
is returned.
PIMInternalException
- If an internal error occurs.java.lang.String getDisplayName()
PIMInternalException
- If an internal error occurs.java.util.Collection<Hierarchy> getLocationHierarchies()
Collection
of Hierarchy
PIMInternalException
- If an internal error occurs.java.lang.String getPrimaryKey()
CollaborationItem.SaveResult getSaveResult()
PIMInternalException
- If an internal error occurs.ExtendedValidationErrors validate()
PIMInternalException
- If an internal error occurs.void mapToCategory(Category category) throws PIMInvalidOperationException
category
- The category to map the item to.
PIMInternalException
- If an internal error occurs
PIMInvalidOperationException
- If map is not allowed by categoryvoid moveToCategories(java.util.Collection<Category> categories)
categories
- new collection of categories to move the item to.
PIMInternalException
- If an internal error occursvoid moveToCategoriesWithMapping(java.util.Collection<Category> categories)
categories
- collection of categories to move the item to.
PIMInternalException
- If an internal error occursvoid removeFromCategory(Category category)
category
- There will be no effect if the item does not belong to the
given category.
PIMInternalException
- If an internal error occursExtendedValidationErrors save()
PIMInternalException
- If an internal error occurs.void setCategorySpecificAttributeProcessing(boolean setEnabled)
setEnabled
- to process them (default) or false to ignore processing them
PIMInternalException
- If an internal error occurs.void setPrimaryKey(java.lang.String primaryKey)
primaryKey
- The primary key
PIMInternalException
- If an internal error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |