Package com.ibm.wsspi.security.wim.model

Class SortControl

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
com.ibm.wsspi.security.wim.model.SortControl
public class SortControl extends Control

Java class for SortControl complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="SortControl">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Control">
 <sequence>
 <element name="sortKeys" type="{http://www.ibm.com/websphere/wim}SortKeyType" maxOccurs="unbounded" minOccurs="0"/>
 <element name="locale" type="{http://www.w3.org/2001/XMLSchema}language"/>
 </sequence>
 </extension>
 </complexContent>
 </complexType>

The SortControl object extends the Control object and defines two properties:

  • sortKeys: contains a list of attributes will be used to do the sorting. For each attribute a sorting order can be specified by the ascendingOrder property in the SortKey object. For example, a caller wants to sort the search results by 'sn' in descending order. The caller needs to set the ascendingOrder property to false. The properties included in the SortControl object must be listed in the property list of the SearchControl.
  • locale: indicates which language will be used during the sorting operation.

  • Constructor Details

    • SortControl

      public SortControl()

  • Method Details

    • getSortKeys

      public List<SortKeyType> getSortKeys()
      Gets the value of the sortKeys property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sortKeys property.

      For example, to add a new item, do as follows: 

       getSortKeys().add(newItem);

      Objects of the following type(s) are allowed in the list SortKeyType

    • isSetSortKeys

      public boolean isSetSortKeys()

    • unsetSortKeys

      public void unsetSortKeys()

    • getLocale

      public String getLocale()
      Gets the value of the locale property.
      Returns:
      possible object is String

    • setLocale

      public void setLocale(String value)
      Sets the value of the locale property.
      Parameters:
      value - allowed object is String

    • isSetLocale

      public boolean isSetLocale()

    • get

      public Object get(String propName)
      Description copied from class: Control
      Gets the value of the requested property
      Overrides:
      get in class Control
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is Object

    • isSet

      public boolean isSet(String propName)
      Description copied from class: Control
      Returns true if the requested property is set; false, otherwise.
      Overrides:
      isSet in class Control
      Returns:
      returned object is boolean

    • set

      public void set(String propName, Object value)
      Description copied from class: Control
      Sets the value of the provided property to the provided value.
      Overrides:
      set in class Control
      Parameters:
      propName - allowed object is String
      value - allowed object is Object

    • unset

      public void unset(String propName)
      Description copied from class: Control
      Sets the value of provided property to null.
      Overrides:
      unset in class Control
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Description copied from class: Control
      Gets the name of this model object, Control
      Overrides:
      getTypeName in class Control
      Returns:
      returned object is String

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)

    • getDataType

      public String getDataType(String propName)
      Description copied from class: Control
      Gets the Java type of the value of the provided property. For example: String, List
      Overrides:
      getDataType in class Control
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is String

    • getSuperTypes

      public ArrayList getSuperTypes()
      Description copied from class: Control
      Gets a list of any model objects which this model object, Control, is an extension of.
      Overrides:
      getSuperTypes in class Control
      Returns:
      returned object is ArrayList

    • isSubType

      public boolean isSubType(String superTypeName)
      Description copied from class: Control
      Returns a true if the provided model object is one that this model object extends; false, otherwise.
      Overrides:
      isSubType in class Control
      Parameters:
      superTypeName - allowed object is String
      Returns:
      returned object is boolean

    • getSubTypes

      public static HashSet getSubTypes()

    • toString

      public String toString()
      Description copied from class: Control
      Returns this model object, Control, and its contents as a String
      Overrides:
      toString in class Control
      Returns:
      returned object is String