Enum PortalUser.Role

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PortalUser.Role>
    Enclosing class:
    PortalUser

    public static enum PortalUser.Role
    extends java.lang.Enum<PortalUser.Role>
    Signifies the role in the organization of a portal user.
    Since:
    100.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADMIN
      Organization administrator or custom role with administrative privileges.
      PUBLISHER
      Organization publisher or custom role with publisher privileges.
      UNKNOWN
      Role is unknown.
      USER
      Organization user or custom role with user privileges.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      Returns a string representing the role.
      static PortalUser.Role valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PortalUser.Role[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ADMIN

        @SerializedName("org_admin")
        public static final PortalUser.Role ADMIN
        Organization administrator or custom role with administrative privileges.
        Since:
        100.0.0
      • PUBLISHER

        @SerializedName("org_publisher")
        public static final PortalUser.Role PUBLISHER
        Organization publisher or custom role with publisher privileges.
        Since:
        100.0.0
      • USER

        @SerializedName("org_user")
        public static final PortalUser.Role USER
        Organization user or custom role with user privileges.
        Since:
        100.0.0
      • UNKNOWN

        @SerializedName("unknown")
        public static final PortalUser.Role UNKNOWN
        Role is unknown.
        Since:
        100.0.0
    • Method Detail

      • values

        public static PortalUser.Role[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (PortalUser.Role c : PortalUser.Role.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PortalUser.Role valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • toString

        public java.lang.String toString()
        Returns a string representing the role.
        Overrides:
        toString in class java.lang.Enum<PortalUser.Role>
        Returns:
        a string representing the role
        Since:
        100.0.0