com.unboundid.scim.sdk
Class SortParameters

java.lang.Object
  com.unboundid.scim.sdk.SortParameters

public final class SortParameters
extends Object

This class represents the sorting parameters in a SCIM request.

Constructor Summary

SortParameters(AttributePath sortBy, String sortOrder)
Create a new instance of sort parameters.

SortParameters(String sortBy, String sortOrder)
Create a new instance of sort parameters.

Method Summary

AttributePath	getSortBy() Retrieve the attribute or sub-attribute whose value is used to order the returned resources.
String	getSortOrder() Retrieve order in which the sortBy parameter is applied.
boolean	isAscendingOrder() Determine whether the sort order implies ascending or descending order.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortParameters

public SortParameters(String sortBy,
                      String sortOrder)

Create a new instance of sort parameters.

Parameters:

sortBy - The attribute or sub-attribute whose value is used to order the returned resources.

sortOrder - The order in which the sortBy parameter is applied. e.g. ascending or descending, or null if no sort order was specified.

SortParameters

public SortParameters(AttributePath sortBy,
                      String sortOrder)

Create a new instance of sort parameters.

Parameters:

sortBy - The attribute or sub-attribute whose value is used to order the returned resources.

sortOrder - The order in which the sortBy parameter is applied. e.g. ascending or descending, or null if no sort order was specified.

Method Detail

getSortBy

public AttributePath getSortBy()

Retrieve the attribute or sub-attribute whose value is used to order the returned resources.

Returns:

The attribute or sub-attribute whose value is used to order the returned resources.

getSortOrder

public String getSortOrder()

Retrieve order in which the sortBy parameter is applied. e.g. ascending or descending.

Returns:

The order in which the sortBy parameter is applied. e.g. ascending or descending.

isAscendingOrder

public boolean isAscendingOrder()

Determine whether the sort order implies ascending or descending order.

Returns:

true if the sort order implies ascending order.