com.unboundid.scim.sdk
Class GetResourcesRequest

java.lang.Object
  com.unboundid.scim.sdk.SCIMRequest
      com.unboundid.scim.sdk.ResourceReturningRequest
          com.unboundid.scim.sdk.GetResourcesRequest

public final class GetResourcesRequest
extends ResourceReturningRequest

This class represents a SCIM Get Resources request to retrieve selected resources.

Constructor Summary

GetResourcesRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, SCIMFilter filter, SortParameters sortParameters, PageParameters pageParameters, SCIMQueryAttributes attributes)
Create a new SCIM Get Resource request from the provided information.

Method Summary

SCIMFilter	getFilter() Retrieve the filter parameters of the request.
PageParameters	getPageParameters() Retrieve the pagination parameters of the request.
SortParameters	getSortParameters() Retrieve the sorting parameters of the request.

Methods inherited from class com.unboundid.scim.sdk.ResourceReturningRequest

getAttributes

Methods inherited from class com.unboundid.scim.sdk.SCIMRequest

getAuthenticatedUserID, getBaseURL, getResourceDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

GetResourcesRequest

public GetResourcesRequest(URI baseURL,
                           String authenticatedUserID,
                           ResourceDescriptor resourceDescriptor,
                           SCIMFilter filter,
                           SortParameters sortParameters,
                           PageParameters pageParameters,
                           SCIMQueryAttributes attributes)

Create a new SCIM Get Resource request from the provided information.

Parameters:

baseURL - The base URL for the SCIM service.

authenticatedUserID - The authenticated user name or null if the request is not authenticated.

resourceDescriptor - The ResourceDescriptor associated with this request.

filter - The filter parameters of the request.

sortParameters - The sorting parameters of the request.

pageParameters - The pagination parameters of the request.

attributes - The set of requested attributes.

Method Detail

getFilter

public SCIMFilter getFilter()

Retrieve the filter parameters of the request.

Returns:

The filter parameters of the request.

getSortParameters

public SortParameters getSortParameters()

Retrieve the sorting parameters of the request.

Returns:

The sorting parameters of the request.

getPageParameters

public PageParameters getPageParameters()

Retrieve the pagination parameters of the request.

Returns:

The pagination parameters of the request.