C# Class Org.IdentityConnectors.Framework.Common.Objects.SortKey

A sort key which can be used to specify the order in which connector objects should be included in the results of a search request.

Since 1.4

Public Methods

Method	Description
AscendingOrder ( string field ) : SortKey	Creates a new ascending-order sort key for the provided field.
DescendingOrder ( string field ) : SortKey	Creates a new descending-order sort key for the provided field.
IsAscendingOrder ( ) : bool	Returns {@code true} if this sort key is in ascending order, or {@code false} if it is in descending order.
ReverseOrder ( SortKey key ) : SortKey	Creates a new sort key having the same field as the provided key, but in reverse sort order.
SortKey ( string field, bool isAscendingOrder ) : System

Creates a new ascending-order sort key for the provided field.

/// If {@code field} is not a valid attribute name. ///

public static AscendingOrder ( string field ) : SortKey
field	string	/// The sort key field. ///
return	SortKey

Creates a new descending-order sort key for the provided field.

/// If {@code field} is not a valid attribute name. ///

public static DescendingOrder ( string field ) : SortKey
field	string	/// The sort key field. ///
return	SortKey

Returns {@code true} if this sort key is in ascending order, or {@code false} if it is in descending order.

public IsAscendingOrder ( ) : bool
return	bool

Creates a new sort key having the same field as the provided key, but in reverse sort order.

public static ReverseOrder ( SortKey key ) : SortKey
key	SortKey	/// The sort key to be reversed. ///
return	SortKey

public SortKey ( string field, bool isAscendingOrder ) : System
field	string
isAscendingOrder	bool
return	System