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 SummaryConstructors Constructor Description SortControl()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectget(java.lang.String propName)Gets the value of the requested propertyjava.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.java.lang.StringgetLocale()Gets the value of the locale property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)java.util.List<SortKeyType>getSortKeys()Gets the value of the sortKeys property.static java.util.HashSetgetSubTypes()java.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, Control, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, ControlbooleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSetLocale()booleanisSetSortKeys()booleanisSubType(java.lang.String superTypeName)Returns a true if the provided model object is one that this model object extends; false, otherwise.voidset(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.voidsetLocale(java.lang.String value)Sets the value of the locale property.java.lang.StringtoString()Returns this model object, Control, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of provided property to null.voidunsetSortKeys()
 
- 
- 
- 
Method Detail- 
getSortKeyspublic java.util.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 setmethod 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
 - 
isSetSortKeyspublic boolean isSetSortKeys() 
 - 
unsetSortKeyspublic void unsetSortKeys() 
 - 
getLocalepublic java.lang.String getLocale() Gets the value of the locale property.- Returns:
- possible object is String
 
 - 
setLocalepublic void setLocale(java.lang.String value) Sets the value of the locale property.- Parameters:
- value- allowed object is- String
 
 - 
isSetLocalepublic boolean isSetLocale() 
 - 
getpublic java.lang.Object get(java.lang.String propName) Description copied from class:ControlGets the value of the requested property
 - 
isSetpublic boolean isSet(java.lang.String propName) Description copied from class:ControlReturns true if the requested property is set; false, otherwise.
 - 
setpublic void set(java.lang.String propName, java.lang.Object value)Description copied from class:ControlSets the value of the provided property to the provided value.
 - 
unsetpublic void unset(java.lang.String propName) Description copied from class:ControlSets the value of provided property to null.
 - 
getTypeNamepublic java.lang.String getTypeName() Description copied from class:ControlGets the name of this model object, Control- Overrides:
- getTypeNamein class- Control
- Returns:
- returned object is String
 
 - 
getPropertyNamespublic static java.util.List getPropertyNames(java.lang.String entityTypeName) 
 - 
getDataTypepublic java.lang.String getDataType(java.lang.String propName) Description copied from class:ControlGets the Java type of the value of the provided property. For example: String, List- Overrides:
- getDataTypein class- Control
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is String
 
 - 
getSuperTypespublic java.util.ArrayList getSuperTypes() Description copied from class:ControlGets a list of any model objects which this model object, Control, is an extension of.- Overrides:
- getSuperTypesin class- Control
- Returns:
- returned object is ArrayList
 
 - 
isSubTypepublic boolean isSubType(java.lang.String superTypeName) Description copied from class:ControlReturns a true if the provided model object is one that this model object extends; false, otherwise.
 - 
getSubTypespublic static java.util.HashSet getSubTypes() 
 
- 
 
-