org.apache.jetspeed.om.folder
Interface Folder

All Superinterfaces:

BaseElement, Node, SecuredResource

public interface Folder
extends Node, SecuredResource

Folder

Version:

$Id: Folder.java 881862 2009-11-18 18:24:48Z rwatler $

Author:

David Sean Taylor, Jeremy Ford

Field Summary

static java.lang.String	COUNTRY_FOLDER
static java.lang.String	FALLBACK_DEFAULT_PAGE
static java.lang.String	FOLDER_TYPE
static java.lang.String	GROUP_FOLDER
static java.lang.String	LANGUAGE_FOLDER
static java.lang.String	MEDIATYPE_FOLDER
static java.lang.String	PAGE_NOT_FOUND_PAGE
static java.lang.String	RESERVED_COUNTRY_FOLDER_NAME
static int	RESERVED_FOLDER_COUNTRY
static int	RESERVED_FOLDER_GROUPS
static int	RESERVED_FOLDER_LANGUAGE
static int	RESERVED_FOLDER_MEDIATYPE
static int	RESERVED_FOLDER_NONE
static int	RESERVED_FOLDER_OTHER
static java.lang.String	RESERVED_FOLDER_PREFIX
static int	RESERVED_FOLDER_ROLES
static int	RESERVED_FOLDER_SUBSITES
static int	RESERVED_FOLDER_USERS
static java.lang.String	RESERVED_GROUP_FOLDER_NAME
static java.lang.String	RESERVED_LANGUAGE_FOLDER_NAME
static java.lang.String	RESERVED_MEDIATYPE_FOLDER_NAME
static java.lang.String	RESERVED_ROLE_FOLDER_NAME
static java.lang.String	RESERVED_SUBSITE_FOLDER_PREFIX
static java.lang.String	RESERVED_USER_FOLDER_NAME
static java.lang.String	ROLE_FOLDER
static java.lang.String	SUBSITE_ROOT_FOLDER
static java.lang.String	USER_FOLDER

Fields inherited from interface org.apache.jetspeed.page.document.Node

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Method Summary

NodeSet	getAll() getAll
java.lang.String	getDefaultDecorator(java.lang.String fragmentType) Returns the name of the default decorator that applies to page fragments in this folder or subfolders.
java.lang.String	getDefaultPage() getDefaultPage
java.util.List	getDocumentOrder() getDocumentOrder
DynamicPage	getDynamicPage(java.lang.String name) getDynamicPage
NodeSet	getDynamicPages() getDynamicPages
java.lang.String	getEffectiveDefaultDecorator(java.lang.String fragmentType) Returns the name of the default decorator as set here or in parent folders that applies to page fragments in this folder or subfolders.
Folder	getFolder(java.lang.String name) getFolder
NodeSet	getFolders() getFolders
FragmentDefinition	getFragmentDefinition(java.lang.String name) getFragmentDefinition
NodeSet	getFragmentDefinitions() getFragmentDefinitions
Link	getLink(java.lang.String name) getLink
NodeSet	getLinks() getLinks
java.util.List	getMenuDefinitions() getMenuDefinitions - get list of menu definitions
Page	getPage(java.lang.String name) getPage
NodeSet	getPages() getPages
PageSecurity	getPageSecurity() getPageSecurity
PageTemplate	getPageTemplate(java.lang.String name) getPageTemplate
NodeSet	getPageTemplates() getPageTemplates
int	getReservedType() Returns a valid reserved folder type: RESERVED_FOLDER_SUBSITES RESERVED_FOLDER_USERS RESERVED_FOLDER_ROLES RESERVED_FOLDER_GROUPS RESERVED_FOLDER_MEDIATYPE RESERVED_FOLDER_LANGUAGE RESERVED_FOLDER_COUNTRY
java.lang.String	getSkin() Returns the name of the skin that applies to this folder.
boolean	isReserved() Determines if a folder is a reserved folder.
MenuDefinition	newMenuDefinition() newMenuDefinition - creates a new empty menu definition
MenuExcludeDefinition	newMenuExcludeDefinition() newMenuExcludeDefinition - creates a new empty menu exclude definition
MenuIncludeDefinition	newMenuIncludeDefinition() newMenuIncludeDefinition - creates a new empty menu include definition
MenuOptionsDefinition	newMenuOptionsDefinition() newMenuOptionsDefinition - creates a new empty menu options definition
MenuSeparatorDefinition	newMenuSeparatorDefinition() newMenuSeparatorDefinition - creates a new empty menu separator definition
void	setDefaultDecorator(java.lang.String decoratorName, java.lang.String fragmentType) Modifies the default decorator for the specified fragment type.
void	setDefaultPage(java.lang.String defaultPage) setDefaultPage
void	setDocumentOrder(java.util.List docIndexes) setDocumentOrder
void	setMenuDefinitions(java.util.List definitions) setMenuDefinitions - set list of menu definitions
void	setSkin(java.lang.String skinName) Modifies the skin for this folder.

