Class PortalPrivilege


  • public final class PortalPrivilege
    extends Object
    Represents a particular privilege possessed by a portal user.
    Since:
    100.0.0
    • Method Detail

      • getRealm

        public PortalPrivilege.Realm getRealm()
        Gets the realm this privilege belongs to.
        Returns:
        the realm
        Since:
        100.0.0
      • getRole

        public PortalPrivilege.Role getRole()
        Gets the role this privilege belongs to.
        Returns:
        the role
        Since:
        100.0.0
      • getType

        public PortalPrivilege.Type getType()
        Gets the particular type of operation this privilege permits.
        Returns:
        the type of operation
        Since:
        100.0.0
      • getTypeName

        public String getTypeName()
        Gets the type name for this privilege.

        Generally the type name is the string representation of the PortalPrivilege.Type returned by getType(). However if the type is PortalPrivilege.Type.UNKNOWN, the type name is set with the type found in the portal privilege JSON. This allows the API to deal with new portal privilege types added since the latest API release.

        Returns:
        the type name for this privilege
        Since:
        100.0.0