Summary: Methods | [Expand All]
public interface

WebPrivileges

com.microstrategy.web.objects.admin.users.WebPrivileges
Known Indirect Subclasses

Class Overview

The WebPrivileges interface is a collection of WebPrivilegeEntry objects. This interface represents a read-only set of privileges - this is used primarily for lists of full privileges. There also exists a read-write privilege interface which extends this interface - WebEditablePrivileges.

Summary

Public Methods
abstract WebPrivilegeEntry get(int index)
Returns the privilege at the given index in the collection.
abstract WebPrivilegeEntry getItemByType(int privilege)
Returns the item in the collection with the given privilege type.
abstract boolean includes(int privilege)
Returns whether the given privilege is contained in the collection.
abstract int size()
Returns the size of the collection.

Public Methods

public abstract WebPrivilegeEntry get (int index)

Returns the privilege at the given index in the collection.

Parameters
index The index of the privilege to return.
Returns

public abstract WebPrivilegeEntry getItemByType (int privilege)

Returns the item in the collection with the given privilege type. An error is thrown if no privilege with the given type exists in the collection.

Parameters
privilege The privilege to search for in the collection, from EnumDSSXMLPrivilegeTypes.
Returns

public abstract boolean includes (int privilege)

Returns whether the given privilege is contained in the collection.

Parameters
privilege The privilege to check for in the collection, a value from EnumDSSXMLPrivilegeTypes.
Returns
  • True if the privilege exists in the collection, false otherwise.

public abstract int size ()

Returns the size of the collection.

Returns
  • The number of privileges in the collection.