org.apache.jetspeed.page.document
Interface Node

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

public interface Node
extends BaseElement

Node

Version:
$Id: Node.java 187962 2004-11-19 03:07:43Z taylor $
Author:
Scott T. Weaver

Field Summary
static String PATH_SEPARATOR
           
static char PATH_SEPARATOR_CHAR
           
 
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource
EDIT_ACTION, VIEW_ACTION
 
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 setParent(Node parent)
           setParent
 void setPath(String path)
           setPath
 
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement
getId, getShortTitle, getTitle, setId, setShortTitle, setTitle
 
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, setSecurityConstraints
 

Field Detail

PATH_SEPARATOR

public static final String PATH_SEPARATOR
See Also:
Constant Field Values

PATH_SEPARATOR_CHAR

public static final char PATH_SEPARATOR_CHAR
See Also:
Constant Field Values
Method Detail

getParent

public Node getParent()

getParent

Returns:

setParent

public void setParent(Node parent)

setParent

Parameters:
parent -

getPath

public String getPath()

getPath

Returns:

getName

public String getName()

getName

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

Returns:
Name, relative to the parent node.

setPath

public void setPath(String path)

setPath

Sets the full-qualified path of this node.

Parameters:
path -

getMetadata

public GenericMetadata getMetadata()

getMetadata

Returns:

getTitle

public String getTitle(Locale locale)

getTitle

Returns the title for the specified locale.

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

getShortTitle

public String getShortTitle(Locale locale)

getShortTitle

Returns the short title for the specified locale.

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

getType

public String getType()

getType

Returns:

getUrl

public String getUrl()

getUrl

Returns:

isHidden

public 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:


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