org.plasma.sdo.annotation

Annotation Type ValueSetConstraint

@Retention(value=RUNTIME)
public @interface ValueSetConstraint

This stereotype allows a value set constraint to be specified for a class attribute. Attributes that have a coded type may be constrained such that the code value in an instance should be taken from the specified value set. The coding strength determines whether exceptions are allowed.

Version:

1.3.2

Author:

Plasma-Team

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
CodingStrength	codingStrength Indicates whether or not codes are restricted to those expressed in the value set

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	id The globally unique identifier for the value set
String	ignoredValueSetId Defines the set of codes within the overall value set that the implementer is willing to accept without raising an error, but whose content will be ignored and not processed in any useful manner
String	minimumValueSetId Defines the set of codes within the overall value set that must be supported by an implementer to be considered compliant
String	name The descriptive name associated with the value set
String	rootCode Allows conveying the root code of the value set.
String	versionDate The date on which a specific version of the value set was created.
String	versionIdentifier The value which identifies a specific version of the value set.
String	versionTime The time when a specific version of the value set was created.

Element Detail

codingStrength

public abstract CodingStrength codingStrength

Indicates whether or not codes are restricted to those expressed in the value set

id

public abstract String id

The globally unique identifier for the value set

Default:

""

name

public abstract String name

The descriptive name associated with the value set

Default:

""

versionIdentifier

public abstract String versionIdentifier

The value which identifies a specific version of the value set. Used when performing static references to a value set

Default:

""

versionDate

public abstract String versionDate

The date on which a specific version of the value set was created. Used when performing static references to a value set

Default:

""

versionTime

public abstract String versionTime

The time when a specific version of the value set was created. Used when performing static references to a value set

Default:

""

minimumValueSetId

public abstract String minimumValueSetId

Defines the set of codes within the overall value set that must be supported by an implementer to be considered compliant

Default:

""

ignoredValueSetId

public abstract String ignoredValueSetId

Defines the set of codes within the overall value set that the implementer is willing to accept without raising an error, but whose content will be ignored and not processed in any useful manner

Default:

""

rootCode

public abstract String rootCode

Allows conveying the root code of the value set. Only usable for key structural attributes.

Default:

""