org.apache.jetspeed.page.document
Interface Node

All Superinterfaces:

BaseElement, SecuredResource

All Known Subinterfaces:

BaseConcretePageElement, BaseFragmentsElement, BasePageElement, Dashboard, Document, DynamicPage, Folder, FragmentDefinition, Link, Page, PageSecurity, PageTemplate

public interface Node
extends BaseElement

Node

Version:

$Id: Node.java 707224 2008-10-22 23:46:45Z ate $

Author:

Scott T. Weaver

Field Summary

static java.lang.String	PATH_SEPARATOR
static char	PATH_SEPARATOR_CHAR

Method Summary

GenericMetadata	getMetadata() getMetadata
java.lang.String	getName() getName
Node	getParent() getParent
java.lang.String	getPath() getPath
java.lang.String	getShortTitle(java.util.Locale locale) getShortTitle
java.lang.String	getTitle(java.util.Locale locale) getTitle
java.lang.String	getType() getType
java.lang.String	getUrl() getUrl
boolean	isHidden() isHidden
void	setHidden(boolean hidden) setHidden
void	setParent(Node parent) setParent
void	setPath(java.lang.String path) setPath

Methods inherited from interface org.apache.jetspeed.om.page.BaseElement

getId, getShortTitle, getTitle, isStale, setShortTitle, setTitle

Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource

checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints

Field Detail

PATH_SEPARATOR

static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

PATH_SEPARATOR_CHAR

static final char PATH_SEPARATOR_CHAR

See Also:

Constant Field Values

Method Detail

getParent

Node getParent()

getParent

Returns:

setParent

void setParent(Node parent)

setParent

Parameters:

parent -

getPath

java.lang.String getPath()

getPath

Returns:

getName

java.lang.String getName()

getName

Returns the name of this node relative to Node.getParent().getPath()

Returns:

Name, relative to the parent node.

setPath

void setPath(java.lang.String path)

setPath

Sets the full-qualified path of this node.

Parameters:

path -

getMetadata

GenericMetadata getMetadata()

getMetadata

Returns:

getTitle

java.lang.String getTitle(java.util.Locale locale)

getTitle

Returns the title for the specified locale.

Parameters:

locale -

Returns:

localized title of this Node.

getShortTitle

java.lang.String getShortTitle(java.util.Locale locale)

getShortTitle

Returns the short title for the specified locale.

Parameters:

locale -

Returns:

localized title of this Node.

getType

java.lang.String getType()

getType

Returns:

getUrl

java.lang.String getUrl()

getUrl

Returns:

isHidden

boolean isHidden()

isHidden

Whether or not this Node should be hidden in terms of the view. This MUST NOT restrict the presence of this node in terms of being returned in org.apache.jetspeed.page.document.NodeSet.

Returns:

hidden flag

setHidden

void setHidden(boolean hidden)

setHidden

Whether or not this Node should be hidden in terms of the view.

Parameters:

hidden - flag