org.apache.lenya.cms.site
Interface SiteNode

All Known Implementing Classes:
AbstractSiteNode

public interface SiteNode

A node in the site structure.


Method Summary
 void delete()
          Deletes this node.
 SiteNode[] getChildren()
           
 java.lang.String getHref()
           
 java.lang.String[] getLanguages()
           
 Link getLink(java.lang.String language)
           
 java.lang.String getName()
           
 SiteNode getParent()
           
 java.lang.String getPath()
           
 SiteStructure getStructure()
           
 java.lang.String getSuffix()
           
 java.lang.String getUuid()
           
 boolean hasLink()
           
 boolean hasLink(java.lang.String language)
          Checks if a link for a certain language is contained.
 boolean isTopLevel()
           
 boolean isVisible()
           
 void setVisible(boolean visibleInNav)
          Sets the node visibility in the navigation.
 

Method Detail

getStructure

SiteStructure getStructure()
Returns:
The site structure this node belongs to.

getPath

java.lang.String getPath()
Returns:
The path.

getParent

SiteNode getParent()
                   throws SiteException
Returns:
The parent node.
Throws:
SiteException - If the node has no parent.

isTopLevel

boolean isTopLevel()
Returns:
If this is a top level node. Top level nodes have no parents.

getLanguages

java.lang.String[] getLanguages()
Returns:
The languages of this node.

getLink

Link getLink(java.lang.String language)
             throws SiteException
Parameters:
language - The language.
Returns:
The link for the language.
Throws:
SiteException - if no link is contained for the language.

getUuid

java.lang.String getUuid()
Returns:
The UUID of this node.

hasLink

boolean hasLink(java.lang.String language)
Checks if a link for a certain language is contained.

Parameters:
language - The language.
Returns:
A boolean value.

getName

java.lang.String getName()
Returns:
The name, i.e. the last path element.

isVisible

boolean isVisible()
Returns:
if the node is visible in the navigation.

setVisible

void setVisible(boolean visibleInNav)
Sets the node visibility in the navigation.

Parameters:
visibleInNav - if the node should be visible.

delete

void delete()
Deletes this node.


getChildren

SiteNode[] getChildren()
Returns:
The children of this node.

hasLink

boolean hasLink()
Returns:
if the node has an external link.

getHref

java.lang.String getHref()
Returns:
The external link.

getSuffix

java.lang.String getSuffix()
Returns:
The suffix.


Copyright 1999-2006 Apache Software Foundation. All Rights Reserved.