Home » openjdk-7 » javax » naming » ldap » [javadoc | source]
javax.naming.ldap
public class: SortKey [javadoc | source]
java.lang.Object
   javax.naming.ldap.SortKey
A sort key and its associated sort parameters. This class implements a sort key which is used by the LDAPv3 Control for server-side sorting of search results as defined in RFC 2891.
Constructor:
 public SortKey(String attrID) 
    Creates the default sort key for an attribute. Entries will be sorted according to the specified attribute in ascending order using the ordering matching rule defined for use with that attribute.
    Parameters:
    attrID - The non-null ID of the attribute to be used as a sort key.
 public SortKey(String attrID,
    boolean ascendingOrder,
    String matchingRuleID) 
    Creates a sort key for an attribute. Entries will be sorted according to the specified attribute in the specified sort order and using the specified matching rule, if supplied.
    Parameters:
    attrID - The non-null ID of the attribute to be used as a sort key.
    ascendingOrder - If true then entries are arranged in ascending order. Otherwise there are arranged in descending order.
    matchingRuleID - The possibly null ID of the matching rule to use to order the attribute values. If not specified then the ordering matching rule defined for the sort key attribute is used.
Method from javax.naming.ldap.SortKey Summary:
getAttributeID,   getMatchingRuleID,   isAscending
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.naming.ldap.SortKey Detail:
 public String getAttributeID() 
    Retrieves the attribute ID of the sort key.
 public String getMatchingRuleID() 
    Retrieves the matching rule ID used to order the attribute values.
 public boolean isAscending() 
    Determines the sort order.