|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Category
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()
.
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()
Deprecated. Since 8.0, use Hierarchical.getParentId() |
Methods inherited from interface com.ibm.workplace.wcm.api.Item |
---|
getCreationDate, getDescription, getIdentity, getModifiedDate, getName, getTitle |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Methods inherited from interface com.ibm.workplace.wcm.api.EditableItem |
---|
setDescription, setName, setTitle |
Methods inherited from interface com.ibm.workplace.wcm.api.Hierarchical |
---|
getParentId |
Method Detail |
---|
DocumentIdIterator getChildren()
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.
DocumentId
objects of the immediate
children of this Category
; or an empty iterator if no immediate
children are foundDocumentIdIterator getAllChildren()
Category
.
For example, a Category Tree that looks like:
a call toMyCategory CategoryA CategoryA1 CategoryA1-1 CategoryA1-2 CategoryA2 CategoryB CategoryB1
getAllChildren()
will return DocumentId
objects for the child categories of MyCategory in this order:
CategoryA, 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.
DocumentId
objects of all the children of this
the Category
; or an empty iterator if no children are foundDocumentId getParent()
Hierarchical.getParentId()
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
.
DocumentId
of the parent of this Category
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |