org.apache.jetspeed.page.document
Interface Node

All Superinterfaces:
BaseElement, SecuredResource
All Known Subinterfaces:
ContentPage, Document, Folder, Link, Page, PageSecurity

public interface Node
extends BaseElement

Node

Version:
$Id: Node.java 516448 2007-03-09 16:25:47Z ate $
Author:
Scott T. Weaver

Field Summary
static String PATH_SEPARATOR
           
static char PATH_SEPARATOR_CHAR
           
 
Method Summary
 GenericMetadata getMetadata()
           getMetadata
 String getName()
           getName
 Node getParent()
           getParent
 String getPath()
           getPath
 String getShortTitle(Locale locale)
           getShortTitle
 String getTitle(Locale locale)
           getTitle
 String getType()
           getType
 String getUrl()
           getUrl
 boolean isHidden()
           isHidden
 void setHidden(boolean hidden)
           setHidden
 void setParent(Node parent)
           setParent
 void setPath(String path)
           setPath
 
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement
getId, getShortTitle, getTitle, 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 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

String getPath()

getPath

Returns:

getName

String getName()

getName

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

Returns:
Name, relative to the parent node.

setPath

void setPath(String path)

setPath

Sets the full-qualified path of this node.

Parameters:
path -

getMetadata

GenericMetadata getMetadata()

getMetadata

Returns:

getTitle

String getTitle(Locale locale)

getTitle

Returns the title for the specified locale.

Parameters:
locale -
Returns:
localized title of this Node.

getShortTitle

String getShortTitle(Locale locale)

getShortTitle

Returns the short title for the specified locale.

Parameters:
locale -
Returns:
localized title of this Node.

getType

String getType()

getType

Returns:

getUrl

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


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.