com.ibm.workplace.wcm.api
Interface Taxonomy

All Superinterfaces:

Document

public interface Taxonomy

extends Document

Represents a Taxonomy in the repository.

A Taxonomy cannot be created, edited or deleted through the API. It must already exist 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().

Field Summary

static java.lang.String

COPYRIGHT Copyright statement

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.Document

getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getId, getLiveAccessMembers, getModifiedDate, getName, getOwners, getReadAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

Method Detail

getChildren

public DocumentIdIterator getChildren()

Returns an iterator of DocumentId objects of the immediate child categories of this Taxonomy.

Returns:

an iterator of DocumentId objects of the immediate children of this Taxonomy; or an empty iterator if no immediate children are found.

getAllChildren

public DocumentIdIterator getAllChildren()

Returns a depth first iterator over all child categories of this Taxonomy.

For example, a Category Tree that looks like:

 MyTaxonomy
    CategoryA
       CategoryA1
          CategoryA1-1
          CategoryA1-2
       CategoryA2
    CategoryB
       CategoryB1
 

a call to 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.

Returns:

an iterator of DocumentId objects of all the children of this Taxonomy; or an empty iterator if no children are found