org.osiam.resources.scim

Class SCIMSearchResult<T>

java.lang.Object

org.osiam.resources.scim.SCIMSearchResult<T>

Type Parameters:

T - User or Group

public class SCIMSearchResult<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

Constructor Summary

Constructors

Constructor and Description
SCIMSearchResult(List<T> resources, long totalResults, long itemsPerPage, long startIndex, Set<String> schemas)
SCIMSearchResult(List<T> resources, long totalResults, long itemsPerPage, long startIndex, String schema)

Method Summary

Methods

Modifier and Type	Method and Description
long	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
long	getStartIndex() The 1-based index of the first result in the current set of list results.
long	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

Constructor Detail

SCIMSearchResult

public SCIMSearchResult(List<T> resources,
                long totalResults,
                long itemsPerPage,
                long startIndex,
                String schema)

SCIMSearchResult

public SCIMSearchResult(List<T> resources,
                long totalResults,
                long itemsPerPage,
                long startIndex,
                Set<String> schemas)

Method Detail

getResources

public List<T> getResources()

gets a list of found Users or Groups

Returns:

a list of found resources

getTotalResults

public long 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 long getItemsPerPage()

The number of Resources returned in a list response page.

Returns:

items per page

getStartIndex

public long getStartIndex()

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

Returns:

the start index of the actual page