Package com.esprow.oapi.repository

Interface OapiCodeSet

All Superinterfaces:

OapiBaseEntity

public interface OapiCodeSet
extends OapiBaseEntity

An element containing a finite collection of valid values of a data element.

The following attributes and references are supported:

• Codes
• Annotation
• Abbr Name
• Default
• Id
• Name
• Scenario
• Spec Url
• Type

Method Summary

Modifier and Type	Method	Description
String	getAbbrName()	Returns an abbreviated name of the code set.
OapiAnnotation	getAnnotation()	Returns all metadata on an element (documentation etc.).
List<OapiCode>	getCodes()	Returns a list of codes.
String	getDefault()
BigInteger	getId()	Returns a unique numeric identifier.
String	getName()	Returns a unique name of the code set.
String	getScenario()	Returns a use case of the code set.
String	getSpecUrl()	Returns a link to the external documentation.
String	getType()	Returns a datatype of the code.
void	setAbbrName(String value)	Set an abbreviated name of the code set.
void	setAnnotation(OapiAnnotation value)	Set all metadata on an element (documentation etc.).
void	setDefault(String value)	Sets the value of the 'Default' attribute.
void	setId(BigInteger value)	Set a unique numeric identifier.
void	setName(String value)	Set a unique name of the code set.
void	setScenario(String value)	Set a use case of the code set.
void	setSpecUrl(String value)	Set a link to the external documentation.
void	setType(String value)	Set a datatype of the code.

Methods inherited from interface com.esprow.oapi.repository.OapiBaseEntity

getAdded, getAddedEP, getChangeType, getDeprecated, getDeprecatedEP, getIssue, getLastModified, getReplaced, getReplacedByField, getReplacedEP, getSupported, getUpdated, getUpdatedEP, setAdded, setAddedEP, setChangeType, setDeprecated, setDeprecatedEP, setIssue, setLastModified, setReplaced, setReplacedByField, setReplacedEP, setSupported, setUpdated, setUpdatedEP

Method Details

getCodes

List<OapiCode> getCodes()

Returns a list of codes.

Returns:

a list of codes

getAnnotation

OapiAnnotation getAnnotation()

Returns all metadata on an element (documentation etc.).

Returns:

all metadata on an element (documentation etc.)

See Also:

• setAnnotation(OapiAnnotation)

setAnnotation

void setAnnotation(OapiAnnotation value)

Set all metadata on an element (documentation etc.).

Parameters:

value - the new value of the 'Annotation' containment reference.

See Also:

• getAnnotation()

getAbbrName

String getAbbrName()

Returns an abbreviated name of the code set.

Returns:

an abbreviated name of the code set

See Also:

• setAbbrName(String)

setAbbrName

void setAbbrName(String value)

Set an abbreviated name of the code set.

Parameters:

value - the new value of the 'Abbr Name' attribute.

See Also:

• getAbbrName()

getDefault

String getDefault()

See Also:

• setDefault(String)

setDefault

void setDefault(String value)

Sets the value of the 'Default' attribute.

Parameters:

value - the new value of the 'Default' attribute.

See Also:

• getDefault()

getId

BigInteger getId()

Returns a unique numeric identifier.

Returns:

a unique numeric identifier

See Also:

• setId(BigInteger)

setId

void setId(BigInteger value)

Set a unique numeric identifier.

Parameters:

value - the new value of the 'Id' attribute.

See Also:

• getId()

getName

String getName()

Returns a unique name of the code set.

Returns:

a unique name of the code set

See Also:

• setName(String)

setName

void setName(String value)

Set a unique name of the code set.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

• getName()

getScenario

String getScenario()

Returns a use case of the code set. The default value is "base".

Returns:

a use case of the code set

See Also:

• setScenario(String)

setScenario

void setScenario(String value)

Set a use case of the code set.

Parameters:

value - the new value of the 'Scenario' attribute.

See Also:

• getScenario()

getSpecUrl

String getSpecUrl()

Returns a link to the external documentation.

Returns:

a link to the external documentation

See Also:

• setSpecUrl(String)

setSpecUrl

void setSpecUrl(String value)

Set a link to the external documentation.

Parameters:

value - the new value of the 'Spec Url' attribute.

See Also:

• getSpecUrl()

getType

String getType()

Returns a datatype of the code.

Returns:

a datatype of the code

See Also:

• setType(String)

setType

void setType(String value)

Set a datatype of the code.

Parameters:

value - the new value of the 'Type' attribute.

See Also:

• getType()