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

Enum AssociationType

java.lang.Object

java.lang.Enum<AssociationType>

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

All Implemented Interfaces:

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

public enum AssociationType
extends Enum<AssociationType>

Lists all possible types of associations between two documents.

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
APPEND	An entry that is appended to another one.
HAS_MEMBER	An entry that is a member of another one.
IS_SNAPSHOT_OF	An entry that represents a link to the On-Demand DocumentEntry.
NON_VERSIONING_UPDATE	An entry that represents an association which is used as a flag to avoid the versioning of an updated document.
REPLACE	An entry that replaced another one.
SIGNS	An entry that represents a signature of another one.
SUBMIT_ASSOCIATION	An entry that represents an association for submit association trigger.
TRANSFORM	An entry that transforms another one.
TRANSFORM_AND_REPLACE	An entry that transforms and replaces another one.
UPDATE_AVAILABILITY_STATUS	An entry that represents an association for update availability status trigger.

Method Summary

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

APPEND

public static final AssociationType APPEND

An entry that is appended to another one.

REPLACE

public static final AssociationType REPLACE

An entry that replaced another one.

TRANSFORM

public static final AssociationType TRANSFORM

An entry that transforms another one.

TRANSFORM_AND_REPLACE

public static final AssociationType TRANSFORM_AND_REPLACE

An entry that transforms and replaces another one.

HAS_MEMBER

public static final AssociationType HAS_MEMBER

An entry that is a member of another one.

SIGNS

public static final AssociationType SIGNS

An entry that represents a signature of another one.

IS_SNAPSHOT_OF

public static final AssociationType IS_SNAPSHOT_OF

An entry that represents a link to the On-Demand DocumentEntry.

UPDATE_AVAILABILITY_STATUS

public static final AssociationType UPDATE_AVAILABILITY_STATUS

An entry that represents an association for update availability status trigger.

SUBMIT_ASSOCIATION

public static final AssociationType SUBMIT_ASSOCIATION

An entry that represents an association for submit association trigger.

NON_VERSIONING_UPDATE

public static final AssociationType NON_VERSIONING_UPDATE

An entry that represents an association which is used as a flag to avoid the versioning of an updated document.

Method Details

values

public static AssociationType[] 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 AssociationType 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.0.

getOpcode21

public static String getOpcode21(AssociationType type)

null-safe version of getOpcode21().

Parameters:

type - 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(AssociationType type)

null-safe version of getOpcode30().

Parameters:

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

Returns:

the opcode or null if type was null.

valueOfOpcode21

public static AssociationType valueOfOpcode21(String opcode)

Returns the association type that is represented by the given opcode.

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

Parameters:

opcode - the string representation. Can be null.

Returns:

the association type or null if the opcode was null.

valueOfOpcode30

public static AssociationType valueOfOpcode30(String opcode)

Returns the association type that is represented by the given opcode.

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

Parameters:

opcode - the string representation. Can be null.

Returns:

the association type or null if the opcode was null.

isReplace

public boolean isReplace()

Returns:

true if the association contains a replacement.