|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.page.psml.AbstractBaseElement
org.apache.jetspeed.page.document.psml.AbstractNode
org.apache.jetspeed.om.folder.psml.FolderImpl
public class FolderImpl
FolderImpl
Field Summary |
---|
Fields inherited from interface org.apache.jetspeed.page.document.Node |
---|
PATH_SEPARATOR, PATH_SEPARATOR_CHAR |
Constructor Summary | |
---|---|
FolderImpl()
|
|
FolderImpl(java.lang.String path,
DocumentHandlerFactory handlerFactory,
FolderHandler folderHandler)
|
|
FolderImpl(java.lang.String path,
FolderMetaDataImpl metadata,
DocumentHandlerFactory handlerFactory,
FolderHandler folderHandler)
|
Method Summary | |
---|---|
void |
checkPermissions(java.lang.String path,
int mask,
boolean checkNodeOnly,
boolean checkParentsOnly)
checkPermissions |
NodeSet |
getAll()
getAll |
NodeSet |
getAllNodes()
getAllNodes |
protected NodeSet |
getAllNodes(boolean folderExistenceRequired)
|
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 |
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. |
PageSecurity |
getEffectivePageSecurity()
getEffectivePageSecurity |
Folder |
getFolder(java.lang.String name)
getFolder |
Folder |
getFolder(java.lang.String name,
boolean checkAccess)
getFolder |
FolderMetaDataImpl |
getFolderMetaData()
getFolderMetaData |
NodeSet |
getFolders()
getFolders |
NodeSet |
getFolders(boolean checkAccess)
getFolders |
Link |
getLink(java.lang.String name)
getLink |
Link |
getLink(java.lang.String name,
boolean checkAccess)
getLink |
NodeSet |
getLinks()
getLinks |
NodeSet |
getLinks(boolean checkAccess)
getLinks |
java.util.List |
getMenuDefinitions()
getMenuDefinitions - get list of menu definitions |
GenericMetadata |
getMetadata()
getMetadata |
Page |
getPage(java.lang.String name)
getPage |
Page |
getPage(java.lang.String name,
boolean checkAccess)
getPage |
NodeSet |
getPages()
getPages |
NodeSet |
getPages(boolean checkAccess)
getPages |
PageSecurity |
getPageSecurity()
getPageSecurity |
PageSecurity |
getPageSecurity(boolean checkAccess)
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 |
SecurityConstraints |
getSecurityConstraints()
getSecurityConstraints |
java.lang.String |
getShortTitle()
getShortTitle |
java.lang.String |
getShortTitle(java.util.Locale locale)
getShortTitle |
java.lang.String |
getSkin()
Returns the name of the skin that applies to this folder. |
java.lang.String |
getTitle()
getTitle |
java.lang.String |
getTitle(java.util.Locale locale)
getTitle |
java.lang.String |
getType()
getType |
boolean |
isHidden()
isHidden |
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 |
reset()
|
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 |
setFolderHandler(FolderHandler handler)
setFolderHandler |
void |
setHidden(boolean hidden)
setHidden |
void |
setMenuDefinitions(java.util.List definitions)
setMenuDefinitions - set list of menu definitions |
void |
setSecurityConstraints(SecurityConstraints constraints)
setSecurityConstraints |
void |
setShortTitle(java.lang.String title)
setShortTitle |
void |
setSkin(java.lang.String skinName)
Modifies the skin for this folder. |
void |
setTitle(java.lang.String title)
setTitle |
void |
unmarshalled()
unmarshalled - notification that this instance has been loaded from the persistent store |
Methods inherited from class org.apache.jetspeed.page.document.psml.AbstractNode |
---|
checkConstraints, getLogicalPermissionPath, getMetadataFields, getName, getParent, getParent, getPath, getPhysicalPermissionPath, getProfiledPath, getTitleName, getUrl, isDirty, setDirty, setMetadata, setMetadataFields, setParent, setPath, setProfiledPath, setUrl |
Methods inherited from class org.apache.jetspeed.om.page.psml.AbstractBaseElement |
---|
checkAccess, checkAccess, checkConstraints, checkPermissions, checkPermissions, equals, getConstraintsEnabled, getHandlerFactory, getId, getPermissionsEnabled, grantViewActionAccess, hashCode, marshalling, newSecurityConstraint, newSecurityConstraints, setConstraintsEnabled, setHandlerFactory, setId, setPermissionsEnabled, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.jetspeed.page.document.Node |
---|
getName, getParent, getPath, getUrl, setParent, setPath |
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement |
---|
getId |
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource |
---|
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, newSecurityConstraint, newSecurityConstraints |
Constructor Detail |
---|
public FolderImpl(java.lang.String path, FolderMetaDataImpl metadata, DocumentHandlerFactory handlerFactory, FolderHandler folderHandler)
public FolderImpl(java.lang.String path, DocumentHandlerFactory handlerFactory, FolderHandler folderHandler)
public FolderImpl()
Method Detail |
---|
public java.lang.String getSkin()
Folder
getSkin
in interface Folder
public void setSkin(java.lang.String skinName)
Folder
setSkin
in interface Folder
skinName
- the name of the new skin for the folderpublic java.lang.String getEffectiveDefaultDecorator(java.lang.String fragmentType)
Folder
getEffectiveDefaultDecorator
in interface Folder
fragmentType
- the type of fragment considered
public java.lang.String getDefaultDecorator(java.lang.String fragmentType)
Folder
getDefaultDecorator
in interface Folder
fragmentType
- the type of fragment considered
public void setDefaultDecorator(java.lang.String decoratorName, java.lang.String fragmentType)
Folder
setDefaultDecorator
in interface Folder
decoratorName
- the name of the new decorator for the typefragmentType
- the type of fragment consideredpublic java.util.List getDocumentOrder()
Folder
getDocumentOrder
in interface Folder
public void setDocumentOrder(java.util.List docIndexes)
Folder
setDocumentOrder
in interface Folder
docIndexes
- list of ordered document names in folderpublic java.lang.String getDefaultPage()
Folder
getDefaultPage
getDefaultPage
in interface Folder
public void setDefaultPage(java.lang.String defaultPage)
Folder
setDefaultPage
setDefaultPage
in interface Folder
public NodeSet getFolders(boolean checkAccess) throws DocumentException
getFolders
checkAccess
- flag
DocumentException
public NodeSet getFolders() throws DocumentException
Folder
getFolders
getFolders
in interface Folder
NodeSet
containing all sub-folders directly under
this folder.
DocumentException
public Folder getFolder(java.lang.String name, boolean checkAccess) throws FolderNotFoundException, DocumentException
getFolder
name
- checkAccess
- flag
FolderNotFoundException
DocumentException
public Folder getFolder(java.lang.String name) throws FolderNotFoundException, DocumentException
Folder
getFolder
getFolder
in interface Folder
FolderNotFoundException
DocumentException
public NodeSet getPages(boolean checkAccess) throws NodeException
getPages
checkAccess
- flag
NodeException
public NodeSet getPages() throws NodeException
Folder
getPages
getPages
in interface Folder
NodeException
public Page getPage(java.lang.String name, boolean checkAccess) throws PageNotFoundException, NodeException
getPage
name
- checkAccess
- flag
PageNotFoundException
NodeException
public Page getPage(java.lang.String name) throws PageNotFoundException, NodeException
Folder
getPage
getPage
in interface Folder
PageNotFoundException
- if the Page requested could not be found.
DocumentException
NodeException
public NodeSet getLinks(boolean checkAccess) throws NodeException
getLinks
checkAccess
- flag
NodeException
public NodeSet getLinks() throws NodeException
Folder
getLinks
getLinks
in interface Folder
DocumentException
NodeException
public Link getLink(java.lang.String name, boolean checkAccess) throws DocumentNotFoundException, NodeException
getLink
name
- checkAccess
- flag
DocumentNotFoundException
NodeException
public Link getLink(java.lang.String name) throws DocumentNotFoundException, NodeException
Folder
getLink
getLink
in interface Folder
DocumentNotFoundException
- if the document requested could not be found.
NodeException
public PageSecurity getPageSecurity(boolean checkAccess) throws DocumentNotFoundException, NodeException
getPageSecurity
checkAccess
- flag
DocumentNotFoundException
NodeException
public PageSecurity getPageSecurity() throws DocumentNotFoundException, NodeException
Folder
getPageSecurity
getPageSecurity
in interface Folder
DocumentNotFoundException
- if the document requested could not be found.
NodeException
public NodeSet getAll() throws DocumentException
Folder
getAll
getAll
in interface Folder
NodeSet
containing all sub-folders and documents directly under
this folder.
DocumentException
public NodeSet getAllNodes() throws DocumentException
getAllNodes
DocumentException
protected NodeSet getAllNodes(boolean folderExistenceRequired) throws DocumentException
DocumentException
public FolderMetaDataImpl getFolderMetaData()
getFolderMetaData
public void setFolderHandler(FolderHandler handler)
setFolderHandler
handler
- folder handlerpublic GenericMetadata getMetadata()
getMetadata
getMetadata
in interface Node
getMetadata
in class AbstractNode
org.apache.jetspeed.page.document.AbstractNode#getMetadata()
public SecurityConstraints getSecurityConstraints()
getSecurityConstraints
getSecurityConstraints
in interface SecuredResource
getSecurityConstraints
in class AbstractBaseElement
org.apache.jetspeed.om.common.SecureResource#getSecurityConstraints()
public void setSecurityConstraints(SecurityConstraints constraints)
setSecurityConstraints
setSecurityConstraints
in interface SecuredResource
setSecurityConstraints
in class AbstractBaseElement
constraints
- org.apache.jetspeed.om.common.SecureResource#setSecurityConstraints(org.apache.jetspeed.om.common.SecurityConstraints)
public PageSecurity getEffectivePageSecurity()
getEffectivePageSecurity
in class AbstractNode
org.apache.jetspeed.om.page.psml.AbstractElementImpl#getEffectivePageSecurity()
public void checkPermissions(java.lang.String path, int mask, boolean checkNodeOnly, boolean checkParentsOnly) throws java.lang.SecurityException
checkPermissions
checkPermissions
in class AbstractNode
path
- mask
- checkNodeOnly
- checkParentsOnly
-
java.lang.SecurityException
public java.lang.String getTitle(java.util.Locale locale)
getTitle
getTitle
in interface Node
getTitle
in class AbstractNode
locale
-
Node.getTitle(java.util.Locale)
public java.lang.String getTitle()
getTitle
getTitle
in interface BaseElement
getTitle
in class AbstractBaseElement
BaseElement.getTitle()
public void setTitle(java.lang.String title)
setTitle
setTitle
in interface BaseElement
setTitle
in class AbstractBaseElement
title
- BaseElement.setTitle(java.lang.String)
public java.lang.String getShortTitle(java.util.Locale locale)
getShortTitle
getShortTitle
in interface Node
getShortTitle
in class AbstractNode
locale
-
Node.getShortTitle(java.util.Locale)
public java.lang.String getShortTitle()
getShortTitle
getShortTitle
in interface BaseElement
getShortTitle
in class AbstractBaseElement
BaseElement.getShortTitle()
public void setShortTitle(java.lang.String title)
setShortTitle
setShortTitle
in interface BaseElement
setShortTitle
in class AbstractBaseElement
title
- BaseElement.setShortTitle(java.lang.String)
public java.lang.String getType()
getType
getType
in interface Node
Node.getType()
public boolean isHidden()
isHidden
isHidden
in interface Node
isHidden
in class AbstractNode
Node.isHidden()
public void setHidden(boolean hidden)
setHidden
setHidden
in interface Node
setHidden
in class AbstractNode
hidden
- org.apache.jetspeed.page.document.AbstractNode#setHidden(boolean)
public void reset()
reset
in interface Reset
public java.util.List getMenuDefinitions()
getMenuDefinitions
in interface Folder
public MenuDefinition newMenuDefinition()
newMenuDefinition
in interface Folder
public MenuExcludeDefinition newMenuExcludeDefinition()
newMenuExcludeDefinition
in interface Folder
public MenuIncludeDefinition newMenuIncludeDefinition()
newMenuIncludeDefinition
in interface Folder
public MenuOptionsDefinition newMenuOptionsDefinition()
newMenuOptionsDefinition
in interface Folder
public MenuSeparatorDefinition newMenuSeparatorDefinition()
newMenuSeparatorDefinition
in interface Folder
public void setMenuDefinitions(java.util.List definitions)
setMenuDefinitions
in interface Folder
definitions
- definition listpublic void unmarshalled()
unmarshalled
in class AbstractNode
public boolean isReserved()
Folder
isReserved
in interface Folder
public int getReservedType()
Folder
getReservedType
in interface Folder
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |