public class ContentMultiPageParams extends MultiPageParams implements Iterable<Entity>
Modifier and Type | Class and Description |
---|---|
class |
ContentMultiPageParams.ContentPageParams
Specialized page parameters on records.
|
Modifier and Type | Field and Description |
---|---|
static String |
PARAMETER_CONTENT_ID
Content ID.
|
EMPTY_PAGE_PARAMS, FIRST_PAGE, SINGLE_PAGE_PARAMS
Constructor and Description |
---|
ContentMultiPageParams(Session session,
Select select,
int entitesPerPage,
int maxPageCount,
Date time)
Constructor based on some restrictions.
|
Modifier and Type | Method and Description |
---|---|
static void |
adjustTime(Select select,
Date time)
Adjusts the time constraint.
|
Entity |
get(int index)
Provides the record stored at the given indes.
|
EntityList |
getData()
Provides the records for output.
|
int |
getEntitiesPerPage()
Provides the number of records to put out per page.
|
int |
getPageCount()
Provides the number of pages that will be generated.
|
ContentMultiPageParams.ContentPageParams |
getPageParams(int index)
Provides the parameters stored for the given index.
|
PageParams |
getPageParams(Map<String,?> params)
Provides the parameters based on the given options.
|
String |
getType()
Provides the type of parameters.
|
Iterator<Entity> |
iterator()
Enables to iterate over the records retrieved via these parameters.
|
boolean |
renders(Map<String,?> params)
Renders a record identified by the given options.
|
boolean |
rendersEntityId(long entityId)
Will the entity with specified id be rendered by the multi page?
|
createDefault
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public static final String PARAMETER_CONTENT_ID
public ContentMultiPageParams(@NotNull Session session, @NotNull Select select, int entitesPerPage, int maxPageCount, @Nullable Date time)
session
- The session.select
- The select statement.entitesPerPage
- Records put out per page.maxPageCount
- The maximum number of pages to create.time
- A time constraint for records to look up.public static void adjustTime(Select select, Date time)
time
- The time constraint.public String getType()
getType
in class MultiPageParams
public int getEntitiesPerPage()
@NotNull public EntityList getData()
public int getPageCount()
getPageCount
in class MultiPageParams
public ContentMultiPageParams.ContentPageParams getPageParams(int index)
getPageParams
in class MultiPageParams
index
- The index.@NotNull public PageParams getPageParams(Map<String,?> params)
getPageParams
in class MultiPageParams
params
- A map of options.PARAMETER_CONTENT_ID
public boolean renders(Map<String,?> params)
params
- A map of options.PARAMETER_CONTENT_ID
public boolean rendersEntityId(long entityId)
public Iterator<Entity> iterator()
public Entity get(int index)
index
- The index.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210