All LDAP Classes
Internal LDAP Classes

com.novell.ldap.controls
Class LDAPSortControl

java.lang.Object
  extended by com.novell.ldap.LDAPControl
      extended by com.novell.ldap.controls.LDAPSortControl
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

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

Field Summary
private static int ORDERING_RULE
           
private static java.lang.String requestOID
          The requestOID of the sort control
private static java.lang.String responseOID
          The responseOID of the sort control
private static int REVERSE_ORDER
           
 
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.
 
Method Summary
 
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
 

Field Detail

ORDERING_RULE

private static int ORDERING_RULE

REVERSE_ORDER

private static int REVERSE_ORDER

requestOID

private static java.lang.String requestOID
The requestOID of the sort control


responseOID

private static java.lang.String responseOID
The responseOID of the sort control

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.

All LDAP Classes
Internal LDAP Classes

Copyright ? 2002 Novell, Inc. All Rights Reserved.
Novell, Inc.
1800 South Novell Place
Provo, Ut 84606
Phone: (801) 861-5000