Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface Category
- All Superinterfaces:
- Document, Editable, WorkflowedDocument
public interface Category- extends Editable, WorkflowedDocument
Represents a Category in the repository.
The Category interface provides methods that aid in traversing a category tree.
To retrieve the immediate children of this Category object use getChildren(). To retrieve all the children (descendants) of this Category object use getAllChildren().
- Since:
- 6.0, Quickr 8.0 extends Editable instead of Document
Method Summary DocumentIdIterator getAllChildren()
Returns a depth first iterator over all child categories of this Category.DocumentIdIterator getChildren()
Returns an iterator of DocumentId objects of the immediate child categories of this Category object.DocumentId getParent()
Returns the DocumentId of the parent of this Category object.
Method Detail getChildren
DocumentIdIterator getChildren()
- Returns an iterator of DocumentId objects of the immediate child categories of this Category object.
The user must have Read access to the Category for it to be included in the returned iterator.
- Returns:
- an iterator of DocumentId objects of the immediate children of this Category; or an empty iterator if no immediate children are found
getAllChildren
DocumentIdIterator getAllChildren()
- Returns a depth first iterator over all child categories of this Category.
For example, a Category Tree that looks like:
a call to getAllChildren() will return DocumentId objects for the child categories of MyCategory in this order:MyCategory CategoryA CategoryA1 CategoryA1-1 CategoryA1-2 CategoryA2 CategoryB CategoryB1CategoryA, CategoryA1, CategoryA1-1, CategoryA1-2, CategoryA2, CategoryB, CategoryB1.
The user must have Read access to the Category for it to be included in the returned iterator.
- Returns:
- an iterator of DocumentId objects of all the children of this the Category; or an empty iterator if no children are found
getParent
DocumentId getParent()
- Returns the DocumentId of the parent of this Category object.
The DocumentId returned may be for a Taxonomy object or a Category object, depending on where this Category lies in the category tree.
This method will return null if the user does not have access to the parent of this Category.
- Returns:
- the DocumentId of the parent of this Category.
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD