|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Taxonomy
Represents a Taxonomy
in the repository.
The Taxonomy
interface provides methods that aid in traversing
the Category Tree and allows the grouping of Category
objects.
To retrieve the immediate children of this Taxonomy
object use
getChildren()
. To retrieve all the children (descendants) of this
Taxonomy
object use getAllChildren()
.
Method Summary | |
---|---|
DocumentIdIterator |
getAllChildren()
Returns a depth first iterator over all child categories of this Taxonomy . |
DocumentIdIterator |
getChildren()
Returns an iterator of DocumentId objects of the immediate
child categories of this Taxonomy . |
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 |
Method Detail |
---|
DocumentIdIterator getChildren()
DocumentId
objects of the immediate
child categories of this Taxonomy
.
DocumentId
objects of the immediate
children of this Taxonomy
; or an empty iterator if no immediate
children are found.DocumentIdIterator getAllChildren()
Taxonomy
.
For example, a Category Tree that looks like:
a call toMyTaxonomy CategoryA CategoryA1 CategoryA1-1 CategoryA1-2 CategoryA2 CategoryB CategoryB1
getAllChildren()
will return DocumentId
objects for the child categories of MyTaxonomy 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
Taxonomy
; or an empty iterator if no children are found
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |