de.innovationgate.webgate.api

Interface PageHierarchyNode

All Known Implementing Classes:

WGArea, WGContent, WGContentType, WGCSSJSModule, WGDatabase, WGDatabase.DocumentCollectionHierarchy, WGDesignDocument, WGDesignResourceDocument, WGFileContainer, WGLanguage, WGSchemaDocument, WGScriptModule, WGStructEntry, WGTMLModule

public interface PageHierarchyNode

Interface that represents a node in the page hierarchy of a WGA Content Store.

Method Summary

Methods

Modifier and Type	Method and Description
SkippingIterator<? extends PageHierarchyNode>	getChildNodeIterator(int pageSize) Returns an iterator for the child nodes of this hierarchy node
java.util.List<? extends PageHierarchyNode>	getChildNodes() Returns the child nodes of this hierarchy node
java.lang.Class<?>	getChildNodeType() Return the class type of child nodes
java.lang.String	getNodeKey() Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
java.lang.String	getNodeTitle(java.lang.String language) Returns the display title for the node.
PageHierarchyNode	getParentNode() Return the parent of this node in hierarchy.

Method Detail

getChildNodes

java.util.List<? extends PageHierarchyNode> getChildNodes()
                                                          throws WGAPIException

Returns the child nodes of this hierarchy node

Throws:

WGAPIException

getChildNodeIterator

SkippingIterator<? extends PageHierarchyNode> getChildNodeIterator(int pageSize)
                                                                   throws WGAPIException

Returns an iterator for the child nodes of this hierarchy node

Parameters:

pageSize - The size of a fetch page, if the implementation fetches childnodes page-wise

Throws:

WGAPIException

getChildNodeType

java.lang.Class<?> getChildNodeType()

Return the class type of child nodes

getParentNode

PageHierarchyNode getParentNode()
                                throws WGAPIException

Return the parent of this node in hierarchy. Return null at the root level.

Throws:

WGAPIException

getNodeTitle

java.lang.String getNodeTitle(java.lang.String language)
                              throws WGAPIException

Returns the display title for the node. If multiple titles for multiple languages exist we choose a specific one for the given language.

Parameters:

language - The language whose title is wanted

Returns:

The title

Throws:

WGAPIException

getNodeKey

java.lang.String getNodeKey()
                            throws WGAPIException

Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.

Throws:

WGAPIException