Package org.orcid.jaxb.model.message

Enum Class Visibility

java.lang.Object

java.lang.Enum<Visibility>

org.orcid.jaxb.model.message.Visibility

All Implemented Interfaces:

Serializable, Comparable<Visibility>, Constable

public enum Visibility
extends Enum<Visibility>
implements Serializable

Java class for visibility.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LIMITED	The PROTECTED should only be shared with systems that the researcher or contributor has specifically granted authorization (using OAuth).
PRIVATE	The PRIVATE should only be used internally by ORCID.
PUBLIC	The PUBLIC should be publically available.
REGISTERED_ONLY	The org.orcid.test.data should be shared only with registered users.
SYSTEM	The SYSTEM are a special level of visibility whereby only the system will be able to change it.

Method Summary

Modifier and Type	Method	Description
static Visibility	fromValue(String v)
boolean	isMoreRestrictiveThan(Visibility other)
String	jsonValue()
String	toString()
String	value()
static Visibility	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Visibility[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SYSTEM

public static final Visibility SYSTEM

The SYSTEM are a special level of visibility whereby only the system will be able to change it. The most notable of these is email address.

PRIVATE

public static final Visibility PRIVATE

The PRIVATE should only be used internally by ORCID.

LIMITED

public static final Visibility LIMITED

The PROTECTED should only be shared with systems that the researcher or contributor has specifically granted authorization (using OAuth).

REGISTERED_ONLY

public static final Visibility REGISTERED_ONLY

The org.orcid.test.data should be shared only with registered users.

PUBLIC

public static final Visibility PUBLIC

The PUBLIC should be publically available.

Method Details

values

public static Visibility[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Visibility valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

jsonValue

public String jsonValue()

fromValue

public static Visibility fromValue(String v)

isMoreRestrictiveThan

public boolean isMoreRestrictiveThan(Visibility other)

toString

public String toString()

Overrides:

toString in class Enum<Visibility>