com.novell.ldap.controls
Class LDAPSortControl

java.lang.Object
  com.novell.ldap.LDAPControl
      com.novell.ldap.controls.LDAPSortControl

All Implemented Interfaces:

java.lang.Cloneable, java.io.Externalizable, java.io.Serializable

public class LDAPSortControl

extends LDAPControl

LDAPSortControl is a Server Control to specify how search results are to be sorted by the server. If a server does not support sorting in general or for a particular query, the results will be returned unsorted, along with a control indicating why they were not sorted (or that sort controls are not supported). If the control was marked "critical", the whole search operation will fail if the sort control is not supported.

Sample Code: AsyncSortControl.java

See Also:

Serialized Form

Constructor Summary

LDAPSortControl(LDAPSortKey[] keys, boolean critical)
Constructs a sort control with multiple sort keys.

LDAPSortControl(LDAPSortKey key, boolean critical)
Constructs a sort control with a single key.

Methods inherited from class com.novell.ldap.LDAPControl

clone, getID, getValue, isCritical, readDSML, readExternal, register, setValue, toString, writeDSML, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSortControl

public LDAPSortControl(LDAPSortKey key,
                       boolean critical)

Constructs a sort control with a single key.

Parameters:

key - A sort key object, which specifies attribute, order, and optional matching rule.

critical - True if the search operation is to fail if the server does not support this control.

LDAPSortControl

public LDAPSortControl(LDAPSortKey[] keys,
                       boolean critical)

Constructs a sort control with multiple sort keys.

Parameters:

keys - An array of sort key objects, to be processed in order.

critical - True if the search operation is to fail if the server does not support this control.