Package com.esprow.oapi.repository

Interface OapiCode

All Superinterfaces:

OapiBaseEntity

public interface OapiCode
extends OapiBaseEntity

A unique valid value within a code set.

The following attributes and references are supported:

• Annotation
• Abbr Name
• Group
• Id
• Name
• Scenario
• Sort
• Value

Method Summary

Modifier and Type	Method	Description
String	getAbbrName()	Returns an abbreviated name of the code.
OapiAnnotation	getAnnotation()	Returns all metadata on an element (documentation etc.).
String	getGroup()	Returns a free-form value used to group codes when sorting them for displaying purposes.
BigInteger	getId()	Returns a unique numeric identifier.
String	getName()	Returns a unique name of the code.
String	getScenario()	Returns a use case of the code.
String	getSort()	Returns a non-negative integer relative to the group, used when sorting codes for displaying purposes.
String	getValue()	Returns the value of the code.
void	setAbbrName(String value)	Set an abbreviated name of the code.
void	setAnnotation(OapiAnnotation value)	Set all metadata on an element (documentation etc.).
void	setGroup(String value)	Set a free-form value used to group codes when sorting them for displaying purposes.
void	setId(BigInteger value)	Set a unique numeric identifier.
void	setName(String value)	Set a unique name of the code.
void	setScenario(String value)	Set a use case of the code.
void	setSort(String value)	Set a non-negative integer relative to the group, used when sorting codes for displaying purposes.
void	setValue(String value)	Set the value 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

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.

Returns:

an abbreviated name of the code

See Also:

• setAbbrName(String)

setAbbrName

void setAbbrName(String value)

Set an abbreviated name of the code.

Parameters:

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

See Also:

• getAbbrName()

getGroup

String getGroup()

Returns a free-form value used to group codes when sorting them for displaying purposes.

Returns:

a free-form value used to group codes when sorting them for displaying purposes

See Also:

• setGroup(String)

setGroup

void setGroup(String value)

Set a free-form value used to group codes when sorting them for displaying purposes.

Parameters:

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

See Also:

• getGroup()

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.

Returns:

a unique name of the code

See Also:

• setName(String)

setName

void setName(String value)

Set a unique name of the code.

Parameters:

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

See Also:

• getName()

getScenario

String getScenario()

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

Returns:

a use case of the code

See Also:

• setScenario(String)

setScenario

void setScenario(String value)

Set a use case of the code.

Parameters:

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

See Also:

• getScenario()

getSort

String getSort()

Returns a non-negative integer relative to the group, used when sorting codes for displaying purposes.

Returns:

a non-negative integer relative to the group, used when sorting codes for displaying purposes

See Also:

• setSort(String)

setSort

void setSort(String value)

Set a non-negative integer relative to the group, used when sorting codes for displaying purposes.

Parameters:

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

See Also:

• getSort()

getValue

String getValue()

Returns the value of the code.

Returns:

the value of the code

See Also:

• setValue(String)

setValue

void setValue(String value)

Set the value of the code.

Parameters:

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

See Also:

• getValue()