|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.ietf.ldap.controls.LDAPSortKey
Encapsulates parameters for sorting search results.
Sample Code: AsyncSortControl.java
Constructor Summary | |
LDAPSortKey(java.lang.String keyDescription)
Constructs a new LDAPSortKey object using an attribute as the sort key. |
|
LDAPSortKey(java.lang.String key,
boolean reverse)
Constructs a new LDAPSortKey object with the specified attribute name and sort order. |
|
LDAPSortKey(java.lang.String key,
boolean reverse,
java.lang.String matchRule)
Constructs a new LDAPSortKey object with the specified attribute name, sort order, and a matching rule. |
Method Summary | |
java.lang.String |
getKey()
Returns the attribute to used for sorting. |
java.lang.String |
getMatchRule()
Returns the OID to be used as a matching rule. |
boolean |
getReverse()
Returns the sorting order, ascending or descending. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public LDAPSortKey(java.lang.String keyDescription)
keyDescription
- The single attribute to use for sorting. If the
name is preceded by a minus sign (-), the sorting
is done in reverse (descending) order.
An OID for a matching rule may be appended
following a ":".
public LDAPSortKey(java.lang.String key, boolean reverse)
key
- The single attribute to use for sorting.
reverse
- If true, sorting is done in descending order. If false,
sorting is done in ascending order.public LDAPSortKey(java.lang.String key, boolean reverse, java.lang.String matchRule)
key
- The attribute name (for example, "cn") to use for sorting.
reverse
- If true, sorting is done in descending order. If false,
sorting is done in ascending order.
matchRule
- The object ID (OID) of a matching rule used for
collation. If the object will be used to request
server-side sorting of search results, it should
be the OID of a matching rule known to be
supported by that server.Method Detail |
public java.lang.String getKey()
public boolean getReverse()
public java.lang.String getMatchRule()
|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |