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

Interface WebSecurityRoleUsers

public interface WebSecurityRoleUsers

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	addUser(WebProject webProject, WebUserEntity userEntity)	This method associates the given WebProject object with the given WebUserEntity user for the security role.
WebUserEntity[]	getUsers(WebProject project)	Returns the collection of WebUserEntity objects associated with the given project.
boolean	isSaveUpdatedLinks()	Get saveUpdatedLinks flags for controlling just saving updated linked items, not all linkItems.
void	removeAllUsers()	Clears all user associations from all projects for the security role.
void	removeAllUsers(WebProject project)	Clears all user associations from a project for the security role.
void	removeUser(WebProject project, WebUserEntity userEntity)	Clears all user associations from a project for the security role.
void	setSaveUpdatedLinks(boolean saveUpdatedLinks)	Set saveUpdatedLinks flags for controlling just saving updated linked items, not all linkItems.

Method Detail

addUser

void addUser(WebProject webProject,
             WebUserEntity userEntity)
      throws java.lang.IllegalArgumentException,
             WebObjectsException

This method associates the given WebProject object with the given WebUserEntity user for the security role.

Parameters:

webProject - The WebProject object corresponding to the project to associate the role with.

userEntity - The WebUserEntity object to associate with the security role.

Throws:

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

WebObjectsException

getUsers

WebUserEntity[] getUsers(WebProject project)
                  throws WebObjectsException

Returns the collection of WebUserEntity objects associated with the given project. If no user is associated with the given project, this method will return null.

Parameters:

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

Returns:

The WebUserEntity array associated with the project and the current security role.

Throws:

WebObjectsException

removeAllUsers

void removeAllUsers()
             throws WebObjectsException

Clears all user associations from all projects for the security role. The security role will have no users associated with it for any project after this call.

Throws:

WebObjectsException

removeAllUsers

void removeAllUsers(WebProject project)
             throws WebObjectsException

Clears all user associations from a project for the security role. The security role will have no users associated with it for this project after this call.

Parameters:

project - The WebProject object for which the users associations are cleared.

Throws:

WebObjectsException

removeUser

void removeUser(WebProject project,
                WebUserEntity userEntity)
         throws WebObjectsException

Clears all user associations from a project for the security role. The security role will have no users associated with it for this project after this call.

Parameters:

project - The WebProject object for which the association is to be cleared.

userEntity - The WebUserEntity object for which the association is to be cleared.

Throws:

WebObjectsException

isSaveUpdatedLinks

boolean isSaveUpdatedLinks()

Get saveUpdatedLinks flags for controlling just saving updated linked items, not all linkItems.

setSaveUpdatedLinks

void setSaveUpdatedLinks(boolean saveUpdatedLinks)

Set saveUpdatedLinks flags for controlling just saving updated linked items, not all linkItems.