SCIMMY: Class - SCIMMY.Messages.SearchRequest

Class: SCIMMY .Messages.SearchRequest

SCIM Search Request Message

Summary:

Encapsulates HTTP POST data as SCIM SearchRequest messages.

Provides a method to perform the search request against the declared or specified resource types.

Usage

Instantiate a new SCIM SearchRequest message from the supplied request

                    
                        new SCIMMY.Messages.SearchRequest(requestopt)

Since:: 1.0.0
Source:: src/lib/messages/searchrequest.js, line 13

Parameters:

Name Type Description


                        requestopt


    Object

contents of the SearchRequest received by the service provider

Properties

Name	Type	Description
`filteropt`	`String`	the filter to be applied on ingress/egress by implementing resource
`excludedAttributesopt`	`String[]`	the string list of attributes or filters to exclude on egress
`attributesopt`	`String[]`	the string list of attributes or filters to include on egress
`sortByopt`	`String`	the attribute retrieved resources should be sorted by
`sortOrderopt`	`String`	the direction retrieved resources should be sorted in
`startIndexopt`	`Number`	offset index that retrieved resources should start from
`countopt`	`Number`	maximum number of retrieved resources that should be returned in one operation

Properties:

Name	Type	Description
`filteropt`	`String`	the filter to be applied on ingress/egress by implementing resource
`excludedAttributesopt`	`String[]`	the string list of attributes or filters to exclude on egress
`attributesopt`	`String[]`	the string list of attributes or filters to include on egress
`sortByopt`	`String`	the attribute retrieved resources should be sorted by
`sortOrderopt`	`String`	the direction retrieved resources should be sorted in
`startIndexopt`	`Number`	offset index that retrieved resources should start from
`countopt`	`Number`	maximum number of retrieved resources that should be returned in one operation

Methods

prepare(paramsopt) → {SCIMMY.Messages.SearchRequest}

Prepare a new search request for transmission to a service provider

Source:: src/lib/messages/searchrequest.js, line 68

Parameters:

Name Type Description


                        paramsopt


    Object

details of the search request to be sent to a service provider

Properties

Name	Type	Description
`filteropt`	`String`	the filter to be applied on ingress/egress by implementing resource
`excludedAttributesopt`	`String[]`	the string list of attributes or filters to exclude on egress
`attributesopt`	`String[]`	the string list of attributes or filters to include on egress
`sortByopt`	`String`	the attribute retrieved resources should be sorted by
`sortOrderopt`	`String`	the direction retrieved resources should be sorted in
`startIndexopt`	`Number`	offset index that retrieved resources should start from
`countopt`	`Number`	maximum number of retrieved resources that should be returned in one operation

Returns:

this SearchRequest instance for chaining

Type:

{SCIMMY.Messages.SearchRequest}

(async) apply(resourceTypesopt, ctxopt) → {SCIMMY.Messages.ListResponse}

Apply a search request operation, retrieving results from specified resource types

Source:: src/lib/messages/searchrequest.js, line 111

Parameters:

Name	Type	Description
`resourceTypesopt`	`SCIMMY.Types.Resource[]`	resource type classes to be used while processing the search request, defaults to declared resources
`ctxopt`	`*`	any additional context information to pass to the egress handler

Returns:

a ListResponse message with results of the search request

Type:

{SCIMMY.Messages.ListResponse}