Package org.ldaptive.control
Class SortKey
- java.lang.Object
-
- org.ldaptive.control.SortKey
-
public class SortKey extends java.lang.Object
Used bySortRequestControl
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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.lang.String
getAttributeDescription()
Returns the attribute description.java.lang.String
getMatchingRuleId()
Returns the matching rule id.boolean
getReverseOrder()
Returns whether results should be in reverse sorted order.int
hashCode()
void
setAttributeDescription(java.lang.String s)
Sets the attribute description.void
setMatchingRuleId(java.lang.String s)
Sets the matching rule id.void
setReverseOrder(boolean b)
Sets whether results should be in reverse sorted order.java.lang.String
toString()
-
-
-
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 descriptionruleId
- matching rule id
-
SortKey
public SortKey(java.lang.String attrDescription, java.lang.String ruleId, boolean reverse)
Creates a new sort key.- Parameters:
attrDescription
- attribute descriptionruleId
- matching rule idreverse
- 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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-