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.
PropertyControl.ContextProperties
Constructor and Description |
---|
SearchControl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property
|
int |
getCountLimit()
Gets the value of the countLimit property.
|
java.lang.String |
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.
|
java.lang.String |
getExpression()
Gets the value of the expression property.
|
static java.util.List |
getPropertyNames(java.lang.String entityTypeName) |
java.util.List<java.lang.String> |
getSearchBases()
Gets the value of the searchBases property.
|
int |
getSearchLimit()
Gets the value of the searchLimit property.
|
static java.util.HashSet |
getSubTypes() |
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, Control, is
an extension of.
|
int |
getTimeLimit()
Gets the value of the timeLimit property.
|
java.lang.String |
getTypeName()
Gets the name of this model object, Control
|
boolean |
isReturnSubType()
Gets the value of the returnSubType property.
|
boolean |
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.
|
boolean |
isSetCountLimit() |
boolean |
isSetExpression() |
boolean |
isSetReturnSubType() |
boolean |
isSetSearchBases() |
boolean |
isSetSearchLimit() |
boolean |
isSetTimeLimit() |
boolean |
isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this
model object extends; false, otherwise.
|
void |
set(java.lang.String propName,
java.lang.Object value)
Sets the value of the provided property to the provided value.
|
void |
setCountLimit(int value)
Sets the value of the countLimit property.
|
void |
setExpression(java.lang.String value)
Sets the value of the expression property.
|
void |
setReturnSubType(boolean value)
Sets the value of the returnSubType property.
|
void |
setSearchLimit(int value)
Sets the value of the searchLimit property.
|
void |
setTimeLimit(int value)
Sets the value of the timeLimit property.
|
java.lang.String |
toString()
Returns this model object, Control, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of provided property to null.
|
void |
unsetCountLimit() |
void |
unsetReturnSubType() |
void |
unsetSearchBases() |
void |
unsetSearchLimit() |
void |
unsetTimeLimit() |
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
public java.util.List<java.lang.String> getSearchBases()
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 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
public boolean isSetSearchBases()
public void unsetSearchBases()
public int getCountLimit()
Integer
public void setCountLimit(int value)
value
- allowed object is Integer
public boolean isSetCountLimit()
public void unsetCountLimit()
public int getSearchLimit()
Integer
public void setSearchLimit(int value)
value
- allowed object is Integer
public boolean isSetSearchLimit()
public void unsetSearchLimit()
public int getTimeLimit()
Integer
public void setTimeLimit(int value)
value
- allowed object is Integer
public boolean isSetTimeLimit()
public void unsetTimeLimit()
public java.lang.String getExpression()
String
public void setExpression(java.lang.String value)
value
- allowed object is String
public boolean isSetExpression()
public boolean isReturnSubType()
Boolean
public void setReturnSubType(boolean value)
value
- allowed object is Boolean
public boolean isSetReturnSubType()
public void unsetReturnSubType()
public java.lang.Object get(java.lang.String propName)
Control
get
in class PropertyControl
propName
- allowed object is String
Object
public boolean isSet(java.lang.String propName)
Control
isSet
in class PropertyControl
boolean
public void set(java.lang.String propName, java.lang.Object value)
Control
set
in class PropertyControl
propName
- allowed object is String
value
- allowed object is Object
public void unset(java.lang.String propName)
Control
unset
in class PropertyControl
propName
- allowed object is String
public java.lang.String getTypeName()
Control
getTypeName
in class PropertyControl
String
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
public java.lang.String getDataType(java.lang.String propName)
Control
getDataType
in class PropertyControl
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
Control
getSuperTypes
in class PropertyControl
ArrayList
public boolean isSubType(java.lang.String superTypeName)
Control
isSubType
in class PropertyControl
superTypeName
- allowed object is String
boolean
public static java.util.HashSet getSubTypes()
public java.lang.String toString()
Control
toString
in class PropertyControl
String