Interface WebUserSearch
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
public interface WebUserSearch extends Persistable
This interface provides some search abilities available for users. This interface can be used to search for users who are using a certain security filter for a certain project, AND using a certain security role for a certain project. The project information is a must have for search based on security filter, but an optional for search based on security role. The search only searches these information set directly at user/group level. It does not search information inherited from its parent group. On this interface, aWebSearch
object can be retrieved to pre-select a collection of users which this search will apply on. The result will be the intersection of the results fromWebSearch
and the search results from the security filter and security role criteria set on this interface.- Since:
- MicroStrategy Web 7.5.2
-
-
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 void
clear()
Clears all previous settings.WebProjectInstance
getProject()
Returns the project context set for this search.WebUserEntity[]
getResults()
Returns the search results.WebSearch
getSearchObject()
Returns aWebSearch
object.WebMDSecurityFilter
getSecurityFilter()
Returns the security filter set for search.WebSecurityRole
getSecurityRole()
Returns the security role set for search.void
setProject(WebProjectInstance project)
Sets the project context.void
setSecurityFilter(WebMDSecurityFilter filter)
Sets the search cretiria for security filter.void
setSecurityRole(WebSecurityRole role)
Sets the search cretiria for security role.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
-
-
-
Method Detail
-
setProject
void setProject(WebProjectInstance project)
Sets the project context.- Security filter is a per project concept, and the relationship between security role and user is also defined at project level. So, this setting is mandatory for security filter related search.
- Even the relationship between user and security role set at project level, security role itself is a per-server concept. For security role only search, this setting is optional. If the project is set, then the search will looking for users who have certian security role for this project. If this project is not set, then the search will looking for users who have certain security role for any project.
- Parameters:
project
- The project which search will be perform upon.
-
getProject
WebProjectInstance getProject()
Returns the project context set for this search.- Returns:
- A
WebProjectInstance
for project the search will perform on.
-
setSecurityFilter
void setSecurityFilter(WebMDSecurityFilter filter)
Sets the search cretiria for security filter. Specify that we are interested in users who are using a certain filter. NOTE: to search users based on security filter, must callsetProject(WebProjectInstance)
to set up project information.- Parameters:
filter
- The security filter used by users.
-
getSecurityFilter
WebMDSecurityFilter getSecurityFilter()
Returns the security filter set for search.- Returns:
- A
WebMDSecurityFilter
which used by users.
-
setSecurityRole
void setSecurityRole(WebSecurityRole role)
Sets the search cretiria for security role. Specify that we are interested in users who are having a certain security role.- Parameters:
role
- The security role used by users.
-
getSecurityRole
WebSecurityRole getSecurityRole()
Returns the security role set for search.- Returns:
WebSecurityRole
which is used by users.
-
getSearchObject
WebSearch getSearchObject()
Returns aWebSearch
object. This object can be used to pre-select a collection of users which the security filter and role search will apply on.- Returns:
- A
WebSearch
object.
-
getResults
WebUserEntity[] getResults() throws WebObjectsException
Returns the search results. It is the intersection of results fromWebSearch
and results from security filter and role search.- Returns:
- An array of
WebUserEntity
which satisfied all the search cretiria set through this interface. - Throws:
Thrown
- when error occurs during retrieve information from Intelligence Server. Or, if security filter has been set up without setting project information.WebObjectsException
-
clear
void clear()
Clears all previous settings.
-
-