|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.idm.IdSearchControl
This is a helper class which is used in the AMIdentityRepository
search method. It is used to to modify search controls for a given search
operation. The specific controls that can be modified are: maximum time limit
and size limit for the search, attributes that should be returned from the
search, simple modifications to be made to the search filter used by each
plugin by adding attribute-values which can be either OR'ed or AND'ed to the
basic search.
Constructor Summary | |
IdSearchControl()
Creates the IdSearchControl object |
Method Summary | |
int |
getMaxResults()
Returns the maximum number of search results. |
java.util.Set |
getReturnAttributes()
Returns the list of attributes requested to be read when the search is performed. |
IdSearchOpModifier |
getSearchModifier()
Returns the IdSearchOpModifier defined for this SearchControl |
java.util.Map |
getSearchModifierMap()
Returns the map set to be used to modify the search filter in each plugin. |
int |
getTimeOut()
Returns current time out setting. |
boolean |
isGetAllReturnAttributesEnabled()
Returns true if the option for getting all attributes has been enabled. |
boolean |
isRecursive()
Deprecated. This method is deprecated. The setting for recusive search should be configured via the data store. |
void |
setAllReturnAttributes(boolean getAllAttributes)
Sets the specified boolean value to the variable. |
void |
setMaxResults(int maxNumber)
Sets the maximum number of search results to return; 0 means there is no limit. |
void |
setRecursive(boolean rec)
Deprecated. This method is deprecated. The setting for recusive search should be configured via the data store. |
void |
setReturnAttributes(java.util.Set attributeNames)
Set the return attribute names, if attributes of the entries need to be obtained as part of the search. |
void |
setSearchModifiers(IdSearchOpModifier mod,
java.util.Map avMap)
Set the options for modifying the basic search filter in each plugin. |
void |
setTimeOut(int timeOut)
Sets the maximum number of milliseconds to wait for any operation for the search. |
java.lang.String |
toString()
Returns String representation of the IdSearchControl object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public IdSearchControl()
IdSearchControl
object
Method Detail |
public void setReturnAttributes(java.util.Set attributeNames)
AMSearchControl
, there could be a significant performance
overhead compared to when none are specified. When the return attributes
are set, the return attributes can be obtained as a map with identity name
as map-key and set of attribute values as map-value from
AMSearchResults
object.
attributeNames
- Set of attribute names whose values need to
be obtained as part of the search.public java.util.Set getReturnAttributes()
public void setAllReturnAttributes(boolean getAllAttributes)
getAllAttributes
- Boolean value set to true as part of the
IdSearchControl
to obtain all attributes as
part of the search.public boolean isGetAllReturnAttributesEnabled()
public void setTimeOut(int timeOut)
timeOut
- Max number of millisecondspublic int getTimeOut()
public void setMaxResults(int maxNumber)
maxNumber
- Max number of resultspublic int getMaxResults()
public void setSearchModifiers(IdSearchOpModifier mod, java.util.Map avMap)
mod
- One of the supported IdSearchOpModifiersavMap
- Map of attribute-value pairs to be used to modify the search
operation.public IdSearchOpModifier getSearchModifier()
public java.util.Map getSearchModifierMap()
public void setRecursive(boolean rec)
rec
- boolean true or falsepublic boolean isRecursive()
public java.lang.String toString()
IdSearchControl
object.
It returns search controls
IdSearchControl
object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |