Package com.esprow.oapi.repository

Interface OapiFieldRule

public interface OapiFieldRule

A rule allowing to conditionally override the field's attributes or perform validation.

The following attributes and references are supported:

• Unique
• Assignments
• When
• Encoding
• Impl Length
• Impl Max Length
• Impl Min Length
• Max Inclusive
• Min Inclusive
• Name
• Presence
• Rendering
• Type
• Value

Method Summary

Modifier and Type	Method	Description
List<String>	getAssignments()	Returns a list of assignment expressions for a message field or state variable.
String	getEncoding()	Returns a character encoding if it is other than US-ASCII.
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.
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 rule.
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.
String	getType()	Returns a datatype or a codeSet carrying an underlying datatype.
OapiUnique	getUnique()	Returns an indicator of a field value's uniqueness.
String	getValue()	Returns a default or constant value of the field.
String	getWhen()	Returns a logic statement defining the condition when the rule applies.
void	setEncoding(String value)	Set a character encoding if it is other than US-ASCII.
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	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 rule.
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	setType(String value)	Set a datatype or a codeSet carrying an underlying datatype.
void	setUnique(OapiUnique value)	Set an indicator of a field value's uniqueness.
void	setValue(String value)	Set a default or constant value of the field.
void	setWhen(String value)	Set a logic statement defining the condition when the rule applies.

Method Details

getUnique

OapiUnique getUnique()

Returns an indicator of a field value's uniqueness.

Returns:

an indicator of a field value's uniqueness

See Also:

• setUnique(OapiUnique)

setUnique

void setUnique(OapiUnique value)

Set an indicator of a field value's uniqueness.

Parameters:

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

See Also:

• getUnique()

getAssignments

List<String> getAssignments()

Returns a list of assignment expressions for a message field or state variable.

Returns:

a list of assignment expressions for a message field or state variable

getWhen

String getWhen()

Returns a logic statement defining the condition when the rule applies.

Returns:

a logic statement defining the condition when the rule applies

See Also:

• setWhen(String)

setWhen

void setWhen(String value)

Set a logic statement defining the condition when the rule applies.

Parameters:

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

See Also:

• getWhen()

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

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

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

Returns:

the name of the rule

See Also:

• setName(String)

setName

void setName(String value)

Set the name of the rule.

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

getType

String getType()

Returns a datatype or a codeSet carrying an underlying datatype.

Returns:

a datatype or a codeSet carrying an underlying datatype

See Also:

• setType(String)

setType

void setType(String value)

Set a datatype or a codeSet carrying an underlying datatype.

Parameters:

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

See Also:

• getType()

getValue

String getValue()

Returns a default or constant value of the field.

Returns:

a default or constant value of the field

See Also:

• setValue(String)

setValue

void setValue(String value)

Set a default or constant value of the field.

Parameters:

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

See Also:

• getValue()