Class SortKey


  • public class SortKey
    extends java.lang.Object
    Used by SortRequestControl to declare how sorting should occur. See RFC 3698 for the definition of matchingRuleId.
    Author:
    Middleware Services
    • Constructor Summary

      Constructors 
      Constructor Description
      SortKey()
      Default constructor.
      SortKey​(java.lang.String attrDescription)
      Creates a new sort key.
      SortKey​(java.lang.String attrDescription, java.lang.String ruleId)
      Creates a new sort key.
      SortKey​(java.lang.String attrDescription, java.lang.String ruleId, boolean reverse)
      Creates a new sort key.
    • Constructor Detail

      • SortKey

        public SortKey()
        Default constructor.
      • SortKey

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

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

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

      • getAttributeDescription

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

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

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

        public void setMatchingRuleId​(java.lang.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
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object