Class SortKey


  • public class SortKey
    extends Object
    Used by SortRequestControl to declare how sorting should occur. See RFC 3698 for the definition of matchingRuleId.
    • Field Detail

      • HASH_CODE_SEED

        private static final int HASH_CODE_SEED
        hash code seed.
        See Also:
        Constant Field Values
      • attributeDescription

        private String attributeDescription
        attribute description.
      • matchingRuleId

        private String matchingRuleId
        matching rule id.
      • reverseOrder

        private boolean reverseOrder
        reverse order.
    • Constructor Detail

      • SortKey

        public SortKey()
        Default constructor.
      • SortKey

        public SortKey​(String attrDescription)
        Creates a new sort key.
        Parameters:
        attrDescription - attribute description
      • SortKey

        public SortKey​(String attrDescription,
                       String ruleId)
        Creates a new sort key.
        Parameters:
        attrDescription - attribute description
        ruleId - matching rule id
      • SortKey

        public SortKey​(String attrDescription,
                       String ruleId,
                       boolean reverse)
        Creates a new sort key.
        Parameters:
        attrDescription - attribute description
        ruleId - matching rule id
        reverse - reverse order
    • Method Detail

      • getAttributeDescription

        public String getAttributeDescription()
        Returns the attribute description.
        Returns:
        attribute description
      • setAttributeDescription

        public void setAttributeDescription​(String s)
        Sets the attribute description.
        Parameters:
        s - attribute description
      • getMatchingRuleId

        public String getMatchingRuleId()
        Returns the matching rule id.
        Returns:
        matching rule id
      • setMatchingRuleId

        public void setMatchingRuleId​(String s)
        Sets the matching rule id.
        Parameters:
        s - matching rule id
      • getReverseOrder

        public boolean getReverseOrder()
        Returns whether results should be in reverse sorted order.
        Returns:
        whether results should be in reverse sorted order
      • setReverseOrder

        public void setReverseOrder​(boolean b)
        Sets whether results should be in reverse sorted order.
        Parameters:
        b - whether results should be in reverse sorted order
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object