javax.naming.ldap

Class SortKey

Contents

  • public class SortKey
extends Object
    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.
    Since:
    1.5
    See Also:
    SortControl

    • Constructor Detail

      • SortKey

        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.

      • SortKey

        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 Detail

      • getAttributeID

        public String getAttributeID()
        Retrieves the attribute ID of the sort key.
        Returns:
        The non-null Attribute ID of the sort key.

      • isAscending

        public boolean isAscending()
        Determines the sort order.
        Returns:
        true if the sort order is ascending, false if descending.

      • getMatchingRuleID

        public String getMatchingRuleID()
        Retrieves the matching rule ID used to order the attribute values.
        Returns:
        The possibly null matching rule ID. If null then the ordering matching rule defined for the sort key attribute is used.

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/naming/ldap/sortkey.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut