Package com.esprow.oapi.repository

Interface OapiMessage

All Superinterfaces:

OapiBaseEntity

public interface OapiMessage
extends OapiBaseEntity

A unit to be sent on the wire between counterparties.

The following attributes and references are supported:

• Structure
• Responses
• Annotation
• Abbr Name
• Category
• Flow
• Id
• Msg Type
• Name
• Scenario

Method Summary

Modifier and Type	Method	Description
String	getAbbrName()	Returns an abbreviated name of the message.
OapiAnnotation	getAnnotation()	Returns all metadata on an element (documentation etc.).
String	getCategory()	Returns a category of the message.
String	getFlow()	Returns the name of the flow which the message is tied to.
BigInteger	getId()	Returns a unique numeric identifier.
String	getMsgType()	Returns a short name defining the message type.
String	getName()	Returns the name of the message.
OapiResponses	getResponses()	Returns actions following a received message.
String	getScenario()	Returns a use case of the message.
OapiStructure	getStructure()	Returns the structure of the message.
void	setAbbrName(String value)	Set an abbreviated name of the message.
void	setAnnotation(OapiAnnotation value)	Set all metadata on an element (documentation etc.).
void	setCategory(String value)	Set a category of the message.
void	setFlow(String value)	Set the name of the flow which the message is tied to.
void	setId(BigInteger value)	Set a unique numeric identifier.
void	setMsgType(String value)	Set a short name defining the message type.
void	setName(String value)	Set the name of the message.
void	setResponses(OapiResponses value)	Set actions following a received message.
void	setScenario(String value)	Set a use case of the message.
void	setStructure(OapiStructure value)	Set the structure of the message.

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

getStructure

OapiStructure getStructure()

Returns the structure of the message.

Returns:

the structure of the message

See Also:

• setStructure(OapiStructure)

setStructure

void setStructure(OapiStructure value)

Set the structure of the message.

Parameters:

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

See Also:

• getStructure()

getResponses

OapiResponses getResponses()

Returns actions following a received message.

Returns:

actions following a received message

See Also:

• setResponses(OapiResponses)

setResponses

void setResponses(OapiResponses value)

Set actions following a received message.

Parameters:

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

See Also:

• getResponses()

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

Returns:

an abbreviated name of the message

See Also:

• setAbbrName(String)

setAbbrName

void setAbbrName(String value)

Set an abbreviated name of the message.

Parameters:

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

See Also:

• getAbbrName()

getCategory

String getCategory()

Returns a category of the message.

Returns:

a category of the message

See Also:

• setCategory(String)

setCategory

void setCategory(String value)

Set a category of the message.

Parameters:

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

See Also:

• getCategory()

getFlow

String getFlow()

Returns the name of the flow which the message is tied to.

Returns:

the name of the flow which the message is tied to

See Also:

• setFlow(String)

setFlow

void setFlow(String value)

Set the name of the flow which the message is tied to.

Parameters:

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

See Also:

• getFlow()

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

getMsgType

String getMsgType()

Returns a short name defining the message type.

Returns:

a short name defining the message type

See Also:

• setMsgType(String)

setMsgType

void setMsgType(String value)

Set a short name defining the message type.

Parameters:

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

See Also:

• getMsgType()

getName

String getName()

Returns the name of the message.

Returns:

the name of the message

See Also:

• setName(String)

setName

void setName(String value)

Set the name of the message.

Parameters:

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

See Also:

• getName()

getScenario

String getScenario()

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

Returns:

a use case of the message

See Also:

• setScenario(String)

setScenario

void setScenario(String value)

Set a use case of the message.

Parameters:

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

See Also:

• getScenario()