de.espirit.firstspirit.access.store.sitestore

Interface Content2Params

All Superinterfaces:

Comparable<StoreElement>, MultiPageParamsProvider, StoreElement, Workflowable

public interface Content2Params
extends StoreElement, MultiPageParamsProvider

Since:

3.0.114

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrdering(String columnName, boolean ascending, boolean languageDependent)
void	clearOrdering()
List<Entity>	getData(Language language)
List<Entity>	getData(Language language, int pageNumber)
List<Entity>	getData(String languageAbbreviation)
List<Entity>	getData(String languageAbbreviation, int pageNumber)
Page	getEmptyPage()
Map<String,Object>	getFilterParams() Returns an (unmodifyable) map containing the actual filter parameters.
int	getMaxPageCount()
MultiPageParams	getMultiPageParams(Language language)
int	getPageCount(Language language)
Query	getQuery()
int	getRecordCountPerPage()
Select	getSelect(Language language)
String	getSitemapVariableName() Returns the name of the variable which may be used in the sitemap for the embedding PageRef - may be null if the default label should be used.
TableTemplate	getTableTemplate()
boolean	hasChangedAfter(long timestamp)
boolean	hasQuery() Indicates whether this Content2Params has a query defined or not.
void	setEmptyPage(Page value)
void	setFilterParams(Map<String,Object> params)
void	setMaxPageCount(int value)
void	setQuery(Query value)
void	setRecordCountPerPage(int value)
void	setSitemapVariableName(String value)

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getParent, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getEmptyPage

Page getEmptyPage()

Since:

3.0.114

setEmptyPage

void setEmptyPage(Page value)

Since:

3.0.114

getRecordCountPerPage

int getRecordCountPerPage()

Returns:

the maximum number of records which is rendered on a each page, 0 is used when all records are rendered on one page

Since:

3.0.114

setRecordCountPerPage

void setRecordCountPerPage(int value)

Parameters:

value - must be >= 0, user 0 to render all records on one page

Since:

3.0.114

getMaxPageCount

int getMaxPageCount()

Returns:

the maximum number of generated pages, 0 is used for no restriction for the number of created pages

Since:

3.0.114

setMaxPageCount

void setMaxPageCount(int value)

Parameters:

value - must be >= 0, use 0 for no restriction on the number of created pages

Since:

3.0.114

getSitemapVariableName

@Nullable
String getSitemapVariableName()

Returns the name of the variable which may be used in the sitemap for the embedding PageRef - may be null if the default label should be used. The value is also used to as part of URLs in AdvancedUrlFactory.

The value could be a 'reference chain', i.e. a dot-delimited path following entity references (e.g. "category.name"). If language specific fields are stored with a trailing '*' instead of the language suffix (e.g. "name*" instead of "name_EN"), the value will be resolved language specific using GenerationContext.getLanguage().

Since:

3.0.114

See Also:

setSitemapVariableName(String)

setSitemapVariableName

void setSitemapVariableName(@Nullable
                          String value)

Since:

3.0.114

See Also:

getSitemapVariableName()

getTableTemplate

TableTemplate getTableTemplate()

Since:

3.0.114

getQuery

Query getQuery()

Since:

3.0.114

hasQuery

boolean hasQuery()

Indicates whether this Content2Params has a query defined or not.

Returns:

true if a query is defined, false otherwise

Since:

4.2.15

See Also:

getQuery(), setQuery(Query)

setQuery

void setQuery(Query value)
              throws IOException

Throws:

IOException

Since:

3.0.114

getData

List<Entity> getData(Language language)

Returns:

all content records for the specified language

Since:

3.0.114

getData

List<Entity> getData(String languageAbbreviation)

Returns:

all content records for the specified language

Since:

3.0.114

getData

List<Entity> getData(Language language,
                   int pageNumber)

Returns:

all content records for the specified language which are rendered on the specified page number (first page numer is 0).

Since:

3.0.114

getData

List<Entity> getData(String languageAbbreviation,
                   int pageNumber)

Returns:

all content records for the specified language which are rendered on the specified page number (first page numer is 0).

Since:

3.0.114

getPageCount

int getPageCount(Language language)

Returns:

the number of pages which will be created by the content projection specified by this content params and the given language

Since:

3.1.158

hasChangedAfter

boolean hasChangedAfter(long timestamp)

Since:

3.0.132

clearOrdering

void clearOrdering()

Since:

4.0.0

addOrdering

void addOrdering(@NotNull
               String columnName,
               boolean ascending,
               boolean languageDependent)

Since:

4.0.0

getFilterParams

Map<String,Object> getFilterParams()

Returns an (unmodifyable) map containing the actual filter parameters.

Since:

4.0.0

See Also:

setFilterParams(java.util.Map)

setFilterParams

void setFilterParams(Map<String,Object> params)

Since:

4.0.0

See Also:

getFilterParams()

getSelect

@NotNull
Select getSelect(@NotNull
                       Language language)

Since:

4.0

getMultiPageParams

@NotNull
MultiPageParams getMultiPageParams(@NotNull
                                         Language language)

Specified by:

getMultiPageParams in interface MultiPageParamsProvider

Since:

4.0