|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Folder
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 |
public static final String FOLDER_TYPE
public static final String FALLBACK_DEFAULT_PAGE
public static final String PAGE_NOT_FOUND_PAGE
public static final String USER_FOLDER
public static final String ROLE_FOLDER
public static final String GROUP_FOLDER
public static final int RESERVED_FOLDER_NONE
public static final int RESERVED_FOLDER_SUBSITES
public static final int RESERVED_FOLDER_USERS
public static final int RESERVED_FOLDER_ROLES
public static final int RESERVED_FOLDER_GROUPS
public static final int RESERVED_FOLDER_MEDIATYPE
public static final int RESERVED_FOLDER_LANGUAGE
public static final int RESERVED_FOLDER_COUNTRY
public static final int RESERVED_FOLDER_OTHER
Method Detail |
public String getDefaultPage(boolean allowDefaulting)
getDefaultPage
allowDefaulting
- flag to enable defaulting logic when not explicitly set
public void setDefaultPage(String defaultPage)
setDefaultPage
defaultPage
- public String getDefaultTheme()
getDefaultTheme
public void setDefaultTheme(String defaultTheme)
setDefaultTheme
defaultTheme
- public NodeSet getFolders() throws FolderNotFoundException, DocumentException
getFolders
NodeSet
containing all sub-folders directly under
this folder.
FolderNotFoundException
DocumentException
public Folder getFolder(String name) throws FolderNotFoundException, DocumentException
getFolder
name
-
FolderNotFoundException
DocumentException
public NodeSet getPages() throws NodeException
getPages
NodeException
PageNotFoundException
- if any of the Pages referenced by this Folder
could not be found.public Page getPage(String name) throws PageNotFoundException, NodeException
getPage
name
-
PageNotFoundException
- if the Page requested could not be found.
DocumentException
NodeException
public NodeSet getLinks() throws NodeException
getLinks
DocumentException
NodeException
public Link getLink(String name) throws DocumentNotFoundException, NodeException
getLink
name
-
DocumentNotFoundException
- if the document requested could not be found.
NodeException
public PageSecurity getPageSecurity() throws DocumentNotFoundException, NodeException
getPageSecurity
DocumentNotFoundException
- if the document requested could not be found.
NodeException
public NodeSet getAll() throws FolderNotFoundException, DocumentException
getAll
NodeSet
containing all sub-folders and documents directly under
this folder.
FolderNotFoundException
DocumentException
public FolderMetaData getFolderMetaData()
getFolderMetaData
public List getMenuDefinitions()
public void setMenuDefinitions(List definitions)
definitions
- definition listpublic boolean isReserved()
public int getReservedType()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |