Interface ISerializablePage<TResource extends Serializable>

Type Parameters:
TResource - type of serializable resource.
All Superinterfaces:
Serializable
All Known Subinterfaces:
IResourcePage<TResource>
All Known Implementing Classes:
AResourcePage, ASerializablePage, AuthenticatorResourcePage, AuthenticatorResourcePage, FormFileResourcePage, FormRecordAttachmentResourcePage, FormRecordChatResourcePage, FormRecordMessageResourcePage, FormRecordMessageUploadRequestResourcePage, FormRecordResourcePage, FormRecordStateHistoryEntryResourcePage, FormResourcePage, FormResourcePage, FormTagResourcePage, UserPortalFileResourcePage, UserPortalResourcePage, WorkflowTriggerResourcePage
public interface ISerializablePage<TResource extends Serializable> extends Serializable
Common interface for a page of serializables. A page is sub list of certain size (page size) of list that contains all serializables.
Since:
8.2.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getResults

      List<TResource> getResults()
      Returns:
      Paginated list of requested resources.

    • getResultCount

      int getResultCount()
      Returns:
      Number of resources in the paginated results list.

    • getPage

      int getPage()
      Returns:
      Current page number.

    • getPageSize

      int getPageSize()
      Returns:
      Number of resources per page.

    • getOffset

      int getOffset()
      Returns:
      Offset of the first resource in the results list.

    • getTotalCount

      Integer getTotalCount()
      Returns:
      Total number of resources. Is null/not present if not requested.

    • getTotalPages

      Integer getTotalPages()
      Returns:
      Total number of pages. Is null/not present if total count is not requested.

    • getLinks

      Map<String,String> getLinks()
      Returns:
      Links to other pages.