com.atlassian.idp.model

Class ScimSearchRequest

java.lang.Object

com.atlassian.idp.model.ScimSearchRequest

Direct Known Subclasses:

ImmutableScimSearchRequest

@Value.Immutable
public abstract class ScimSearchRequest
extends Object

Scim query request used for Querying Resources Using HTTP POST.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEMA

Constructor Summary

Constructors

Constructor and Description
ScimSearchRequest()

Method Summary

Modifier and Type	Method and Description
abstract List<String>	getAttributes()
abstract Integer	getCount() Specifies the desired maximum number of query results per page, e.g., 10.
abstract List<String>	getExcludedAttributes()
abstract String	getFilter()
List<String>	getSchemas()
abstract String	getSortBy()
abstract ScimSortOrder	getSortOrder()
abstract Integer	getStartIndex() The 1-based index of the first query result.
protected ScimSearchRequest	normalizeCount()
protected ScimSearchRequest	normalizeStartIndex()
boolean	shouldHideResources() A count of "0" indicates that no resource results are to be returned except for "totalResults".

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA

public static final String SCHEMA

See Also:

Constant Field Values

Constructor Detail

ScimSearchRequest

public ScimSearchRequest()

Method Detail

getSchemas

@Value.Default
public List<String> getSchemas()

Returns:

the schemas used in this search request

getAttributes

@Nullable
public abstract List<String> getAttributes()

Returns:

the names of resource attributes to return in the response.

getExcludedAttributes

@Nullable
public abstract List<String> getExcludedAttributes()

Returns:

the names of resource attributes to be removed from the default set of attributes to return.

getFilter

@Nullable
public abstract String getFilter()

Returns:

The filter string used to request a subset of resources.

getSortBy

@Nullable
public abstract String getSortBy()

Returns:

A string indicating the attribute whose value SHALL be used to order the returned responses.

getSortOrder

@Nullable
public abstract ScimSortOrder getSortOrder()

Returns:

the order in which the "sortBy" parameter is applied. Allowed values are "ascending" and "descending".

getStartIndex

@Nullable
public abstract Integer getStartIndex()

The 1-based index of the first query result.

A value less than 1 will be interpreted as 1.

Returns:

the 1-based index of the first query result.

normalizeStartIndex

@Value.Check
protected ScimSearchRequest normalizeStartIndex()

getCount

@Nullable
public abstract Integer getCount()

Specifies the desired maximum number of query results per page, e.g., 10.

A negative value will be interpreted as "0". A value of "0" indicates that no resource results are to be returned except for "totalResults".

Returns:

the desired maximum number of query results per page.

normalizeCount

@Value.Check
protected ScimSearchRequest normalizeCount()

shouldHideResources

@Value.Derived
public boolean shouldHideResources()

A count of "0" indicates that no resource results are to be returned except for "totalResults".

Returns:

true if getCount() ()} returns 0