Package de.captaingoldfish.scim.sdk.common.response

Class ListResponse<T extends ScimObjectNode>

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.response.ScimResponse

de.captaingoldfish.scim.sdk.common.response.ListResponse<T>

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 ListResponse<T extends ScimObjectNode>
extends ScimResponse

author Pascal Knueppel
created at: 17.10.2019 - 22:04

represents a list response

See Also:

• Serialized Form

Nested Class Summary

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
ListResponse()
ListResponse(Class<T> type)
ListResponse(String resourceJsonRepresentation)
ListResponse(List<com.fasterxml.jackson.databind.JsonNode> listedResources, Long totalResults, Integer itemsPerPage, Long startIndex)

Method Summary

Modifier and Type	Method	Description
int	getHttpStatus()	the http status code of the response
int	getItemsPerPage()	Non-negative integer.
List<T>	getListedResources()	the resources that have been extracted
long	getStartIndex()	The 1-based index of the first result in the current set of query results, e.g., 1.
long	getTotalResults()	Non-negative integer.
void	setItemsPerPage(Integer itemsPerPage)	Non-negative integer.
void	setListedResources(List<com.fasterxml.jackson.databind.JsonNode> listedResources)	the resources that have been extracted
void	setStartIndex(Long startIndex)	The 1-based index of the first result in the current set of query results, e.g., 1.
void	setTotalResults(Long totalResults)	Non-negative integer.

Methods inherited from class de.captaingoldfish.scim.sdk.common.response.ScimResponse

buildJakartaResponse, buildResponse, getHttpHeaders, setETag

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, equals, 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, _contentsToSerialize, _put, _withArray, _withArrayAddTailProperty, _withObject, _withObjectAddTailProperty, asToken, deepCopy, elements, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, forEachEntry, get, get, getNodeType, hashCode, isEmpty, isObject, optional, path, path, properties, propertyStream, 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, removeIf, replace, required, retain, retain, serialize, serializeFilteredContents, serializeWithType, set, setAll, setAll, size, values, valueStream, with, withArray, withArrayProperty, withObject, withObjectProperty, 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, removeNulls, 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, asOptional, 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, optional, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, withArray, withArray, 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

ListResponse

public ListResponse()

ListResponse

public ListResponse(Class<T> type)

ListResponse

public ListResponse(String resourceJsonRepresentation)

ListResponse

public ListResponse(List<com.fasterxml.jackson.databind.JsonNode> listedResources,
 Long totalResults,
 Integer itemsPerPage,
 Long startIndex)

Method Details

getTotalResults

public long getTotalResults()

Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000

setTotalResults

public void setTotalResults(Long totalResults)

Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000

getItemsPerPage

public int getItemsPerPage()

Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000

setItemsPerPage

public void setItemsPerPage(Integer itemsPerPage)

Non-negative integer. Specifies the number of query results returned in a query response page, e.g., 10.

getStartIndex

public long getStartIndex()

The 1-based index of the first result in the current set of query results, e.g., 1.

setStartIndex

public void setStartIndex(Long startIndex)

The 1-based index of the first result in the current set of query results, e.g., 1.

getListedResources

public List<T> getListedResources()

the resources that have been extracted

setListedResources

public void setListedResources(List<com.fasterxml.jackson.databind.JsonNode> listedResources)

the resources that have been extracted

getHttpStatus

public int getHttpStatus()

the http status code of the response

Specified by:

getHttpStatus in class ScimResponse