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

Enum Status

java.lang.Object

java.lang.Enum<Status>

org.openehealth.ipf.commons.ihe.xds.core.responses.Status

All Implemented Interfaces:

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

public enum Status
extends Enum<Status>

Status information according to the XDS specification.

Author:

Jens Riemschneider

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
FAILURE	The request execution failed.
PARTIAL_SUCCESS	The request execution partially succeeded.
SUCCESS	The request execution succeeded.

Method Summary

Modifier and Type	Method	Description
String	getOpcode21()
static String	getOpcode21(Status status)	null-safe version of getOpcode21().
String	getOpcode30()
static String	getOpcode30(Status status)	null-safe version of getOpcode30().
static Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Status	valueOfOpcode(String opcode)	Returns the status that is represented by the given opcode.
static Status[]	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

FAILURE

public static final Status FAILURE

The request execution failed.

SUCCESS

public static final Status SUCCESS

The request execution succeeded.

PARTIAL_SUCCESS

public static final Status PARTIAL_SUCCESS

The request execution partially succeeded.

Method Details

values

public static Status[] 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 Status 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

getOpcode21

public String getOpcode21()

Returns:

a string representation in ebXML 2.1.

getOpcode30

public String getOpcode30()

Returns:

a string representation in ebXML 3.1.

getOpcode21

public static String getOpcode21(Status status)

null-safe version of getOpcode21().

Parameters:

status - the type for which to get the opcode. Can be null.

Returns:

the opcode or null if type was null.

getOpcode30

public static String getOpcode30(Status status)

null-safe version of getOpcode30().

Parameters:

status - the type for which to get the opcode. Can be null.

Returns:

the opcode or null if type was null.

valueOfOpcode

public static Status valueOfOpcode(String opcode)

Returns the status that is represented by the given opcode.

This method looks up the opcode via the ebXML 2.1 and 3.0 representations.

Parameters:

opcode - the string representation. Can be null.

Returns:

the status or null if the opcode was null.