Folder (Jetspeed-2 Core API 2.3.1 API)

All Superinterfaces:

BaseElement, Node, SecuredResource
```
public interface Folder
extends Node, SecuredResource
```
Folder

Version:

$Id: Folder.java 1666716 2015-03-14 16:58:01Z taylor $

Author:

David Sean Taylor, Jeremy Ford

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COUNTRY_FOLDER`
`static String`	`FALLBACK_DEFAULT_PAGE`
`static String`	`FOLDER_TYPE`
`static String`	`GROUP_FOLDER`
`static String`	`LANGUAGE_FOLDER`
`static String`	`MEDIATYPE_FOLDER`
`static String`	`PAGE_NOT_FOUND_PAGE`
`static 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 String`	`RESERVED_FOLDER_PREFIX`
`static int`	`RESERVED_FOLDER_ROLES`
`static int`	`RESERVED_FOLDER_SUBSITES`
`static int`	`RESERVED_FOLDER_USERS`
`static String`	`RESERVED_GROUP_FOLDER_NAME`
`static String`	`RESERVED_LANGUAGE_FOLDER_NAME`
`static String`	`RESERVED_MEDIATYPE_FOLDER_NAME`
`static String`	`RESERVED_ROLE_FOLDER_NAME`
`static String`	`RESERVED_SUBSITE_FOLDER_PREFIX`
`static String`	`RESERVED_USER_FOLDER_NAME`
`static String`	`RESERVED_USER_TEMPLATE_FOLDER_NAME`
`static String`	`ROLE_FOLDER`
`static String`	`SUBSITE_ROOT_FOLDER`
`static String`	`USER_FOLDER`
`static String`	`USER_TEMPLATE_FOLDER`

Fields inherited from interface org.apache.jetspeed.page.document.Node
PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Method Summary

Methods
Modifier and Type	Method and Description
`NodeSet`	`getAll()` getAll
`String`	`getDefaultDecorator(String fragmentType)` Returns the name of the default decorator that applies to page fragments in this folder or subfolders.
`String`	`getDefaultPage()` getDefaultPage
`List<String>`	`getDocumentOrder()` getDocumentOrder
`DynamicPage`	`getDynamicPage(String name)` getDynamicPage
`NodeSet`	`getDynamicPages()` getDynamicPages
`String`	`getEffectiveDefaultDecorator(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(String name)` getFolder
`NodeSet`	`getFolders()` getFolders
`FragmentDefinition`	`getFragmentDefinition(String name)` getFragmentDefinition
`NodeSet`	`getFragmentDefinitions()` getFragmentDefinitions
`Link`	`getLink(String name)` getLink
`NodeSet`	`getLinks()` getLinks
`List<MenuDefinition>`	`getMenuDefinitions()` getMenuDefinitions - get list of menu definitions
`Page`	`getPage(String name)` getPage
`NodeSet`	`getPages()` getPages
`PageSecurity`	`getPageSecurity()` getPageSecurity
`PageTemplate`	`getPageTemplate(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
`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(String decoratorName, String fragmentType)` Modifies the default decorator for the specified fragment type.
`void`	`setDefaultPage(String defaultPage)` setDefaultPage
`void`	`setDocumentOrder(List<String> docIndexes)` setDocumentOrder
`void`	`setMenuDefinitions(List<MenuDefinition> definitions)` setMenuDefinitions - set list of menu definitions
`void`	`setSkin(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 String FOLDER_TYPE
```
    See Also:
    Constant Field Values
  - FALLBACK_DEFAULT_PAGE
```
static final String FALLBACK_DEFAULT_PAGE
```
    See Also:
    Constant Field Values
  - PAGE_NOT_FOUND_PAGE
```
static final String PAGE_NOT_FOUND_PAGE
```
    See Also:
    Constant Field Values
  - RESERVED_SUBSITE_FOLDER_PREFIX
```
static final String RESERVED_SUBSITE_FOLDER_PREFIX
```
    See Also:
    Constant Field Values
  - RESERVED_FOLDER_PREFIX
```
static final String RESERVED_FOLDER_PREFIX
```
    See Also:
    Constant Field Values
  - RESERVED_USER_FOLDER_NAME
```
static final String RESERVED_USER_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - RESERVED_ROLE_FOLDER_NAME
```
static final String RESERVED_ROLE_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - RESERVED_GROUP_FOLDER_NAME
```
static final String RESERVED_GROUP_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - RESERVED_MEDIATYPE_FOLDER_NAME
```
static final String RESERVED_MEDIATYPE_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - RESERVED_LANGUAGE_FOLDER_NAME
```
static final String RESERVED_LANGUAGE_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - RESERVED_COUNTRY_FOLDER_NAME
```
static final String RESERVED_COUNTRY_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - RESERVED_USER_TEMPLATE_FOLDER_NAME
```
static final String RESERVED_USER_TEMPLATE_FOLDER_NAME
```
    See Also:
    Constant Field Values
  - USER_FOLDER
```
static final String USER_FOLDER
```
    See Also:
    Constant Field Values
  - ROLE_FOLDER
```
static final String ROLE_FOLDER
```
    See Also:
    Constant Field Values
  - GROUP_FOLDER
```
static final String GROUP_FOLDER
```
    See Also:
    Constant Field Values
  - MEDIATYPE_FOLDER
```
static final String MEDIATYPE_FOLDER
```
    See Also:
    Constant Field Values
  - LANGUAGE_FOLDER
```
static final String LANGUAGE_FOLDER
```
    See Also:
    Constant Field Values
  - COUNTRY_FOLDER
```
static final String COUNTRY_FOLDER
```
    See Also:
    Constant Field Values
  - SUBSITE_ROOT_FOLDER
```
static final String SUBSITE_ROOT_FOLDER
```
    See Also:
    Constant Field Values
  - USER_TEMPLATE_FOLDER
```
static final String USER_TEMPLATE_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
```
String getSkin()
```
    Returns the name of the skin that applies to this folder.
    
    Returns:
    the page default skin name
  - setSkin
```
void setSkin(String skinName)
```
    Modifies the skin for this folder.
    
    Parameters:
    skinName - the name of the new skin for the folder
  - getEffectiveDefaultDecorator
```
String getEffectiveDefaultDecorator(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
```
String getDefaultDecorator(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(String decoratorName,
                       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
```
List<String> getDocumentOrder()
```
    getDocumentOrder
    
    Returns:
    list of ordered document names in folder
  - setDocumentOrder
```
void setDocumentOrder(List<String> docIndexes)
```
    setDocumentOrder
    
    Parameters:
    docIndexes - list of ordered document names in folder
  - getDefaultPage
```
String getDefaultPage()
```
    getDefaultPage
    
    Returns:
    A String representing the default psml page for this folder
  - setDefaultPage
```
void setDefaultPage(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(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(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(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(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(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(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
    
    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
```
List<MenuDefinition> 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(List<MenuDefinition> 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

Interface Folder

Field Summary

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

Method Summary

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

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

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

Field Detail

FOLDER_TYPE

FALLBACK_DEFAULT_PAGE

PAGE_NOT_FOUND_PAGE

RESERVED_SUBSITE_FOLDER_PREFIX

RESERVED_FOLDER_PREFIX

RESERVED_USER_FOLDER_NAME

RESERVED_ROLE_FOLDER_NAME

RESERVED_GROUP_FOLDER_NAME

RESERVED_MEDIATYPE_FOLDER_NAME

RESERVED_LANGUAGE_FOLDER_NAME

RESERVED_COUNTRY_FOLDER_NAME

RESERVED_USER_TEMPLATE_FOLDER_NAME

USER_FOLDER

ROLE_FOLDER

GROUP_FOLDER

MEDIATYPE_FOLDER

LANGUAGE_FOLDER

COUNTRY_FOLDER

SUBSITE_ROOT_FOLDER

USER_TEMPLATE_FOLDER

RESERVED_FOLDER_NONE

RESERVED_FOLDER_SUBSITES

RESERVED_FOLDER_USERS

RESERVED_FOLDER_ROLES

RESERVED_FOLDER_GROUPS

RESERVED_FOLDER_MEDIATYPE

RESERVED_FOLDER_LANGUAGE

RESERVED_FOLDER_COUNTRY

RESERVED_FOLDER_OTHER

Method Detail

getSkin

setSkin

getEffectiveDefaultDecorator

getDefaultDecorator

setDefaultDecorator

getDocumentOrder

setDocumentOrder

getDefaultPage

setDefaultPage

getFolders

getFolder

getPages

getPageTemplates

getDynamicPages

getFragmentDefinitions

getPage

getPageTemplate

getDynamicPage

getFragmentDefinition

getLinks

getLink

getPageSecurity

getAll

getMenuDefinitions

newMenuDefinition

newMenuExcludeDefinition

newMenuIncludeDefinition

newMenuOptionsDefinition

newMenuSeparatorDefinition

setMenuDefinitions

isReserved

getReservedType