com.sap.scimono.entity.paging

Class PagedByIndexSearchResult<T extends Resource<T>>

java.lang.Object

com.sap.scimono.entity.paging.PagedByIndexSearchResult<T>

Type Parameters:

T - User or Group

Direct Known Subclasses:

PagedByIdentitySearchResult

public class PagedByIndexSearchResult<T extends Resource<T>>
extends Object

A class that holds all information from a search request

For more detailed information please look at the SCIM core schema 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COUNT
static String	DEFAULT_START_INDEX

Constructor Summary

Constructors

Constructor and Description
PagedByIndexSearchResult(List<T> resources, int totalResults, int itemsPerPage, Integer startIndex)
PagedByIndexSearchResult(PagedResult<T> resources, Integer startIndex)

Method Summary

Modifier and Type	Method and Description
int	getItemsPerPage() The number of Resources returned in a list response page.
List<T>	getResources() gets a list of found Users or Groups
Set<String>	getSchemas() Gets the schemas of the search result
Integer	getStartIndex() The 1-based index of the first result in the current set of list results.
int	getTotalResults() The total number of results returned by the list or query operation.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_START_INDEX

public static final String DEFAULT_START_INDEX

See Also:

Constant Field Values

DEFAULT_COUNT

public static final String DEFAULT_COUNT

See Also:

Constant Field Values

Constructor Detail

PagedByIndexSearchResult

public PagedByIndexSearchResult(List<T> resources,
                                int totalResults,
                                int itemsPerPage,
                                Integer startIndex)

PagedByIndexSearchResult

public PagedByIndexSearchResult(PagedResult<T> resources,
                                Integer startIndex)

Method Detail

getResources

public List<T> getResources()

gets a list of found Users or Groups

Returns:

a list of found resources

getTotalResults

public int getTotalResults()

The total number of results returned by the list or query operation. This may not be equal to the number of elements in the Resources attribute of the list response if pagination is requested.

Returns:

the total result

getSchemas

public Set<String> getSchemas()

Gets the schemas of the search result

Returns:

the search result schemas

getItemsPerPage

public int getItemsPerPage()

The number of Resources returned in a list response page.

Returns:

items per page

getStartIndex

public Integer getStartIndex()

The 1-based index of the first result in the current set of list results.

Returns:

the start index of the actual page