Methods inherited from interface org.apache.jetspeed.page.document.Node

getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getType, getUrl, isHidden, setHidden, setParent, 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

FOLDER_TYPE

static final java.lang.String FOLDER_TYPE

See Also:

Constant Field Values

FALLBACK_DEFAULT_PAGE

static final java.lang.String FALLBACK_DEFAULT_PAGE

See Also:

Constant Field Values

PAGE_NOT_FOUND_PAGE

static final java.lang.String PAGE_NOT_FOUND_PAGE

See Also:

Constant Field Values

RESERVED_SUBSITE_FOLDER_PREFIX

static final java.lang.String RESERVED_SUBSITE_FOLDER_PREFIX

See Also:

Constant Field Values

RESERVED_FOLDER_PREFIX

static final java.lang.String RESERVED_FOLDER_PREFIX

See Also:

Constant Field Values

RESERVED_USER_FOLDER_NAME

static final java.lang.String RESERVED_USER_FOLDER_NAME

See Also:

Constant Field Values

RESERVED_ROLE_FOLDER_NAME

static final java.lang.String RESERVED_ROLE_FOLDER_NAME

See Also:

Constant Field Values

RESERVED_GROUP_FOLDER_NAME

static final java.lang.String RESERVED_GROUP_FOLDER_NAME

See Also:

Constant Field Values

RESERVED_MEDIATYPE_FOLDER_NAME

static final java.lang.String RESERVED_MEDIATYPE_FOLDER_NAME

See Also:

Constant Field Values

RESERVED_LANGUAGE_FOLDER_NAME

static final java.lang.String RESERVED_LANGUAGE_FOLDER_NAME

See Also:

Constant Field Values

RESERVED_COUNTRY_FOLDER_NAME

static final java.lang.String RESERVED_COUNTRY_FOLDER_NAME

See Also:

Constant Field Values

USER_FOLDER

static final java.lang.String USER_FOLDER

See Also:

Constant Field Values

ROLE_FOLDER

static final java.lang.String ROLE_FOLDER

See Also:

Constant Field Values

GROUP_FOLDER

static final java.lang.String GROUP_FOLDER

See Also:

Constant Field Values

MEDIATYPE_FOLDER

static final java.lang.String MEDIATYPE_FOLDER

See Also:

Constant Field Values

LANGUAGE_FOLDER

static final java.lang.String LANGUAGE_FOLDER

See Also:

Constant Field Values

COUNTRY_FOLDER

static final java.lang.String COUNTRY_FOLDER

See Also:

Constant Field Values

SUBSITE_ROOT_FOLDER

static final java.lang.String SUBSITE_ROOT_FOLDER

See Also:

Constant Field Values

RESERVED_FOLDER_NONE

static final int RESERVED_FOLDER_NONE

See Also:

Constant Field Values

RESERVED_FOLDER_SUBSITES

static final int RESERVED_FOLDER_SUBSITES

See Also:

Constant Field Values

RESERVED_FOLDER_USERS

static final int RESERVED_FOLDER_USERS

See Also:

Constant Field Values

