Package de.captaingoldfish.scim.sdk.common.request

Class SearchRequest

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializable.Base

com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.node.BaseJsonNode

com.fasterxml.jackson.databind.node.ContainerNode<com.fasterxml.jackson.databind.node.ObjectNode>

com.fasterxml.jackson.databind.node.ObjectNode

de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

de.captaingoldfish.scim.sdk.common.resources.AbstractSchemasHolder

de.captaingoldfish.scim.sdk.common.request.SearchRequest

All Implemented Interfaces:

com.fasterxml.jackson.core.TreeNode, com.fasterxml.jackson.databind.JsonSerializable, com.fasterxml.jackson.databind.node.JsonNodeCreator, ScimNode, Serializable, Iterable<com.fasterxml.jackson.databind.JsonNode>

public class SearchRequest
extends AbstractSchemasHolder

author Pascal Knueppel
created at: 18.10.2019 - 18:39

represents a search request that is used on .search requests

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchRequest.SearchRequestBuilder	override lombok builder with public constructor

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.JsonNode.OverwriteMode

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.node.ObjectNode

_children

Fields inherited from class com.fasterxml.jackson.databind.node.ContainerNode

_nodeFactory

Constructor Summary

Constructors

Constructor	Description
SearchRequest()
SearchRequest(Long startIndex, Integer count, String filter, String sortBy, SortOrder sortOrder, String attributes, String excludedAttributes)

Method Summary

Modifier and Type	Method	Description
static SearchRequest.SearchRequestBuilder	builder()
Optional<String>	getAttributes()	A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default.
Optional<Integer>	getCount()	An integer indicating the desired maximum number of query results per page.
Optional<String>	getExcludedAttributes()	A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return.
Optional<String>	getFilter()	The filter string used to request a subset of resources.
Optional<String>	getSortBy()	A string indicating the attribute whose value SHALL be used to order the returned responses.
Optional<String>	getSortOrder()	A string indicating the order in which the "sortBy" parameter is applied.
Optional<Long>	getStartIndex()	An integer indicating the 1-based index of the first query result.
void	setAttributes(String attributes)	A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default.
void	setCount(Integer count)	An integer indicating the desired maximum number of query results per page.
void	setExcludedAttributes(String excludedAttributes)	A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return.
void	setFilter(String filter)	The filter string used to request a subset of resources.
void	setSortBy(String sortBy)	A string indicating the attribute whose value SHALL be used to order the returned responses.
void	setSortOrder(SortOrder sortOrder)	A string indicating the order in which the "sortBy" parameter is applied.
void	setStartIndex(Long startIndex)	An integer indicating the 1-based index of the first query result.

Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.AbstractSchemasHolder

addSchema, getSchemas, removeSchema, setSchemas, setSchemas

Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

addAttribute, getArrayAttribute, getBinaryAttribute, getBooleanAttribute, getDateTimeAttribute, getDoubleAttribute, getIntegerAttribute, getLongAttribute, getObjectAttribute, getSchemaAttribute, getSimpleArrayAttribute, getSimpleArrayAttribute, getSimpleArrayAttributeSet, getSimpleArrayAttributeSet, getStringAttribute, getStringAttribute, isEmpty, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeList, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setStringAttributeList, setStringAttributeList, toPrettyString, toString

Methods inherited from class com.fasterxml.jackson.databind.node.ObjectNode

_at, _childrenEqual, _put, _withArray, _withArrayAddTailProperty, _withObject, _withObjectAddTailProperty, asToken, deepCopy, elements, equals, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, get, get, getNodeType, hashCode, isEmpty, isObject, path, path, properties, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAll, putArray, putIfAbsent, putNull, putObject, putPOJO, putRawValue, remove, remove, removeAll, replace, required, retain, retain, serialize, serializeFilteredContents, serializeWithType, set, setAll, setAll, size, with, withArray, without, without

Methods inherited from class com.fasterxml.jackson.databind.node.ContainerNode

