com.ibm.workplace.wcm.api
Interface Category

All Superinterfaces:

Document

public interface Category

extends Document

Represents a Category in the repository.

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

Field Summary

static java.lang.String

COPYRIGHT Copyright statement

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.

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

public DocumentIdIterator getAllChildren()

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

For example, a Category Tree that looks like:

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

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

Returns:

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

getParent

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