RESERVED_FOLDER_ROLES

static final int RESERVED_FOLDER_ROLES

See Also:

Constant Field Values

RESERVED_FOLDER_GROUPS

static final int RESERVED_FOLDER_GROUPS

See Also:

Constant Field Values

RESERVED_FOLDER_MEDIATYPE

static final int RESERVED_FOLDER_MEDIATYPE

See Also:

Constant Field Values

RESERVED_FOLDER_LANGUAGE

static final int RESERVED_FOLDER_LANGUAGE

See Also:

Constant Field Values

RESERVED_FOLDER_COUNTRY

static final int RESERVED_FOLDER_COUNTRY

See Also:

Constant Field Values

RESERVED_FOLDER_OTHER

static final int RESERVED_FOLDER_OTHER

See Also:

Constant Field Values

Method Detail

getSkin

java.lang.String getSkin()

Returns the name of the skin that applies to this folder.

Returns:

the page default skin name

setSkin

void setSkin(java.lang.String skinName)

Modifies the skin for this folder.

Parameters:

skinName - the name of the new skin for the folder

getEffectiveDefaultDecorator

java.lang.String getEffectiveDefaultDecorator(java.lang.String fragmentType)

Returns the name of the default decorator as set here or in parent folders that applies to page fragments in this folder or subfolders.

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

getDefaultDecorator

java.lang.String getDefaultDecorator(java.lang.String fragmentType)

Returns the name of the default decorator that applies to page fragments in this folder or subfolders.

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

setDefaultDecorator

void setDefaultDecorator(java.lang.String decoratorName,
                         java.lang.String fragmentType)

Modifies the default decorator for the specified fragment type.

Parameters:

decoratorName - the name of the new decorator for the type

fragmentType - the type of fragment considered

getDocumentOrder

java.util.List getDocumentOrder()

getDocumentOrder

Returns:

list of ordered document names in folder

setDocumentOrder

void setDocumentOrder(java.util.List docIndexes)

setDocumentOrder

Parameters:

docIndexes - list of ordered document names in folder

getDefaultPage

java.lang.String getDefaultPage()

getDefaultPage

Returns:

A String representing the default psml page for this folder

setDefaultPage

void setDefaultPage(java.lang.String defaultPage)

setDefaultPage

Parameters:

defaultPage -

getFolders

NodeSet getFolders()
                   throws DocumentException

getFolders

Returns:

A NodeSet containing all sub-folders directly under this folder.

Throws:

DocumentException

getFolder

Folder getFolder(java.lang.String name)
                 throws FolderNotFoundException,
                        DocumentException

getFolder

Parameters:

name -

Returns:

A Folder referenced by this folder.

Throws:

FolderNotFoundException

DocumentException

getPages

NodeSet getPages()
                 throws NodeException

getPages

Returns:

NodeSet of all the Pages referenced by this Folder.

Throws:

NodeException

PageNotFoundException - if any of the Pages referenced by this Folder could not be found.

getPageTemplates

NodeSet getPageTemplates()
                         throws NodeException

getPageTemplates

Returns:

NodeSet of all the PageTemplates referenced by this Folder.

Throws:

NodeException

PageNotFoundException - if any of the PageTemplates referenced by this Folder could not be found.

getDynamicPages

NodeSet getDynamicPages()
                        throws NodeException

getDynamicPages

Returns:

NodeSet of all the DynamicPages referenced by this Folder.

Throws:

NodeException

PageNotFoundException - if any of the DynamicPages referenced by this Folder could not be found.

getFragmentDefinitions

NodeSet getFragmentDefinitions()
                               throws NodeException

getFragmentDefinitions

Returns:

NodeSet of all the FragmentDefinitions referenced by this Folder.

Throws:

NodeException

PageNotFoundException - if any of the FragmentDefinitions referenced by this Folder could not be found.

getPage

Page getPage(java.lang.String name)
             throws PageNotFoundException,
                    NodeException

getPage

Parameters:

name -

Returns:

A Page referenced by this folder.

Throws:

