Package com.microstrategy.web.objects.admin.users

Interface WebUserSecurityFilters

public interface WebUserSecurityFilters

The WebUserSecurityFilters interface represents the set of security filters associated with a user entity. Each project can have 0 or 1 WebMDSecurityFilter objects associated with it for this user entity. Note that any changes made to this interface will not be saved to the Intelligence Server until the WebUserEntity object that this object was obtained from is saved.

Since:

MicroStrategy Web 7.5.2

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears all security filter-project associations from this user.
WebMDSecurityFilter	get(WebProject project)	Returns the WebMDSecurityFilter object associated with the given project.
java.util.List<WebSecurityFilterRecord>	getInheritedSecurityFilters(WebProject project)	Get the inherited security filter for this user, user itself also included.
WebProject[]	getKeys()	Returns a complete list of projects which the user has a security filter associated with.
void	put(WebProject project, WebMDSecurityFilter filter)	This method associates the given WebMDSecurityFilter object with the given WebProject object for the user.
void	remove(WebProject project)	Disassociates any security filters which may be associated with the given project for this user.
int	size()	Returns the number of security filter-project associations in the project.

Method Detail

put

void put(WebProject project,
         WebMDSecurityFilter filter)
  throws java.lang.IllegalArgumentException

This method associates the given WebMDSecurityFilter object with the given WebProject object for the user. If a security filter is already associated with the given user, then it will be replaced with the new filter for the given project.

Parameters:

project - The WebProject object corresponding to the project to associate the filter with.

filter - The WebMDSecurityFilter object to associate with the project.

Throws:

java.lang.IllegalArgumentException - Thrown if either argument is null.

get

WebMDSecurityFilter get(WebProject project)

Returns the WebMDSecurityFilter object associated with the given project. If no security filter is associated with the given project, this method will return null.

Parameters:

project - The WebProject object corresponding to look up the security filter for.

Returns:

The WebMDSecurityFilter object associated with the project, or null if no security filter is associated with the project.

remove

void remove(WebProject project)

Disassociates any security filters which may be associated with the given project for this user.

Parameters:

project - The project to remove the security filter from.

clear

void clear()

Clears all security filter-project associations from this user. The user will have no security filters associated with it on any project after this call.

getKeys

WebProject[] getKeys()

Returns a complete list of projects which the user has a security filter associated with. This method, along with the get method, can be used to iterate through the whole collection.

Returns:

An array of WebProject objects representing the projects which the user has an association with a security filter for.

size

int size()

Returns the number of security filter-project associations in the project.

Returns:

The number of items in the collection.

getInheritedSecurityFilters

java.util.List<WebSecurityFilterRecord> getInheritedSecurityFilters(WebProject project)
                                                             throws WebObjectsException

Get the inherited security filter for this user, user itself also included.

Parameters:

project - The project to get the security filter from

Returns:

The inherited security filters of this user and user itself, it is a list of WebSecurityFilterRecord

Throws:

WebObjectsException