Enum PortalUser.Access

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

    public static enum PortalUser.Access
    extends java.lang.Enum<PortalUser.Access>
    Signifies the level of access to a portal user, which determines who can access the user descriptive information.
    Since:
    100.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ORGANIZATION
      Access level is organization.
      PRIVATE
      Access level is private.
      PUBLIC
      Access level is public.
      UNKNOWN
      Access level is unknown.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      Returns a string representing the access level.
      static PortalUser.Access valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PortalUser.Access[] 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

      • PRIVATE

        @SerializedName("private")
        public static final PortalUser.Access PRIVATE
        Access level is private.
        Since:
        100.0.0
      • ORGANIZATION

        @SerializedName("org")
        public static final PortalUser.Access ORGANIZATION
        Access level is organization.
        Since:
        100.0.0
      • PUBLIC

        @SerializedName("public")
        public static final PortalUser.Access PUBLIC
        Access level is public.
        Since:
        100.0.0
      • UNKNOWN

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

      • values

        public static PortalUser.Access[] 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.Access c : PortalUser.Access.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.Access 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 access level.
        Overrides:
        toString in class java.lang.Enum<PortalUser.Access>
        Returns:
        a string representing the access level
        Since:
        100.0.0