public interface

WebAccessControlEntry

com.microstrategy.web.objects.WebAccessControlEntry

Class Overview

The WebAccessControlEntry interface represents a single access control entry within a WebAccessControlList collection. A single entry is a single permission (or restriction of permission) for a single user or user group. There are usually multiple entries on a WebAccessControlList object, and each one gives one rule for access/denial of access to an object.

Summary

Public Methods
abstract int getRights()
Returns the rights assigned to the user on this ACE.
abstract WebUserEntity getTrustee()
Returns the WebUser object which is currently designated as the trustee of the access control entry.
abstract int getType()
The type of ACE, from EnumDSSXMLAccessEntryType.
abstract boolean isAccessDenied()
Returns whether the access denied flag is set on the ACE.
abstract boolean isInheritable()
Returns the value of the inheritable flag, which determines whether the ACE will be inherited or not.
abstract void setAccessDenied(boolean val)
Sets the access denied flag on the ACE.
abstract void setInheritable(boolean val)
Sets the inheritable flag, which determines whether the ACE will be inherited.
abstract void setRights(int rights)
Sets the rights assigned to the user on this ACE.
abstract void setTrustee(WebUserEntity trustee)
Sets the user designated as the trustee of the access control entry.

Public Methods

public abstract int getRights ()

Returns the rights assigned to the user on this ACE.

Returns

public abstract WebUserEntity getTrustee ()

Returns the WebUser object which is currently designated as the trustee of the access control entry. This may be null in the case of a newly created ACE object, but this must be set correctly before saving back to metadata.

Returns
  • The WebUser object designated as the trustee of the ACE.

public abstract int getType ()

The type of ACE, from EnumDSSXMLAccessEntryType. Note that this value is set upon creation of the access control entry.

Returns

public abstract boolean isAccessDenied ()

Returns whether the access denied flag is set on the ACE. If this is set, then the ACE is specifying denied access.

Returns
  • The current value of the access denied flag.

public abstract boolean isInheritable ()

Returns the value of the inheritable flag, which determines whether the ACE will be inherited or not.

Returns
  • True if the ACE is inheritable, false otherwise.

public abstract void setAccessDenied (boolean val)

Sets the access denied flag on the ACE. If this is set, then the ACE is specifying denied access.

Parameters
val The new value of the access denied flag.

public abstract void setInheritable (boolean val)

Sets the inheritable flag, which determines whether the ACE will be inherited.

Parameters
val The new value of the inheritable flag.

public abstract void setRights (int rights)

Sets the rights assigned to the user on this ACE. The input values should be the bitwise or (|) of values from EnumDSSXMLAccessRightFlags.}

Parameters
rights The rights to assign to the user, from EnumDSSXMLAccessRightFlags.

public abstract void setTrustee (WebUserEntity trustee)

Sets the user designated as the trustee of the access control entry.

Parameters
trustee The WebUser object to set as the trustee.