public class LdapSortKey
extends netscape.ldap.LDAPSortKey
Constructor and Description |
---|
LdapSortKey(java.lang.String keyDescription)
Constructs a new
LdapSortKey object that will
sort based on the specified instructions. |
LdapSortKey(java.lang.String key,
boolean reverse)
Constructs a new
LdapSortKey object that will
sort based on the specified attribute and sort order. |
LdapSortKey(java.lang.String key,
boolean reverse,
java.lang.String matchRule)
Constructs a new
LdapSortKey object that will
sort based on the specified attribute, sort order, and matching
rule. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getKey()
Returns the attribute to sort by.
|
java.lang.String |
getMatchRule()
Returns the object ID (OID) of the matching rule used for sorting.
|
boolean |
getReverse()
Returns
true if sorting is to be done in descending order. |
public LdapSortKey(java.lang.String keyDescription)
LdapSortKey
object that will
sort based on the specified instructions.keyDescription
- A single attribute specification to sort by.
If preceded by a hyphen ("-"), the attribute is sorted in reverse order.
You can also specify the object ID (OID) of a matching rule after
a colon (":"). For example:
"cn"
(sort by the cn
attribute)
"-cn"
(sort by the cn
attribute in
reverse order)
"-cn:1.2.3.4"
(sort by the cn
attribute in reverse order and use the matching rule identified
by the OID 1.2.3.4)
LdapSortControl
,
LdapVirtualListControl
public LdapSortKey(java.lang.String key, boolean reverse)
LdapSortKey
object that will
sort based on the specified attribute and sort order.key
- A single attribute to sort by. For example:
"cn"
(sort by the cn
attribute)
"givenname"
(sort by the givenname
attribute)
reverse
- If true
, the sorting is done in
descending order.LdapSortControl
,
LdapVirtualListControl
public LdapSortKey(java.lang.String key, boolean reverse, java.lang.String matchRule)
LdapSortKey
object that will
sort based on the specified attribute, sort order, and matching
rule.key
- A single attribute to sort by. For example:
"cn"
(sort by the cn
attribute)
"givenname"
(sort by the givenname
attribute)
reverse
- If true
, the sorting is done in
descending order.matchRule
- Object ID (OID) of the matching rule for
the attribute (for example, 1.2.3.4
).LdapSortControl
,
LdapVirtualListControl
public java.lang.String getKey()
getKey
in class netscape.ldap.LDAPSortKey
public boolean getReverse()
true
if sorting is to be done in descending order.getReverse
in class netscape.ldap.LDAPSortKey
true
if sorting is to be done in descending order.public java.lang.String getMatchRule()
null
is returned.getMatchRule
in class netscape.ldap.LDAPSortKey
null
if the sorting instructions specify no matching rule.