This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.site.tree
Interface SiteTree

All Superinterfaces:

org.apache.lenya.cms.repository.RepositoryItem, org.apache.lenya.cms.site.SiteStructure

All Known Implementing Classes:

DefaultSiteTree, DelegatingSiteTree, SiteTreeImpl

public interface SiteTree
extends org.apache.lenya.cms.site.SiteStructure

A sitetree.

Version:

$Id: SiteTree.java 177923 2005-05-23 05:15:51Z gregor $

Field Summary

static java.lang.String

IDENTIFIABLE_TYPE The type of sitetree identifiable objects.

Method Summary

void	moveDown(java.lang.String path) Move down the node amongst its siblings.
void	moveUp(java.lang.String path) Move up the node amongst its siblings.
org.apache.lenya.cms.site.SiteNode[]	preOrder()

Methods inherited from interface org.apache.lenya.cms.site.SiteStructure

add, add, add, contains, contains, containsByUuid, containsInAnyLanguage, getArea, getByUuid, getNode, getNodes, getPublication, getRepositoryNode, getTopLevelNodes

Methods inherited from interface org.apache.lenya.cms.repository.RepositoryItem

getSession

Field Detail

IDENTIFIABLE_TYPE

static final java.lang.String IDENTIFIABLE_TYPE

The type of sitetree identifiable objects.

See Also:

Constant Field Values

Method Detail

moveUp

void moveUp(java.lang.String path)
            throws org.apache.lenya.cms.site.SiteException

Move up the node amongst its siblings.

Parameters:

path - The document id of the node.

Throws:

org.apache.lenya.cms.site.SiteException - if the moving failed.

moveDown

void moveDown(java.lang.String path)
              throws org.apache.lenya.cms.site.SiteException

Move down the node amongst its siblings.

Parameters:

path - The document id of the node.

Throws:

org.apache.lenya.cms.site.SiteException - if the moving failed.

preOrder

org.apache.lenya.cms.site.SiteNode[] preOrder()

Returns:

The nodes in pre order.