nl.gx.webmanager.cms.element
Interface DirectoryElement

All Superinterfaces:

DelegatedControllerAware, Element, Presentable, Wrapper

public interface DirectoryElement
extends Element

Interface for the directory element.

Method Summary

java.lang.String	getDirectory() Returns the name of the directory (on disk) the element should show.
java.lang.String[]	getDocumentExtensions() Returns an array of Strings containing all valid filename extensions for this directory.
java.util.Date	getFromDate() Returns the from Date.
java.lang.String	getMimeType() Returns the mime type of the directory.
java.lang.String	getMimeTypeName() Returns a descriptive name for the mime type.
FileNode	getRootNode() Returns the DirectoryElementNode representing the root of the directory.
java.util.Date	getToDate() Returns the to Date.
boolean	isAllowSubdir() Returns whether the directory element is allowed to open subdirectories.
boolean	isIndexDocuments() Returns whether documents should be indexed or not.

Methods inherited from interface nl.gx.webmanager.cms.element.Element

cleanup, copy, getEditElementHeader, getElementHolder, getHeader, getIcon, getMediaItemVersion, getPageModel, getPageModelElement, getPageVersion, getPersonalization, getWebsite, isAuthorized, setAuthorized, setDefaultPresentation, setEditElementHeader, setHeader, setIcon, setPersonalization

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Methods inherited from interface nl.gx.webmanager.springmvc.DelegatedControllerAware

getDelegatedController, setDelegatedController

Method Detail

getMimeType

java.lang.String getMimeType()

Returns the mime type of the directory.

Returns:

the mime type

getMimeTypeName

java.lang.String getMimeTypeName()

Returns a descriptive name for the mime type.

Returns:

a descriptive name for the mime type

getDocumentExtensions

java.lang.String[] getDocumentExtensions()

Returns an array of Strings containing all valid filename extensions for this directory.

Returns:

an array containing all valid filename extensions

isAllowSubdir

boolean isAllowSubdir()

Returns whether the directory element is allowed to open subdirectories.

Returns:

whether the directory element is allowed to open subdirectories

getDirectory

java.lang.String getDirectory()

Returns the name of the directory (on disk) the element should show.

Returns:

the name of the directory on disk

isIndexDocuments

boolean isIndexDocuments()

Returns whether documents should be indexed or not.

Returns:

true when documents may be indexed.

getFromDate

java.util.Date getFromDate()

Returns the from Date.

Returns:

the from Date

getToDate

java.util.Date getToDate()

Returns the to Date.

Returns:

the to Date

getRootNode

FileNode getRootNode()

Returns the DirectoryElementNode representing the root of the directory. Only files are included that have a last modified date between the to and from dates (unless those dates are null) and an extension that is in the list of allowed extensions. If indexDocuments is false, no documents will be indexed and if allowSubdir is false, no subdirectories will be indexed. Null may be returned if even the root-directory is does not match these requirements.

Returns:

the DirectoryElementNode representing the root of the directory.