MultiPageParams (FirstSpirit Access-API)

java.lang.Object

de.espirit.firstspirit.access.store.MultiPageParams

Direct Known Subclasses:: ContentMultiPageParams

public abstract class MultiPageParams extends Object

Since:: 4.0

Field Summary

Fields

Modifier and Type

Field

Description

static final MultiPageParams

EMPTY_PAGE_PARAMS

static final PageParams

FIRST_PAGE

static final MultiPageParams

SINGLE_PAGE_PARAMS
Constructor Summary

Constructors

Constructor

Description

MultiPageParams()
Method Summary

Modifier and Type

Method

Description

static MultiPageParams

createDefault(int count)

abstract int

getPageCount()

abstract PageParams

getPageParams(int index)

@NotNull PageParams

getPageParams(Map<String,?> params)

If the provided map contains the parameter "index" mapped to a number (or a string wich can be converted to a number) the PageParams for the corresponding index is returned.

abstract String

getType()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- EMPTY_PAGE_PARAMS
  
  public static final MultiPageParams EMPTY_PAGE_PARAMS
  
  Since:
  
  4.0.17
- SINGLE_PAGE_PARAMS
  
  public static final MultiPageParams SINGLE_PAGE_PARAMS
  
  Since:
  
  4.0.17
- FIRST_PAGE
  
  public static final PageParams FIRST_PAGE
  
  Since:
  
  4.1.27
Constructor Details
- MultiPageParams
  
  public MultiPageParams()
Method Details
- createDefault
  
  public static MultiPageParams createDefault(int count)
  
  Since:
  
  4.0
- getPageCount
  
  public abstract int getPageCount()
  
  Since:
  
  4.0
- getPageParams
  
  public abstract PageParams getPageParams(int index)
  
  Since:
  
  4.0
- getType
  
  public abstract String getType()
  
  Since:
  
  4.0
- getPageParams
  
  @NotNull public @NotNull PageParams getPageParams(Map<String,?> params)
  
  If the provided map contains the parameter "index" mapped to a number (or a string wich can be converted to a number) the PageParams for the corresponding index is returned. If this corresponding page is content projection page you can also provide the parameter "contentId" mapped to an entity id - this will provide the PageParams for the corresponding entity.
  
  Parameters:
  
  params -
  
  Returns:
  
  the PageParams object for the given params
  
  Since:
  
  4.0