|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CollaborationCategory
The JAVA API interface CollaborationCategory
represents a
category object that has been checked out to a collaboration area and
collaborated upon.
Save method on the containing collaboration area object must be called to
persist any modifications on the collaboration category to the database.
Please note that the root category for a category collaboration has the same name as the collaboration area. Therefore, the full paths of the collaboration categories begin with the collaboration area name.
CategoryCollaborationArea
,
Category
Nested Class Summary |
---|
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 |
addChild(CollaborationCategory childCategory)
Adds a category as a child of this category. |
void |
delete()
Deletes the given category. |
java.util.Collection<CollaborationCategory> |
getChildren()
Returns the categories immediately below this category. |
java.util.Collection<CollaborationCategory> |
getChildren(Catalog catalog,
boolean ordered,
boolean restrictToSubtreeWithItems)
Returns the categories immediately below this category. |
PIMCollection<CollaborationCategory> |
getDescendents()
Returns all the descendants of this category. |
java.lang.String |
getDisplayName()
Returns the name of this Category object |
java.util.Collection<java.lang.String> |
getFullPaths(boolean includeRootName)
Returns the full name paths of this Category. |
java.util.Collection<java.lang.String> |
getFullPaths(java.lang.String delimiter,
boolean includeRootName)
Returns the full name paths of this Category. |
int[] |
getLevels()
Returns the levels of this category in an array of Integers. |
CollaborationCategory |
getParent()
Returns this category's parent. |
java.util.Collection<CollaborationCategory> |
getParents()
Returns the parent categories of the given Category. |
java.lang.String |
getPrimaryKey()
Return the primary key of this Category |
java.util.Collection<SecondarySpec> |
getSecondarySpecs()
Returns the secondary specs defining this category’s attributes. |
Category |
getSourceCategory()
|
boolean |
hasChildren()
Determines if the given category has any children. |
boolean |
isRoot()
Identifies whether this Category is the root Category of the Hierarchy it lives within |
void |
removeChild(CollaborationCategory childCategory)
Remove the given child Category from this category's children. |
void |
removeSecondarySpec(SecondarySpec spec)
Disassociates a secondary spec defining this category’s attributes. |
ValidationErrors |
validate()
Validates the category. |
Methods inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
getAttributeChangesComparedTo, getAttributeChangesSinceLastSave, getAttributeInstance, getAttributeValue, getLastModifiedTimeMillis, 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 |
---|
Category getSourceCategory()
void addChild(CollaborationCategory childCategory)
childCategory
- the category to be added as a child
PIMInternalException
- If an internal error occursvoid delete()
PIMInternalException
- If an internal error occurs
java.lang.UnsupportedOperationException
- if this is a root categoryjava.util.Collection<CollaborationCategory> getChildren()
PIMInternalException
- If an internal error occursjava.util.Collection<CollaborationCategory> getChildren(Catalog catalog, boolean ordered, boolean restrictToSubtreeWithItems)
catalog
- the catalog to useordered
- If true and if the catalog supports ordering, then return the
child categories in catalog order.restrictToSubtreeWithItems
- If true, only return categories that have items in their
sub-trees.
PIMInternalException
- If an internal error occursPIMCollection<CollaborationCategory> getDescendents()
PIMInternalException
- If an internal error occursjava.util.Collection<java.lang.String> getFullPaths(boolean includeRootName)
includeRootName
- If true, the returned full paths include the root category
name.
PIMInternalException
- If an internal error occursjava.util.Collection<java.lang.String> getFullPaths(java.lang.String delimiter, boolean includeRootName)
delimiter
- The delimiter to be used in the full paths that are returned.includeRootName
- If true, the returned full paths include the root category
name.
PIMInternalException
- If an internal error occursint[] getLevels()
PIMInternalException
- If an internal error occursCollaborationCategory getParent()
PIMInternalException
- If an internal error occursjava.util.Collection<CollaborationCategory> getParents()
PIMInternalException
- If an internal error occursjava.util.Collection<SecondarySpec> getSecondarySpecs()
PIMInternalException
- If an internal error occursboolean hasChildren()
PIMInternalException
- If an internal error occursValidationErrors validate()
PIMInternalException
- If an internal error occurs.void removeChild(CollaborationCategory childCategory)
childCategory
- the child category to remove.
PIMInternalException
- If an internal error occursvoid removeSecondarySpec(SecondarySpec spec)
spec
- the secondary spec to be disassociated
PIMInternalException
- If an internal error occursjava.lang.String getDisplayName()
PIMInternalException
- if an internal error occursboolean isRoot()
PIMInternalException
- if an internal error occursjava.lang.String getPrimaryKey()
PIMInternalException
- if an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |