Class SearchControl
- Direct Known Subclasses:
ChangeControl,HierarchyControl,LoginControl
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.PropertyControl
PropertyControl.ContextProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the requested propertyintGets the value of the countLimit property.getDataType(String propName) Gets the Java type of the value of the provided property.Gets the value of the expression property.static ListgetPropertyNames(String entityTypeName) Gets the value of the searchBases property.intGets the value of the searchLimit property.static HashSetGets a list of any model objects which this model object, Control, is an extension of.intGets the value of the timeLimit property.Gets the name of this model object, ControlbooleanGets the value of the returnSubType property.booleanReturns true if the requested property is set; false, otherwise.booleanbooleanbooleanbooleanbooleanbooleanbooleanReturns a true if the provided model object is one that this model object extends; false, otherwise.voidSets the value of the provided property to the provided value.voidsetCountLimit(int value) Sets the value of the countLimit property.voidsetExpression(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.toString()Returns this model object, Control, and its contents as a StringvoidSets the value of provided property to null.voidvoidvoidvoidvoidMethods inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
-
Constructor Details
-
SearchControl
public SearchControl()
-
-
Method Details
-
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 -
isSetSearchBases
public boolean isSetSearchBases() -
unsetSearchBases
public void unsetSearchBases() -
getCountLimit
public int getCountLimit()Gets the value of the countLimit property.- Returns:
- possible object is
Integer
-
setCountLimit
public void setCountLimit(int value) Sets the value of the countLimit property.- Parameters:
value- allowed object isInteger
-
isSetCountLimit
public boolean isSetCountLimit() -
unsetCountLimit
public void unsetCountLimit() -
getSearchLimit
public int getSearchLimit()Gets the value of the searchLimit property.- Returns:
- possible object is
Integer
-
setSearchLimit
public void setSearchLimit(int value) Sets the value of the searchLimit property.- Parameters:
value- allowed object isInteger
-
isSetSearchLimit
public boolean isSetSearchLimit() -
unsetSearchLimit
public void unsetSearchLimit() -
getTimeLimit
public int getTimeLimit()Gets the value of the timeLimit property.- Returns:
- possible object is
Integer
-
setTimeLimit
public void setTimeLimit(int value) Sets the value of the timeLimit property.- Parameters:
value- allowed object isInteger
-
isSetTimeLimit
public boolean isSetTimeLimit() -
unsetTimeLimit
public void unsetTimeLimit() -
getExpression
Gets the value of the expression property.- Returns:
- possible object is
String
-
setExpression
Sets the value of the expression property.- Parameters:
value- allowed object isString
-
isSetExpression
public boolean isSetExpression() -
isReturnSubType
public boolean isReturnSubType()Gets the value of the returnSubType property.- Returns:
- possible object is
Boolean
-
setReturnSubType
public void setReturnSubType(boolean value) Sets the value of the returnSubType property.- Parameters:
value- allowed object isBoolean
-
isSetReturnSubType
public boolean isSetReturnSubType() -
unsetReturnSubType
public void unsetReturnSubType() -
get
Description copied from class:ControlGets the value of the requested property- Overrides:
getin classPropertyControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
Object
-
isSet
Description copied from class:ControlReturns true if the requested property is set; false, otherwise.- Overrides:
isSetin classPropertyControl- Returns:
- returned object is
boolean
-
set
Description copied from class:ControlSets the value of the provided property to the provided value.- Overrides:
setin classPropertyControl- Parameters:
propName- allowed object isStringvalue- allowed object isObject
-
unset
Description copied from class:ControlSets the value of provided property to null.- Overrides:
unsetin classPropertyControl- Parameters:
propName- allowed object isString
-
getTypeName
Description copied from class:ControlGets the name of this model object, Control- Overrides:
getTypeNamein classPropertyControl- Returns:
- returned object is
String
-
getPropertyNames
-
getDataType
Description copied from class:ControlGets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classPropertyControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
Description copied from class:ControlGets a list of any model objects which this model object, Control, is an extension of.- Overrides:
getSuperTypesin classPropertyControl- Returns:
- returned object is
ArrayList
-
isSubType
Description copied from class:ControlReturns a true if the provided model object is one that this model object extends; false, otherwise.- Overrides:
isSubTypein classPropertyControl- Parameters:
superTypeName- allowed object isString- Returns:
- returned object is
boolean
-
getSubTypes
-
toString
Description copied from class:ControlReturns this model object, Control, and its contents as a String- Overrides:
toStringin classPropertyControl- Returns:
- returned object is
String
-