Package org.openehealth.ipf.commons.ihe.xds.core.metadata

Enum DocumentAvailability

java.lang.Object

java.lang.Enum<DocumentAvailability>

org.openehealth.ipf.commons.ihe.xds.core.metadata.DocumentAvailability

All Implemented Interfaces:

Serializable, Comparable<DocumentAvailability>, java.lang.constant.Constable

public enum DocumentAvailability
extends Enum<DocumentAvailability>

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
OFFLINE	Online indicates the Document in the Document Repository is available to be retrieved.
ONLINE	Offline indicates the Document in the Document Repository is not available to be retrieved.

Method Summary

Modifier and Type	Method	Description
String	getFullQualified()
String	getOpcode()
static String	toFullQualifiedOpcode(DocumentAvailability status)	Retrieves the fully qualified representation of a document availability.
static String	toOpcode(DocumentAvailability documentAvailability)	Retrieves the representation of a given document availability.
static DocumentAvailability	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DocumentAvailability	valueOfOpcode(String opcode)	Returns the document availability represented by the given opcode.
static DocumentAvailability[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OFFLINE

public static final DocumentAvailability OFFLINE

Online indicates the Document in the Document Repository is available to be retrieved.

ONLINE

public static final DocumentAvailability ONLINE

Offline indicates the Document in the Document Repository is not available to be retrieved.

Method Details

values

public static DocumentAvailability[] values()

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

Returns:

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

valueOf

public static DocumentAvailability valueOf(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:

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

NullPointerException - if the argument is null

getOpcode

public String getOpcode()

getFullQualified

public String getFullQualified()

valueOfOpcode

public static DocumentAvailability valueOfOpcode(String opcode)

Returns the document availability represented by the given opcode. This method takes standard opcodes and fully qualified opcodes into account.

Parameters:

opcode - the opcode to look up. Can be null.

Returns:

the status. null if the opcode was null or could not be found.
See IHE_ITI_Suppl_XDS_Metadata_Update Table 4.2.3.2-1.

toOpcode

public static String toOpcode(DocumentAvailability documentAvailability)

Retrieves the representation of a given document availability.

This is a null-safe version of getOpcode().

Parameters:

documentAvailability - the documentAvailability. Can be null.

Returns:

the representation or null if the status was null.

toFullQualifiedOpcode

public static String toFullQualifiedOpcode(DocumentAvailability status)

Retrieves the fully qualified representation of a document availability.

This is a null-safe version of getFullQualified().

Parameters:

status - the status. Can be null.

Returns:

the representation or null if the status was null.