Package com.microstrategy.web.objects

Interface WebAccessControlEntry

  • public interface WebAccessControlEntry
    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.
    Since:
    MicroStrategy Web 7.5.2

    • Method Detail

      • getTrustee

        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.

      • setTrustee

        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.

      • getRights

        int getRights()
        Returns the rights assigned to the user on this ACE.
        Returns:
        The rights assigned to the user, the bitwise or of values from EnumDSSXMLAccessRightFlags.

      • setRights

        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.

      • isAccessDenied

        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.

      • setAccessDenied

        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.

      • isInheritable

        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.

      • setInheritable

        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.