public interface Content2Params extends StoreElement, MultiPageParamsProvider
Modifier and Type | Method and Description |
---|---|
void |
addOrdering(String columnName,
boolean ascending,
boolean languageDependent)
Adds an ordering to this parameters for the named column.
|
void |
clearOrdering()
Requests to clear all ordering for this parameters.
|
List<Entity> |
getData(Language language)
Provides all records for the given language.
|
List<Entity> |
getData(Language language,
int pageNumber)
Provides all records for the given language being rendered on the specified page number, where page counting
starts with
0 . |
List<Entity> |
getData(String languageAbbreviation)
Provides all records for the given language.
|
List<Entity> |
getData(String languageAbbreviation,
int pageNumber)
Provides all records for the given language being rendered on the specified page number, where page counting
starts with
0 . |
Page |
getEmptyPage()
Provides the empty page.
|
Map<String,Object> |
getFilterParams()
Returns an (unmodifyable) map containing the actual filter parameters.
|
int |
getMaxPageCount()
Provides the maximum number of pages to be generated.
|
MultiPageParams |
getMultiPageParams(Language language)
Provides the multi page parameters stored for the given language.
|
int |
getPageCount(Language language)
Provides the number of pages which will be created by the projection specified with this parameters for
the given language.
|
Query |
getQuery()
Provides the query used for fetching records.
|
int |
getRecordCountPerPage()
Provides the maximum number of records which is rendered on a each page, 0 is used when all records are
rendered on one page.
|
Select |
getSelect(Language language)
Provides the select statement for the given language to request records.
|
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()
Provides the table template for rendering records.
|
boolean |
hasChangedAfter(long timestamp)
Indicates whether this parameters have changed after the given time stamp.
|
boolean |
hasQuery()
Indicates whether this Content2Params has a query defined or not.
|
void |
setEmptyPage(Page value)
Defines the empty page.
|
void |
setFilterParams(Map<String,Object> params)
Defines filter parameters by the given map.
|
void |
setMaxPageCount(int value)
Defines the maximum number of pages to be generated.
|
void |
setQuery(Query value)
Defines the query to be used for fetching records.
|
void |
setRecordCountPerPage(int value)
Defines the maximum number of records to be rendered on each page.
|
void |
setSitemapVariableName(String value)
Defines the name for the sitemap variable.
|
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, getPreviousSibling, 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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
Page getEmptyPage()
void setEmptyPage(Page value)
value
- The empty page.int getRecordCountPerPage()
void setRecordCountPerPage(int value)
value
- 0, for all records on one page, above 0, to define the maximum.int getMaxPageCount()
void setMaxPageCount(int value)
value
- Greater or equal to 0.@Nullable String getSitemapVariableName()
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()
.
setSitemapVariableName(String)
void setSitemapVariableName(@Nullable String value)
value
- The variable's name.getSitemapVariableName()
@Nullable TableTemplate getTableTemplate()
null
.@Nullable Query getQuery()
null
.boolean hasQuery()
true
if a query is defined, false
otherwisegetQuery()
,
setQuery(Query)
void setQuery(Query value) throws IOException
value
- The query.IOException
List<Entity> getData(Language language)
language
- The language.List<Entity> getData(String languageAbbreviation)
languageAbbreviation
- The language abbreviation.List<Entity> getData(Language language, int pageNumber)
0
.language
- The language.pageNumber
- The page number.List<Entity> getData(String languageAbbreviation, int pageNumber)
0
.languageAbbreviation
- The language abbreviation.pageNumber
- The page number.int getPageCount(Language language)
language
- The language.boolean hasChangedAfter(long timestamp)
timestamp
- A time stamp.true
, if changed.void clearOrdering()
void addOrdering(@NotNull String columnName, boolean ascending, boolean languageDependent)
columnName
- The name of the column.ascending
- true
, for ascending order.languageDependent
- If to order language dependent.Map<String,Object> getFilterParams()
setFilterParams(java.util.Map)
void setFilterParams(Map<String,Object> params)
params
- A parameter map.getFilterParams()
@NotNull Select getSelect(@NotNull Language language)
language
- The language.@NotNull MultiPageParams getMultiPageParams(@NotNull Language language)
getMultiPageParams
in interface MultiPageParamsProvider
language
- The language.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210