|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.page.impl.BaseElementImpl
org.apache.jetspeed.page.document.impl.NodeImpl
org.apache.jetspeed.om.folder.impl.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()
|
Method Summary | |
---|---|
java.util.List |
accessAll()
accessAll Access all transient cache collection for use by PageManager. |
java.util.List |
accessFolders()
accessFolders Access folders transient cache collection for use by PageManager. |
java.util.List |
accessLinks()
accessLinks Access links transient cache collection for use by PageManager. |
java.util.List |
accessPages()
accessPages Access pages transient cache collection for use by PageManager. |
PageSecurityImpl |
accessPageSecurity()
accessPageSecurity Access pageSecurity cached instance for use by PageManager. |
void |
checkPermissions(java.lang.String path,
int mask,
boolean checkNodeOnly,
boolean checkParentsOnly)
checkPermissions |
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 |
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 |
NodeSet |
getFolders()
getFolders |
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 |
PageManager |
getPageManager()
|
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 |
java.lang.String |
getSkin()
Returns the name of the skin that applies to this folder. |
java.lang.String |
getTitle()
Returns the title in the default Locale |
java.lang.String |
getType()
getType |
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 |
PageMetadataImpl |
newPageMetadata(java.util.Collection fields)
newPageMetadata Construct page manager specific metadata implementation. |
void |
resetAll(boolean cached)
resetAll Reset all transient caches for use by PageManager. |
void |
resetFolders(boolean cached)
resetFolders Reset folders transient caches for use by PageManager. |
void |
resetLinks(boolean cached)
resetLinks Reset links transient caches for use by PageManager. |
void |
resetPages(boolean cached)
resetPages Reset pages transient caches for use by PageManager. |
void |
resetPageSecurity(PageSecurityImpl newPageSecurity,
boolean cached)
resetPageSecurity Reset pageSecurity transient cache instance for use by PageManager. |
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 docNames)
setDocumentOrder |
void |
setMenuDefinitions(java.util.List definitions)
setMenuDefinitions - set list of menu definitions |
void |
setPageManager(PageManager pageManager)
setPageManager Infuses PageManager for use by this folder instance. |
void |
setSkin(java.lang.String skinName)
Modifies the skin for this folder. |
Methods inherited from class org.apache.jetspeed.page.document.impl.NodeImpl |
---|
checkConstraints, defaultTitleFromName, getCanonicalNodePath, getLogicalPermissionPath, getMetadata, getName, getPageMetadata, getParent, getPath, getPhysicalPermissionPath, getShortTitle, getTitle, getUrl, isHidden, setHidden, setName, setParent, setPath |
Methods inherited from class org.apache.jetspeed.om.page.impl.BaseElementImpl |
---|
checkAccess, checkConstraints, checkPermissions, checkPermissions, equals, getConstraintsEnabled, getId, getPermissionsEnabled, getSecurityConstraints, getShortTitle, grantViewActionAccess, hashCode, newSecurityConstraint, newSecurityConstraints, resetCachedSecurityConstraints, setConstraintsEnabled, setPermissionsEnabled, setSecurityConstraints, setShortTitle, setTitle |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.jetspeed.page.document.Node |
---|
getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getUrl, isHidden, setHidden, setParent, setPath |
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement |
---|
getId, getShortTitle, setShortTitle, setTitle |
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource |
---|
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints |
Constructor Detail |
---|
public FolderImpl()
Method Detail |
---|
public void setPageManager(PageManager pageManager)
pageManager
- page manager that manages this folder instancepublic java.util.List accessFolders()
public void resetFolders(boolean cached)
cached
- set cached state for folderspublic java.util.List accessPages()
public void resetPages(boolean cached)
cached
- set cached state for pagespublic java.util.List accessLinks()
public void resetLinks(boolean cached)
cached
- set cached state for linkspublic PageSecurityImpl accessPageSecurity()
public void resetPageSecurity(PageSecurityImpl newPageSecurity, boolean cached)
newPageSecurty
- cached page security instance.cached
- set cached state for page securitypublic java.util.List accessAll()
public void resetAll(boolean cached)
cached
- set cached state for allpublic PageMetadataImpl newPageMetadata(java.util.Collection fields)
NodeImpl
newPageMetadata
in class NodeImpl
fields
- mutable fields collection
public PageSecurity getEffectivePageSecurity()
BaseElementImpl
getEffectivePageSecurity
in class NodeImpl
public void checkPermissions(java.lang.String path, int mask, boolean checkNodeOnly, boolean checkParentsOnly) throws java.lang.SecurityException
BaseElementImpl
checkPermissions
in class NodeImpl
path
- permissions path to checkmask
- mask of actions to checkcheckNodeOnly
- check node scope onlycheckParentsOnly
- check parent folder scope only
java.lang.SecurityException
public java.lang.String getTitle()
BaseElement
getTitle
in interface BaseElement
getTitle
in class BaseElementImpl
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 docNames)
Folder
setDocumentOrder
in interface Folder
docNames
- 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() 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) throws FolderNotFoundException, DocumentException
Folder
getFolder
getFolder
in interface Folder
FolderNotFoundException
DocumentException
public NodeSet getPages() throws NodeException
Folder
getPages
getPages
in interface Folder
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() throws NodeException
Folder
getLinks
getLinks
in interface Folder
DocumentException
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() 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 java.util.List getMenuDefinitions()
Folder
getMenuDefinitions
in interface Folder
public MenuDefinition newMenuDefinition()
Folder
newMenuDefinition
in interface Folder
public MenuExcludeDefinition newMenuExcludeDefinition()
Folder
newMenuExcludeDefinition
in interface Folder
public MenuIncludeDefinition newMenuIncludeDefinition()
Folder
newMenuIncludeDefinition
in interface Folder
public MenuOptionsDefinition newMenuOptionsDefinition()
Folder
newMenuOptionsDefinition
in interface Folder
public MenuSeparatorDefinition newMenuSeparatorDefinition()
Folder
newMenuSeparatorDefinition
in interface Folder
public void setMenuDefinitions(java.util.List definitions)
Folder
setMenuDefinitions
in interface Folder
definitions
- definition listpublic boolean isReserved()
Folder
isReserved
in interface Folder
public int getReservedType()
Folder
getReservedType
in interface Folder
public java.lang.String getType()
Node
getType
getType
in interface Node
getType
in class NodeImpl
public PageManager getPageManager()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |