public interface

WebEditablePrivileges

implements WebPrivileges
com.microstrategy.web.objects.admin.users.WebEditablePrivileges

Class Overview

The WebEditablePrivileges interface represents a read-write collection of WebPrivilegeEntry objects, representing an editable set of privileges. It extends WebPrivileges, and thus provides the same reading methods as that interface. It is generally obtained from the getLocalPrivileges method on the WebUserEntity interface or the getPrivileges method on the WebSecurityRole interface.

Summary

Public Methods
abstract WebPrivilegeEntry grant(int privilege)
Grants the given privilege to the user.
abstract void revoke(int index)
Revokes the privilege at the given index from the collection.
abstract void revoke(WebPrivilegeEntry privilege)
Revokes the given privilege.
abstract void revokeAll()
Revokes all privileges for the user.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.admin.users.WebPrivileges

Public Methods

public abstract WebPrivilegeEntry grant (int privilege)

Grants the given privilege to the user. Returns the resultant WebPrivilegeEntry object after granting it. Note that if the collection already contains a privilege of the given type, the existing privilege will be returned.

Parameters
privilege The privilege type to grant, from EnumDSSXMLPrivilegeTypes.
Returns

public abstract void revoke (int index)

Revokes the privilege at the given index from the collection.

Parameters
index The index of the privilege to revoke.

public abstract void revoke (WebPrivilegeEntry privilege)

Revokes the given privilege. This will remove the privilege from the collection.

Parameters
privilege The WebPrivilegeEntry object to remove from the collection.

public abstract void revokeAll ()

Revokes all privileges for the user. This removes all privileges from the collection.