nl.gx.webmanager.cms.element
Interface PageCollectionElement

All Superinterfaces:

DelegatedControllerAware, Element, Presentable, Wrapper

public interface PageCollectionElement
extends Element

Collection of pages.

Method Summary

int	getAge() Return the value of the age filter in days.
java.util.Date	getDateFrom() Return the from date for the date filter.
java.util.Date	getDateTo() Return the to date for the date filter.
int	getMaxNumberOfResults() Returns the maximum number of results to be shown.
PageLabel[]	getPageLabels() Returns the labels by which to filter the pages that are shown
Page[]	getPages() Return array of Page.
int	getResultFrom() Returns the index of the first result to be shown
int	getResultTo() Returns the index of the last result to be shown
java.lang.String	getTitle() Return the title configured at the element.
Page	getTopPage() Returns the top page; the element displays a collection of its' child pages.
boolean	isFilterByAge() Indicates whether to filter by age.
boolean	isFilterByDate() Indicates whether to filter by date.
boolean	isFilterByLabel() Indicates whether to filter by label.
boolean	isSortByAgeAscending() Indicates whether to sort ascending by age.
boolean	isSortByDateAscending() Indicates whether to sort ascending by date.
boolean	isSortByLabelAscending() Indicates whether to sort ascending by label.
boolean	isUseMaxNumberOfResultsFilter() Indicates whether to limit the number of results to the configured maximum

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

getPages

Page[] getPages()

Return array of Page.

Returns:

array of Page.

getTitle

java.lang.String getTitle()

Return the title configured at the element.

Returns:

title

getAge

int getAge()

Return the value of the age filter in days.

Returns:

the value of the age filter in days or -1 if it isn't configured

getDateFrom

java.util.Date getDateFrom()

Return the from date for the date filter.

Returns:

the from date for the date filter

getDateTo

java.util.Date getDateTo()

Return the to date for the date filter.

Returns:

the to date for the date filter

isSortByAgeAscending

boolean isSortByAgeAscending()

Indicates whether to sort ascending by age.

Returns:

true if the element sorts ascending by age, false if it sorts descending

isSortByDateAscending

boolean isSortByDateAscending()

Indicates whether to sort ascending by date.

Returns:

true if the element sorts ascending by date, false if it sorts descending

isSortByLabelAscending

boolean isSortByLabelAscending()

Indicates whether to sort ascending by label.

Returns:

true if the element sort ascending by label, false if it sorts descending

getPageLabels

PageLabel[] getPageLabels()

Returns the labels by which to filter the pages that are shown

Returns:

an array of page collection labels

getMaxNumberOfResults

int getMaxNumberOfResults()

Returns the maximum number of results to be shown.

Returns:

the maximum number of results to be shown or -1 if it isn't configured.

getResultFrom

int getResultFrom()

Returns the index of the first result to be shown

Returns:

the index of the first result to be shown or -1 if it isn't configured.

getResultTo

int getResultTo()

Returns the index of the last result to be shown

Returns:

the index of the last result to be shown or -1 if it isn't configured.

getTopPage

Page getTopPage()

Returns the top page; the element displays a collection of its' child pages.

Returns:

the top page or null if it isn't configured

isFilterByAge

boolean isFilterByAge()

Indicates whether to filter by age.

Returns:

true if filtering by age is used, false otherwise

isFilterByDate

boolean isFilterByDate()

Indicates whether to filter by date.

Returns:

true if filtering by date is used, false otherwise

isFilterByLabel

boolean isFilterByLabel()

Indicates whether to filter by label.

Returns:

true if filtering by label is used, false otherwise

isUseMaxNumberOfResultsFilter

boolean isUseMaxNumberOfResultsFilter()

Indicates whether to limit the number of results to the configured maximum

Returns:

true if the number of results should be limited, false otherwise