arrayNode, arrayNode, asText, binaryNode, binaryNode, booleanNode, missingNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, rawValueNode, textNode

Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode

_bigIntFromBigDec, _jsonPointerIfValid, _reportWrongNodeOperation, _reportWrongNodeType, _withXxxMayReplace, _withXxxVerifyReplace, findPath, numberType, required, traverse, traverse, withArray, withObject

Methods inherited from class com.fasterxml.jackson.databind.JsonNode

_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, canConvertToInt, canConvertToLong, decimalValue, doubleValue, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, withArray, withArray, withObject, withObject, withObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface de.captaingoldfish.scim.sdk.common.resources.base.ScimNode

getAttributeDescription, getAttributeName, getCanonicalValues, getMutability, getReferenceTypes, getReturned, getScimNodeName, getUniqueness, getValueType, isCaseExact, isMultiValued, isRequired

Constructor Details

SearchRequest

public SearchRequest()

SearchRequest

public SearchRequest(Long startIndex,
 Integer count,
 String filter,
 String sortBy,
 SortOrder sortOrder,
 String attributes,
 String excludedAttributes)

Method Details

getStartIndex

public Optional<Long> getStartIndex()

An integer indicating the 1-based index of the first query result. See Section 3.4.2.4. OPTIONAL.

setStartIndex

public void setStartIndex(Long startIndex)

An integer indicating the 1-based index of the first query result. See Section 3.4.2.4. OPTIONAL.

getCount

public Optional<Integer> getCount()

An integer indicating the desired maximum number of query results per page. See Section 3.4.2.4. OPTIONAL.

setCount

public void setCount(Integer count)

An integer indicating the desired maximum number of query results per page. See Section 3.4.2.4. OPTIONAL.

getFilter

public Optional<String> getFilter()

The filter string used to request a subset of resources. The filter string MUST be a valid filter (Section 3.4.2.2) expression. OPTIONAL.

setFilter

public void setFilter(String filter)

The filter string used to request a subset of resources. The filter string MUST be a valid filter (Section 3.4.2.2) expression. OPTIONAL.

getSortBy

public Optional<String> getSortBy()

A string indicating the attribute whose value SHALL be used to order the returned responses. The "sortBy" attribute MUST be in standard attribute notation (Section 3.10) form. See Section 3.4.2.3. OPTIONAL.

setSortBy

public void setSortBy(String sortBy)

A string indicating the attribute whose value SHALL be used to order the returned responses. The "sortBy" attribute MUST be in standard attribute notation (Section 3.10) form. See Section 3.4.2.3. OPTIONAL.

getSortOrder

public Optional<String> getSortOrder()

A string indicating the order in which the "sortBy" parameter is applied. Allowed values are "ascending" and "descending". See Section 3.4.2.3. OPTIONAL.

setSortOrder

public void setSortOrder(SortOrder sortOrder)

A string indicating the order in which the "sortBy" parameter is applied. Allowed values are "ascending" and "descending". See Section 3.4.2.3. OPTIONAL.

getAttributes

public Optional<String> getAttributes()

A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See Section 3.9 for additional retrieval query parameters. OPTIONAL.

setAttributes

public void setAttributes(String attributes)

A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See Section 3.9 for additional retrieval query parameters. OPTIONAL.

getExcludedAttributes

public Optional<String> getExcludedAttributes()

A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. This parameter SHALL have no effect on attributes whose schema "returned" setting is "always" (see Sections 2.2 and 7 of [RFC7643]). Attribute names MUST be in standard attribute notation (Section 3.10) form. See Section 3.9 for additional retrieval query parameters. OPTIONAL.

setExcludedAttributes

public void setExcludedAttributes(String excludedAttributes)

A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. This parameter SHALL have no effect on attributes whose schema "returned" setting is "always" (see Sections 2.2 and 7 of [RFC7643]). Attribute names MUST be in standard attribute notation (Section 3.10) form. See Section 3.9 for additional retrieval query parameters. OPTIONAL.

builder

public static SearchRequest.SearchRequestBuilder builder()