Package com.esprow.oapi.repository

Interface OapiField

All Superinterfaces:

OapiBaseEntity

public interface OapiField
extends OapiBaseEntity

A message element with a specific business meaning according to a protocol specification.

The following attributes and references are supported:

• Rules
• Assign
• Annotation
• Abbr Name
• Base Category
• Base Category Abbr Name
• Discriminator Id
• Encoding
• Id
• Impl Length
• Impl Max Length
• Impl Min Length
• Length Id
• Max Inclusive
• Min Inclusive
• Name
• Presence
• Rendering
• Scenario
• Type
• Union Data Type
• Value

Method Summary

Modifier and Type	Method	Description
String	getAbbrName()	Returns an abbreviated name of the field.
OapiAnnotation	getAnnotation()	Returns all metadata on an element (documentation etc.).
String	getAssign()	Returns an expression providing a value to set for the field.
String	getBaseCategory()	Returns a base Category of the field.
String	getBaseCategoryAbbrName()	Returns an abbreviated name of the base Category.
BigInteger	getDiscriminatorId()	Returns the ID of a field used as a discriminator for the field's value domain.
String	getEncoding()	Returns a character encoding if it is other than US-ASCII.
BigInteger	getId()	Returns a unique numeric identifier.
short	getImplLength()	Returns a fixed length of the field.
short	getImplMaxLength()	Returns the maximum length of the field.
short	getImplMinLength()	Returns the minimum length of the field.
BigInteger	getLengthId()	Returns a reference to the ID of the associated Length field.
String	getMaxInclusive()	Returns an inclusive upper bound of a valid value range.
String	getMinInclusive()	Returns an inclusive lower bound of a valid value range.
String	getName()	Returns the name of the field.
Presence	getPresence()	Returns one of the possible values of presence (required, optional, forbidden, ignored, constant).
String	getRendering()	Returns a hint on how to generate or render an element in a user interface.
List<OapiFieldRule>	getRules()	Returns a list of rules.
String	getScenario()	Returns a use case of the field.
String	getType()	Returns a datatype or a codeSet of the field.
UnionDataType	getUnionDataType()	Returns a second datatype to extend the values supported by the Type attribute.
String	getValue()	Returns the default or constant value of the field.
void	setAbbrName(String value)	Set an abbreviated name of the field.
void	setAnnotation(OapiAnnotation value)	Set all metadata on an element (documentation etc.).
void	setAssign(String value)	Set an expression providing a value to set for the field.
void	setBaseCategory(String value)	Set a base Category of the field.
void	setBaseCategoryAbbrName(String value)	Set an abbreviated name of the base Category.
void	setDiscriminatorId(BigInteger value)	Set the ID of a field used as a discriminator for the field's value domain.
void	setEncoding(String value)	Set a character encoding if it is other than US-ASCII.
void	setId(BigInteger value)	Set a unique numeric identifier.
void	setImplLength(short value)	Set a fixed length of the field.
void	setImplMaxLength(short value)	Set the maximum length of the field.
void	setImplMinLength(short value)	Set the minimum length of the field.
void	setLengthId(BigInteger value)	Set a reference to the ID of the associated Length field.
void	setMaxInclusive(String value)	Set an inclusive upper bound of a valid value range.
void	setMinInclusive(String value)	Set an inclusive lower bound of a valid value range.
void	setName(String value)	Set the name of the field.
void	setPresence(Presence value)	Set one of the possible values of presence (required, optional, forbidden, ignored, constant).
void	setRendering(String value)	Set a hint on how to generate or render an element in a user interface.
void	setScenario(String value)	Set a use case of the field.
void	setType(String value)	Set a datatype or a codeSet of the field.
void	setUnionDataType(UnionDataType value)	Set a second datatype to extend the values supported by the Type attribute.
void	setValue(String value)	Set the default or constant value of the field.

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

getRules

List<OapiFieldRule> getRules()

Returns a list of rules.

Returns:

a list of rules

getAssign

String getAssign()

Returns an expression providing a value to set for the field.

Returns:

an expression providing a value to set for the field

See Also:

• setAssign(String)

setAssign

void setAssign(String value)

Set an expression providing a value to set for the field.

Parameters:

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

See Also:

• getAssign()

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 field.

Returns:

an abbreviated name of the field

See Also:

• setAbbrName(String)

setAbbrName

void setAbbrName(String value)

Set an abbreviated name of the field.

Parameters:

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

See Also:

• getAbbrName()

getBaseCategory

String getBaseCategory()

Returns a base Category of the field.

Returns:

a base Category of the field

See Also:

• setBaseCategory(String)

setBaseCategory

void setBaseCategory(String value)

Set a base Category of the field.

Parameters:

value - the new value of the 'Base Category' attribute.

See Also:

• getBaseCategory()

getBaseCategoryAbbrName

String getBaseCategoryAbbrName()

Returns an abbreviated name of the base Category.

Returns:

an abbreviated name of the base Category

See Also:

• setBaseCategoryAbbrName(String)

setBaseCategoryAbbrName

void setBaseCategoryAbbrName(String value)

Set an abbreviated name of the base Category.

Parameters:

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

See Also:

• getBaseCategoryAbbrName()

