org.apache.jetspeed.om.folder
Interface Folder

All Superinterfaces:
BaseElement, Node, SecuredResource

public interface Folder
extends Node

Folder

Version:
$Id: Folder.java 219577 2005-07-18 22:19:05Z taylor $
Author:
David Sean Taylor, Jeremy Ford

Field Summary
static String FALLBACK_DEFAULT_PAGE
           
static String FOLDER_TYPE
           
static String GROUP_FOLDER
           
static String PAGE_NOT_FOUND_PAGE
           
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 int RESERVED_FOLDER_ROLES
           
static int RESERVED_FOLDER_SUBSITES
           
static int RESERVED_FOLDER_USERS
           
static String ROLE_FOLDER
           
static String USER_FOLDER
           
 
Fields inherited from interface org.apache.jetspeed.page.document.Node
PATH_SEPARATOR, PATH_SEPARATOR_CHAR
 
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource
EDIT_ACTION, VIEW_ACTION
 
Method Summary
 NodeSet getAll()
           getAll
 String getDefaultPage(boolean allowDefaulting)
           getDefaultPage
 String getDefaultTheme()
           getDefaultTheme
 Folder getFolder(String name)
           getFolder
 FolderMetaData getFolderMetaData()
           getFolderMetaData
 NodeSet getFolders()
           getFolders
 Link getLink(String name)
           getLink
 NodeSet getLinks()
           getLinks
 List getMenuDefinitions()
          getMenuDefinitions - get list of menu definitions
 Page getPage(String name)
           getPage
 NodeSet getPages()
           getPages
 PageSecurity getPageSecurity()
           getPageSecurity
 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
 boolean isReserved()
          Determines if a folder is a reserved folder.
 void setDefaultPage(String defaultPage)
           setDefaultPage
 void setDefaultTheme(String defaultTheme)
           setDefaultTheme
 void setMenuDefinitions(List definitions)
          setMenuDefinitions - set list of menu definitions
 
Methods inherited from interface org.apache.jetspeed.page.document.Node
getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getType, getUrl, isHidden, setParent, 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

FOLDER_TYPE

public static final String FOLDER_TYPE
See Also:
Constant Field Values

FALLBACK_DEFAULT_PAGE

public static final String FALLBACK_DEFAULT_PAGE
See Also:
Constant Field Values

PAGE_NOT_FOUND_PAGE

public static final String PAGE_NOT_FOUND_PAGE
See Also:
Constant Field Values

USER_FOLDER

public static final String USER_FOLDER
See Also:
Constant Field Values

ROLE_FOLDER

public static final String ROLE_FOLDER
See Also:
Constant Field Values

GROUP_FOLDER

public static final String GROUP_FOLDER
See Also:
Constant Field Values

RESERVED_FOLDER_NONE

public static final int RESERVED_FOLDER_NONE
See Also:
Constant Field Values

RESERVED_FOLDER_SUBSITES

public static final int RESERVED_FOLDER_SUBSITES
See Also:
Constant Field Values

RESERVED_FOLDER_USERS

public static final int RESERVED_FOLDER_USERS
See Also:
Constant Field Values

RESERVED_FOLDER_ROLES

public static final int RESERVED_FOLDER_ROLES
See Also:
Constant Field Values

RESERVED_FOLDER_GROUPS

public static final int RESERVED_FOLDER_GROUPS
See Also:
Constant Field Values

RESERVED_FOLDER_MEDIATYPE

public static final int RESERVED_FOLDER_MEDIATYPE
See Also:
Constant Field Values

RESERVED_FOLDER_LANGUAGE

public static final int RESERVED_FOLDER_LANGUAGE
See Also:
Constant Field Values

RESERVED_FOLDER_COUNTRY

public static final int RESERVED_FOLDER_COUNTRY
See Also:
Constant Field Values

RESERVED_FOLDER_OTHER

public static final int RESERVED_FOLDER_OTHER
See Also:
Constant Field Values
Method Detail

getDefaultPage

public String getDefaultPage(boolean allowDefaulting)

getDefaultPage

Parameters:
allowDefaulting - flag to enable defaulting logic when not explicitly set
Returns:
A String representing the default psml page for this folder

setDefaultPage

public void setDefaultPage(String defaultPage)

setDefaultPage

Parameters:
defaultPage -

getDefaultTheme

public String getDefaultTheme()

getDefaultTheme

Returns:
A String representing the default theme for this Folder

setDefaultTheme

public void setDefaultTheme(String defaultTheme)

setDefaultTheme

Parameters:
defaultTheme -

getFolders

public NodeSet getFolders()
                   throws FolderNotFoundException,
                          DocumentException

getFolders

Returns:
A NodeSet containing all sub-folders directly under this folder.
Throws:
FolderNotFoundException
DocumentException

getFolder

public Folder getFolder(String name)
                 throws FolderNotFoundException,
                        DocumentException

getFolder

Parameters:
name -
Returns:
A Folder referenced by this folder.
Throws:
FolderNotFoundException
DocumentException

getPages

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

getPage

public Page getPage(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

getLinks

public NodeSet getLinks()
                 throws NodeException

getLinks

Returns:
NodeSet of all the Links referenced by this Folder.
Throws:
DocumentException
NodeException

getLink

public Link getLink(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

public PageSecurity getPageSecurity()
                             throws DocumentNotFoundException,
                                    NodeException

getPageSecurity

Returns:
A PageSecurity referenced by this folder.
Throws:
DocumentNotFoundException - if the document requested could not be found.
NodeException

getAll

public NodeSet getAll()
               throws FolderNotFoundException,
                      DocumentException

getAll

Returns:
A NodeSet containing all sub-folders and documents directly under this folder.
Throws:
FolderNotFoundException
DocumentException

getFolderMetaData

public FolderMetaData getFolderMetaData()

getFolderMetaData

Returns:
folder metadata

getMenuDefinitions

public List getMenuDefinitions()
getMenuDefinitions - get list of menu definitions

Returns:
definition list

setMenuDefinitions

public void setMenuDefinitions(List definitions)
setMenuDefinitions - set list of menu definitions

Parameters:
definitions - definition list

isReserved

public 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

public 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


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