UserSearchBean (Web API 2021)

All Superinterfaces:

EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebBean, WebComponent
```
public interface UserSearchBean
extends WebBean
```
This interface represents a search for user.

Since:

MicroStrategy Web 8.0.0

Field Summary
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UserEntitiesBean`	`getResult()`	Returns the search result.
`WebUserSearch`	`getSearchObject()`	Returns `WebUserSearch` which can be used for search based on user's name, etc.
`boolean`	`isShowResult()`	Returns whether to show the result.
`void`	`setShowResult(boolean show)`	Sets the show result flag, which will be used to indicate whether the result should be showing.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Method Detail
  - getSearchObject
```
WebUserSearch getSearchObject()
```
    Returns WebUserSearch which can be used for search based on user's name, etc.
    
    Returns:
    
    WebUserSearch The search object.
  - getResult
```
UserEntitiesBean getResult()
```
    Returns the search result.
    
    Returns:
    
    UserEntitiesBean The result of the search.
  - setShowResult
```
void setShowResult(boolean show)
```
    Sets the show result flag, which will be used to indicate whether the result should be showing.
    
    Parameters:
    
    show - boolean true to show the result, otherwise not.
  - isShowResult
```
boolean isShowResult()
```
    Returns whether to show the result.
    
    Returns:
    
    boolean true to show the result, otherwise not.