public interface

WebUserSearch

implements Persistable
com.microstrategy.web.objects.admin.users.WebUserSearch

Class Overview

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, a WebSearch 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 from WebSearch and the search results from the security filter and security role criteria set on this interface.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void clear()
Clears all previous settings.
abstract WebProjectInstance getProject()
Returns the project context set for this search.
abstract WebUserEntity[] getResults()
Returns the search results.
abstract WebSearch getSearchObject()
Returns a WebSearch object.
abstract WebMDSecurityFilter getSecurityFilter()
Returns the security filter set for search.
abstract WebSecurityRole getSecurityRole()
Returns the security role set for search.
abstract void setProject(WebProjectInstance project)
Sets the project context.
abstract void setSecurityFilter(WebMDSecurityFilter filter)
Sets the search cretiria for security filter.
abstract void setSecurityRole(WebSecurityRole role)
Sets the search cretiria for security role.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable

Public Methods

public abstract void clear ()

Clears all previous settings.

public abstract WebProjectInstance getProject ()

Returns the project context set for this search.

Returns

public abstract WebUserEntity[] getResults ()

Returns the search results. It is the intersection of results from WebSearch and results from security filter and role search.

Returns
  • An array of WebUserEntity which satisfied all the search cretiria set through this interface.
Throws
when error occurs during retrieve information from Intelligence Server. Or, if security filter has been set up without setting project information.
WebObjectsException

public abstract WebSearch getSearchObject ()

Returns a WebSearch object. This object can be used to pre-select a collection of users which the security filter and role search will apply on.

Returns

public abstract WebMDSecurityFilter getSecurityFilter ()

Returns the security filter set for search.

Returns

public abstract WebSecurityRole getSecurityRole ()

Returns the security role set for search.

Returns

public abstract 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.

    public abstract 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 call setProject(WebProjectInstance) to set up project information.

    Parameters
    filter The security filter used by users.

    public abstract 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.