public interface

WebSecurityRoleUsers

com.microstrategy.web.objects.admin.users.WebSecurityRoleUsers

Summary

Public Methods
abstract void addUser(WebProject webProject, WebUserEntity userEntity)
This method associates the given WebProject object with the given WebUserEntity user for the security role.
abstract WebUserEntity[] getUsers(WebProject project)
Returns the collection of WebUserEntity objects associated with the given project.
abstract void removeAllUsers(WebProject project)
Clears all user associations from a project for the security role.
abstract void removeAllUsers()
Clears all user associations from all projects for the security role.
abstract void removeUser(WebProject project, WebUserEntity userEntity)
Clears all user associations from a project for the security role.

Public Methods

public abstract void addUser (WebProject webProject, WebUserEntity userEntity)

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
IllegalArgumentException Thrown if either argument is null.
WebObjectsException

public abstract WebUserEntity[] getUsers (WebProject project)

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

public abstract void removeAllUsers (WebProject project)

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

public abstract void removeAllUsers ()

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

public abstract void removeUser (WebProject project, WebUserEntity userEntity)

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