|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Msg Data Element'.
The MsgDataElement represents the data that is used to specify all of the related information that is associated with the message that this event holds.
The following features are supported:
EventPackage.getMsgDataElement()
Method Summary | |
---|---|
MsgCatalogToken |
addMsgCatalogToken(MsgCatalogToken value)
Adds a new MsgCatalogToken to this object. |
MsgCatalogToken |
addMsgCatalogTokenAsString(java.lang.String value)
Adds a new MsgCatalogToken to this object. |
void |
clearMsgCatalogTokens()
Removes all msgCatalogTokens that this event is referencing |
java.lang.String |
getMsgCatalog()
Returns the value of the 'Msg Catalog' attribute. |
java.lang.String |
getMsgCatalogId()
Returns the value of the 'Msg Catalog Id' attribute. |
org.eclipse.emf.common.util.EList |
getMsgCatalogTokens()
Returns the value of the 'Msg Catalog Tokens' containment reference list. |
java.lang.String[] |
getMsgCatalogTokensAsStrings()
Returns the value of the 'Msg Catalog Tokens' attribute list. |
java.lang.String |
getMsgCatalogType()
Returns the value of the 'Msg Catalog Type' attribute. |
java.lang.String |
getMsgId()
Returns the value of the 'Msg Id' attribute. |
java.lang.String |
getMsgIdType()
Returns the value of the 'Msg Id Type' attribute. |
java.lang.String |
getMsgLocale()
Returns the value of the 'Msg Locale' attribute. |
void |
init()
Resets the object's properties to their initial (e.g. |
void |
setMsgCatalog(java.lang.String value)
Sets the value of the ' Msg Catalog ' attribute. |
void |
setMsgCatalogId(java.lang.String value)
Sets the value of the ' Msg Catalog Id ' attribute. |
void |
setMsgCatalogTokens(MsgCatalogToken[] msgCatalogTokens)
Sets the value of the 'Msg Catalog Tokens' attribute list. |
void |
setMsgCatalogTokensAsStrings(java.lang.String[] msgCatalogTokens)
Sets the value of the 'Msg Catalog Tokens' attribute list. |
void |
setMsgCatalogType(java.lang.String value)
Sets the value of the ' Msg Catalog Type ' attribute. |
void |
setMsgId(java.lang.String value)
Sets the value of the ' Msg Id ' attribute. |
void |
setMsgIdType(java.lang.String value)
Sets the value of the ' Msg Id Type ' attribute. |
void |
setMsgLocale(java.lang.String value)
Sets the value of the ' Msg Locale ' attribute. |
void |
validate()
Checks whether the contents of this object conforms to the CBE specification. |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Method Detail |
public java.lang.String getMsgIdType()
Returns the value of the 'Msg Id Type' attribute.
setMsgIdType(String)
,
EventPackage.getMsgDataElement_MsgIdType()
public void setMsgIdType(java.lang.String value)
Msg Id Type
' attribute.
Specifies the meaning and format of the msgId. If the msgId conforms to or represents a standard or a well-known convention, it is named by this property. Examples are: "IBM3.4", "IBM4.4", "IBM3.1.4", "IBM3.4.1", "IBM4.4.1", and "IBM3.1.4.1".
The nonexclusive reserved keywords include:
value
- the new value of the 'Msg Id Type' attribute.getMsgIdType()
public java.lang.String getMsgCatalogType()
Returns the value of the 'Msg Catalog Type' attribute.
setMsgCatalogType(String)
,
EventPackage.getMsgDataElement_MsgCatalogType()
public void setMsgCatalogType(java.lang.String value)
Msg Catalog Type
' attribute.
The msgCatalogType property specifies the meaning and format of the msgCatalog. The current nonexclusive list of reserved keywords includes:
value
- the new value of the 'Msg Catalog Type' attribute.getMsgCatalogType()
public java.lang.String getMsgCatalog()
Returns the value of the 'Msg Catalog' attribute.
setMsgCatalog(String)
,
EventPackage.getMsgDataElement_MsgCatalog()
public void setMsgCatalog(java.lang.String value)
Msg Catalog
' attribute.
The qualified name of the message catalog that contains the translated message specified by the msgCatalogId.
This is an optional property. The string length of the msgCatalog must not exceed 128 characters.
value
- the new value of the 'Msg Catalog' attribute.getMsgCatalog()
public java.lang.String getMsgCatalogId()
Returns the value of the 'Msg Catalog Id' attribute.
setMsgCatalogId(String)
,
EventPackage.getMsgDataElement_MsgCatalogId()
public void setMsgCatalogId(java.lang.String value)
Msg Catalog Id
' attribute.
The index or the identifier for a message that is used for resolving the message text from a message catalog.
This is an optional property. The string length for this property must not exceed 64 characters.
value
- the new value of the 'Msg Catalog Id' attribute.getMsgCatalogId()
public java.lang.String getMsgId()
Returns the value of the 'Msg Id' attribute.
setMsgId(String)
,
EventPackage.getMsgDataElement_MsgId()
public void setMsgId(java.lang.String value)
Msg Id
' attribute.
Specifies the message identifier of the event. This identifier should be a unique value string of alphanumeric or numeric characters. It can be as simple as a string of numeric characters that identify a message in a message catalog or a multi-part string of alphanumeric characters (for example, DBT1234E).
This is an optional property. The string length for msgId must not exceed 256 characters.
value
- the new value of the 'Msg Id' attribute.getMsgId()
public java.lang.String getMsgLocale()
Returns the value of the 'Msg Locale' attribute.
setMsgLocale(String)
,
EventPackage.getMsgDataElement_MsgLocale()
public void setMsgLocale(java.lang.String value)
Msg Locale
' attribute.
The locale for which this msg property is rendered. Its value is a locale code that conforms to IETF RFC 1766.
This is an optional property.
value
- the new value of the 'Msg Locale' attribute.getMsgLocale()
public org.eclipse.emf.common.util.EList getMsgCatalogTokens()
MsgCatalogToken
.
An array of strings used as substitution values for resolving an internationalized message into formatted text. The order of the substitution values is implied by the implicit order of the array elements.
If there are no substitution values, then msgCatalogTokens does not need to be specified.
This is an optional property. The string length for the msgCatalogTokens property must not exceed 256 characters per token.
EventPackage.getMsgDataElement_MsgCatalogTokens()
public MsgCatalogToken addMsgCatalogTokenAsString(java.lang.String value)
MsgCatalogToken
to this object.
It creates a MsgCatalogToken
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
value
- the String
value for the new message
catalog token.
MsgCatalogToken
public MsgCatalogToken addMsgCatalogToken(MsgCatalogToken value)
MsgCatalogToken
to this object.
It creates a MsgCatalogToken
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
value
- the MsgCatalogToken
value.
MsgCatalogToken
public void clearMsgCatalogTokens()
public java.lang.String[] getMsgCatalogTokensAsStrings()
Each string corresponds to the value
attribute of a
MsgCatalogToken
inside the message catalog token list.
getMsgCatalogTokens()
,
setMsgCatalogTokensAsStrings(String[])
public void setMsgCatalogTokensAsStrings(java.lang.String[] msgCatalogTokens)
Each string is translated to the value
attribute of a
MsgCatalogToken
to be added to the message catalog token
list.
Any prior message catalog token is removed before the new list is set.
msgCatalogTokens
- array of values for the message catalog tokensgetMsgCatalogTokens()
,
getMsgCatalogTokensAsStrings()
public void setMsgCatalogTokens(MsgCatalogToken[] msgCatalogTokens)
Each string is translated to the value
attribute of a
MsgCatalogToken
to be added to the message catalog token
list.
Any prior message catalog token is removed before the new list is set.
msgCatalogTokens
- array of values for the message catalog tokensgetMsgCatalogTokens()
,
getMsgCatalogTokensAsStrings()
public void validate() throws ValidationException
Checks whether the contents of this object conforms to the CBE specification.
ValidationException
- if the object does not follow the
CBE specification.public void init()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |