com.unboundid.scim.sdk

Class PageParameters

java.lang.Object

com.unboundid.scim.sdk.PageParameters

public final class PageParameters
extends Object

This class represents the pagination parameters in a SCIM request.

Constructor Summary

Constructors

Constructor and Description
PageParameters(int startIndex, int count) Create a new instance of pagination parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCount() Retrieve the maximum number of resources to return in a single page, or zero if the server should choose how many to return.
int	getStartIndex() Retrieve the offset of the first resource to be returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageParameters

public PageParameters(int startIndex,
              int count)

Create a new instance of pagination parameters.

Parameters:

startIndex - The offset of the first resource to be returned.

count - The maximum number of resources to return in a single page, or zero if the server should choose how many to return.

Method Detail

getStartIndex

public int getStartIndex()

Retrieve the offset of the first resource to be returned.

Returns:

The offset of the first resource to be returned.

getCount

public int getCount()

Retrieve the maximum number of resources to return in a single page, or zero if the server should choose how many to return.

Returns:

The maximum number of resources to return in a single page, or zero if the server should choose how many to return.