Class SearchControl
- java.lang.Object
- 
- com.ibm.wsspi.security.wim.model.Control
- 
- com.ibm.wsspi.security.wim.model.PropertyControl
- 
- com.ibm.wsspi.security.wim.model.SearchControl
 
 
 
- 
- Direct Known Subclasses:
- ChangeControl,- HierarchyControl,- LoginControl
 
 public class SearchControl extends PropertyControl Java class for SearchControl complex type. The following schema fragment specifies the expected content contained within this class. <complexType name="SearchControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}PropertyControl"> <sequence> <element name="searchBases" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/> </sequence> <attribute name="countLimit" type="{http://www.w3.org/2001/XMLSchema}int" default="0" /> <attribute name="searchLimit" type="{http://www.w3.org/2001/XMLSchema}int" default="0" /> <attribute name="timeLimit" type="{http://www.w3.org/2001/XMLSchema}int" default="0" /> <attribute name="expression" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="returnSubType" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" /> </extension> </complexContent> </complexType>The SearchControl object extends the PropertyControl object. It is possible to provide a list of the search bases to narrow down the search by specifying the searchBases property in the SearchControl. For example, 'ou=Mahwah, o=mycompany, c=us' could be specified in 'searchBases' to only search for users in the Mahwah division in the United States. - countLimit: used to specify the number of results to return from the search call. If the actual number of search results is more than the countLimit, the hasMoreResults property in the SearchResponseControl will be set to true.
- searchLimit: used to specify the maximum number of search results that may be returned by the search operation.
- timeLimit: specifies the maximum number of milliseconds the search is allowed to take if a repository supports such a parameter.
- expression: the search expression in XPath format.
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControlPropertyControl.ContextProperties
 
- 
 - 
Constructor SummaryConstructors Constructor Description SearchControl()
 - 
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 propertyintgetCountLimit()Gets the value of the countLimit property.java.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.java.lang.StringgetExpression()Gets the value of the expression property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)java.util.List<java.lang.String>getSearchBases()Gets the value of the searchBases property.intgetSearchLimit()Gets the value of the searchLimit property.static java.util.HashSetgetSubTypes()java.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, Control, is an extension of.intgetTimeLimit()Gets the value of the timeLimit property.java.lang.StringgetTypeName()Gets the name of this model object, ControlbooleanisReturnSubType()Gets the value of the returnSubType property.booleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSetCountLimit()booleanisSetExpression()booleanisSetReturnSubType()booleanisSetSearchBases()booleanisSetSearchLimit()booleanisSetTimeLimit()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.voidsetCountLimit(int value)Sets the value of the countLimit property.voidsetExpression(java.lang.String value)Sets the value of the expression property.voidsetReturnSubType(boolean value)Sets the value of the returnSubType property.voidsetSearchLimit(int value)Sets the value of the searchLimit property.voidsetTimeLimit(int value)Sets the value of the timeLimit 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.voidunsetCountLimit()voidunsetReturnSubType()voidunsetSearchBases()voidunsetSearchLimit()voidunsetTimeLimit()- 
Methods inherited from class com.ibm.wsspi.security.wim.model.PropertyControlgetContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
 
- 
 
- 
- 
- 
Method Detail- 
getSearchBasespublic java.util.List<java.lang.String> getSearchBases() Gets the value of the searchBases 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 searchBases property.For example, to add a new item, do as follows: getSearchBases().add(newItem); Objects of the following type(s) are allowed in the list String
 - 
isSetSearchBasespublic boolean isSetSearchBases() 
 - 
unsetSearchBasespublic void unsetSearchBases() 
 - 
getCountLimitpublic int getCountLimit() Gets the value of the countLimit property.- Returns:
- possible object is Integer
 
 - 
setCountLimitpublic void setCountLimit(int value) Sets the value of the countLimit property.- Parameters:
- value- allowed object is- Integer
 
 - 
isSetCountLimitpublic boolean isSetCountLimit() 
 - 
unsetCountLimitpublic void unsetCountLimit() 
 - 
getSearchLimitpublic int getSearchLimit() Gets the value of the searchLimit property.- Returns:
- possible object is Integer
 
 - 
setSearchLimitpublic void setSearchLimit(int value) Sets the value of the searchLimit property.- Parameters:
- value- allowed object is- Integer
 
 - 
isSetSearchLimitpublic boolean isSetSearchLimit() 
 - 
unsetSearchLimitpublic void unsetSearchLimit() 
 - 
getTimeLimitpublic int getTimeLimit() Gets the value of the timeLimit property.- Returns:
- possible object is Integer
 
 - 
setTimeLimitpublic void setTimeLimit(int value) Sets the value of the timeLimit property.- Parameters:
- value- allowed object is- Integer
 
 - 
isSetTimeLimitpublic boolean isSetTimeLimit() 
 - 
unsetTimeLimitpublic void unsetTimeLimit() 
 - 
getExpressionpublic java.lang.String getExpression() Gets the value of the expression property.- Returns:
- possible object is String
 
 - 
setExpressionpublic void setExpression(java.lang.String value) Sets the value of the expression property.- Parameters:
- value- allowed object is- String
 
 - 
isSetExpressionpublic boolean isSetExpression() 
 - 
isReturnSubTypepublic boolean isReturnSubType() Gets the value of the returnSubType property.- Returns:
- possible object is Boolean
 
 - 
setReturnSubTypepublic void setReturnSubType(boolean value) Sets the value of the returnSubType property.- Parameters:
- value- allowed object is- Boolean
 
 - 
isSetReturnSubTypepublic boolean isSetReturnSubType() 
 - 
unsetReturnSubTypepublic void unsetReturnSubType() 
 - 
getpublic java.lang.Object get(java.lang.String propName) Description copied from class:ControlGets the value of the requested property- Overrides:
- getin class- PropertyControl
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is Object
 
 - 
isSetpublic boolean isSet(java.lang.String propName) Description copied from class:ControlReturns true if the requested property is set; false, otherwise.- Overrides:
- isSetin class- PropertyControl
- Returns:
- returned object is boolean
 
 - 
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.- Overrides:
- setin class- PropertyControl
- Parameters:
- propName- allowed object is- String
- value- allowed object is- Object
 
 - 
unsetpublic void unset(java.lang.String propName) Description copied from class:ControlSets the value of provided property to null.- Overrides:
- unsetin class- PropertyControl
- Parameters:
- propName- allowed object is- String
 
 - 
getTypeNamepublic java.lang.String getTypeName() Description copied from class:ControlGets the name of this model object, Control- Overrides:
- getTypeNamein class- PropertyControl
- 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- PropertyControl
- 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- PropertyControl
- 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.- Overrides:
- isSubTypein class- PropertyControl
- Parameters:
- superTypeName- allowed object is- String
- Returns:
- returned object is boolean
 
 - 
getSubTypespublic static java.util.HashSet getSubTypes() 
 - 
toStringpublic java.lang.String toString() Description copied from class:ControlReturns this model object, Control, and its contents as a String- Overrides:
- toStringin class- PropertyControl
- Returns:
- returned object is String
 
 
- 
 
-