getDiscriminatorId

BigInteger getDiscriminatorId()

Returns the ID of a field used as a discriminator for the field's value domain.

Returns:

the ID of a field used as a discriminator for the field's value domain

See Also:

• setDiscriminatorId(BigInteger)

setDiscriminatorId

void setDiscriminatorId(BigInteger value)

Set the ID of a field used as a discriminator for the field's value domain.

Parameters:

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

See Also:

• getDiscriminatorId()

getEncoding

String getEncoding()

Returns a character encoding if it is other than US-ASCII.

Returns:

a character encoding if it is other than US-ASCII

See Also:

• setEncoding(String)

setEncoding

void setEncoding(String value)

Set a character encoding if it is other than US-ASCII.

Parameters:

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

See Also:

• getEncoding()

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

getImplLength

short getImplLength()

Returns a fixed length of the field.

Returns:

a fixed length of the field

See Also:

• setImplLength(short)

setImplLength

void setImplLength(short value)

Set a fixed length of the field.

Parameters:

value - the new value of the 'Impl Length' attribute.

See Also:

• getImplLength()

getImplMaxLength

short getImplMaxLength()

Returns the maximum length of the field.

Returns:

the maximum length of the field

See Also:

• setImplMaxLength(short)

setImplMaxLength

void setImplMaxLength(short value)

Set the maximum length of the field.

Parameters:

value - the new value of the 'Impl Max Length' attribute.

See Also:

• getImplMaxLength()

getImplMinLength

short getImplMinLength()

Returns the minimum length of the field.

Returns:

the minimum length of the field

See Also:

• setImplMinLength(short)

setImplMinLength

void setImplMinLength(short value)

Set the minimum length of the field.

Parameters:

value - the new value of the 'Impl Min Length' attribute.

See Also:

• getImplMinLength()

getLengthId

BigInteger getLengthId()

Returns a reference to the ID of the associated Length field.

Returns:

a reference to the ID of the associated Length field

See Also:

• setLengthId(BigInteger)

setLengthId

void setLengthId(BigInteger value)

Set a reference to the ID of the associated Length field.

Parameters:

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

See Also:

• getLengthId()

getMaxInclusive

String getMaxInclusive()

Returns an inclusive upper bound of a valid value range.

Returns:

an inclusive upper bound of a valid value range

See Also:

• setMaxInclusive(String)

setMaxInclusive

void setMaxInclusive(String value)

Set an inclusive upper bound of a valid value range.

Parameters:

value - the new value of the 'Max Inclusive' attribute.

See Also:

• getMaxInclusive()

getMinInclusive

String getMinInclusive()

Returns an inclusive lower bound of a valid value range.

Returns:

an inclusive lower bound of a valid value range

See Also:

• setMinInclusive(String)

setMinInclusive

void setMinInclusive(String value)

Set an inclusive lower bound of a valid value range.

Parameters:

value - the new value of the 'Min Inclusive' attribute.

See Also:

• getMinInclusive()

getName

String getName()

Returns the name of the field.

Returns:

the name of the field

See Also:

• setName(String)

setName

void setName(String value)

Set the name of the field.

Parameters:

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

See Also:

• getName()

getPresence

Presence getPresence()

Returns one of the possible values of presence (required, optional, forbidden, ignored, constant). The default value is "optional". The literals are from the enumeration Presence.

Returns:

one of the possible values of presence (required, optional, forbidden, ignored, constant)

See Also:

• Presence
• setPresence(Presence)

setPresence

void setPresence(Presence value)

Set one of the possible values of presence (required, optional, forbidden, ignored, constant).

Parameters:

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

See Also:

• Presence
• getPresence()

getRendering

String getRendering()

Returns a hint on how to generate or render an element in a user interface.

Returns:

a hint on how to generate or render an element in a user interface

See Also:

• setRendering(String)

setRendering

void setRendering(String value)

Set a hint on how to generate or render an element in a user interface.

Parameters:

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

See Also:

• getRendering()

getScenario

String getScenario()

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

Returns:

a use case of the field

See Also:

• setScenario(String)

setScenario

void setScenario(String value)

Set a use case of the field.

Parameters:

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

See Also:

• getScenario()

getType

String getType()

Returns a datatype or a codeSet of the field.

Returns:

a datatype or a codeSet of the field

See Also:

• setType(String)

setType

void setType(String value)

Set a datatype or a codeSet of the field.

Parameters:

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

See Also:

• getType()

getUnionDataType

UnionDataType getUnionDataType()

Returns a second datatype to extend the values supported by the Type attribute. The literals are from the enumeration UnionDataType.

Returns:

a second datatype to extend the values supported by the Type attribute

See Also:

• UnionDataType
• setUnionDataType(UnionDataType)

setUnionDataType

void setUnionDataType(UnionDataType value)

Set a second datatype to extend the values supported by the Type attribute.

Parameters:

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

See Also:

• UnionDataType
• getUnionDataType()

getValue

String getValue()

Returns the default or constant value of the field.

Returns:

the default or constant value of the field

See Also:

• setValue(String)

setValue

void setValue(String value)

Set the default or constant value of the field.

Parameters:

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

See Also:

• getValue()