PageNotFoundException - if the Page requested could not be found.

DocumentException

NodeException

getPageTemplate

PageTemplate getPageTemplate(java.lang.String name)
                             throws PageNotFoundException,
                                    NodeException

getPageTemplate

Parameters:

name -

Returns:

A PageTemplate referenced by this folder.

Throws:

PageNotFoundException - if the PageTemplate requested could not be found.

DocumentException

NodeException

getDynamicPage

DynamicPage getDynamicPage(java.lang.String name)
                           throws PageNotFoundException,
                                  NodeException

getDynamicPage

Parameters:

name -

Returns:

A DynamicPage referenced by this folder.

Throws:

PageNotFoundException - if the DynamicPage requested could not be found.

DocumentException

NodeException

getFragmentDefinition

FragmentDefinition getFragmentDefinition(java.lang.String name)
                                         throws PageNotFoundException,
                                                NodeException

getFragmentDefinition

Parameters:

name -

Returns:

A FragmentDefinition referenced by this folder.

Throws:

PageNotFoundException - if the FragmentDefinition requested could not be found.

DocumentException

NodeException

getLinks

NodeSet getLinks()
                 throws NodeException

getLinks

Returns:

NodeSet of all the Links referenced by this Folder.

Throws:

DocumentException

NodeException

getLink

Link getLink(java.lang.String name)
             throws DocumentNotFoundException,
                    NodeException

getLink

Parameters:

name -

Returns:

A Link referenced by this folder.

Throws:

DocumentNotFoundException - if the document requested could not be found.

NodeException

getPageSecurity

PageSecurity getPageSecurity()
                             throws DocumentNotFoundException,
                                    NodeException

getPageSecurity

Parameters:

name -

Returns:

A PageSecurity referenced by this folder.

Throws:

DocumentNotFoundException - if the document requested could not be found.

NodeException

getAll

NodeSet getAll()
               throws DocumentException

getAll

Returns:

A NodeSet containing all sub-folders and documents directly under this folder.

Throws:

DocumentException

getMenuDefinitions

java.util.List getMenuDefinitions()

getMenuDefinitions - get list of menu definitions

Returns:

definition list

newMenuDefinition

MenuDefinition newMenuDefinition()

newMenuDefinition - creates a new empty menu definition

Returns:

a newly created MenuDefinition object for use in Folder

newMenuExcludeDefinition

MenuExcludeDefinition newMenuExcludeDefinition()

newMenuExcludeDefinition - creates a new empty menu exclude definition

Returns:

a newly created MenuExcludeDefinition object for use in Folder

newMenuIncludeDefinition

MenuIncludeDefinition newMenuIncludeDefinition()

newMenuIncludeDefinition - creates a new empty menu include definition

Returns:

a newly created MenuIncludeDefinition object for use in Folder

newMenuOptionsDefinition

MenuOptionsDefinition newMenuOptionsDefinition()

newMenuOptionsDefinition - creates a new empty menu options definition

Returns:

a newly created MenuOptionsDefinition object for use in Folder

newMenuSeparatorDefinition

MenuSeparatorDefinition newMenuSeparatorDefinition()

newMenuSeparatorDefinition - creates a new empty menu separator definition

Returns:

a newly created MenuSeparatorDefinition object for use in Folder

setMenuDefinitions

void setMenuDefinitions(java.util.List definitions)

setMenuDefinitions - set list of menu definitions

Parameters:

definitions - definition list

isReserved

boolean isReserved()

Determines if a folder is a reserved folder. Reserved folders are special folders that can hold subsites, the root of user folders, and the root of role folders.

Returns:

getReservedType

int getReservedType()

Returns a valid reserved folder type: RESERVED_FOLDER_SUBSITES RESERVED_FOLDER_USERS RESERVED_FOLDER_ROLES RESERVED_FOLDER_GROUPS RESERVED_FOLDER_MEDIATYPE RESERVED_FOLDER_LANGUAGE RESERVED_FOLDER_COUNTRY

Returns:

one of the valid reserved folder types