TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.hyades.models.cbe
Interface CBEMsgDataElement

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
CBEMsgDataElementImpl

public interface CBEMsgDataElement
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Msg Data Element'. When an event is used to represent a message, a message data element captures the several parts of the message information. For example "RDB2742E: an Error was detected in foo indicating that bar had problems" which has a msg id as well as substituted "foo" and "bar" variables.

The following features are supported:

See Also:
CBEPackage.getCBEMsgDataElement()
Generated
[EMF] Model

Field Summary
static java.lang.String copyright
           
 
Method Summary
 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' 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 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 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
 
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
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Generated
Method Detail

getMsgId

java.lang.String getMsgId()
Returns the value of the 'Msg Id' attribute.

If the meaning of the 'Msg Id' attribute isn't clear, there really should be more of a description here...

ZThis is where you would find the RDB1234E string that identifies the message.

Returns:
the value of the 'Msg Id' attribute.
See Also:
setMsgId(String), CBEPackage.getCBEMsgDataElement_MsgId()
Generated
[EMF] Model

setMsgId

void setMsgId(java.lang.String value)
Sets the value of the 'Msg Id' attribute.

Parameters:
value - the new value of the 'Msg Id' attribute.
See Also:
getMsgId()
Generated

getMsgIdType

java.lang.String getMsgIdType()
Returns the value of the 'Msg Id Type' attribute.

If the meaning of the 'Msg Id Type' attribute isn't clear, there really should be more of a description here...

the id type is used to indicate the structure of the message id. for example IBM341 indicates a 3 charactercomponent id (RDB), a 4 charcter number (1234), and a 1 character severity level (E) making up the example RDB1234E.

Returns:
the value of the 'Msg Id Type' attribute.
See Also:
setMsgIdType(String), CBEPackage.getCBEMsgDataElement_MsgIdType()
Generated
[EMF] Model

setMsgIdType

void setMsgIdType(java.lang.String value)
Sets the value of the 'Msg Id Type' attribute.

Parameters:
value - the new value of the 'Msg Id Type' attribute.
See Also:
getMsgIdType()
Generated

getMsgCatalogId

java.lang.String getMsgCatalogId()
Returns the value of the 'Msg Catalog Id' attribute.

If the meaning of the 'Msg Catalog Id' attribute isn't clear, there really should be more of a description here...

A

Returns:
the value of the 'Msg Catalog Id' attribute.
See Also:
setMsgCatalogId(String), CBEPackage.getCBEMsgDataElement_MsgCatalogId()
Generated
[EMF] Model

setMsgCatalogId

void setMsgCatalogId(java.lang.String value)
Sets the value of the 'Msg Catalog Id' attribute.

Parameters:
value - the new value of the 'Msg Catalog Id' attribute.
See Also:
getMsgCatalogId()
Generated

getMsgCatalogTokens

org.eclipse.emf.common.util.EList getMsgCatalogTokens()
Returns the value of the 'Msg Catalog Tokens' attribute list. The list contents are of type String.

If the meaning of the 'Msg Catalog Tokens' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Msg Catalog Tokens' attribute list.
See Also:
CBEPackage.getCBEMsgDataElement_MsgCatalogTokens()
Generated
[EMF] Model
type="java.lang.String"

getMsgCatalog

java.lang.String getMsgCatalog()
Returns the value of the 'Msg Catalog' attribute.

If the meaning of the 'Msg Catalog' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Msg Catalog' attribute.
See Also:
setMsgCatalog(String), CBEPackage.getCBEMsgDataElement_MsgCatalog()
Generated
[EMF] Model

setMsgCatalog

void setMsgCatalog(java.lang.String value)
Sets the value of the 'Msg Catalog' attribute.

Parameters:
value - the new value of the 'Msg Catalog' attribute.
See Also:
getMsgCatalog()
Generated

getMsgLocale

java.lang.String getMsgLocale()
Returns the value of the 'Msg Locale' attribute.

If the meaning of the 'Msg Locale' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Msg Locale' attribute.
See Also:
setMsgLocale(String), CBEPackage.getCBEMsgDataElement_MsgLocale()
Generated
[EMF] Model

setMsgLocale

void setMsgLocale(java.lang.String value)
Sets the value of the 'Msg Locale' attribute.

Parameters:
value - the new value of the 'Msg Locale' attribute.
See Also:
getMsgLocale()
Generated

getMsgCatalogType

java.lang.String getMsgCatalogType()
Returns the value of the 'Msg Catalog Type' attribute.

If the meaning of the 'Msg Catalog Type' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Msg Catalog Type' attribute.
See Also:
setMsgCatalogType(String), CBEPackage.getCBEMsgDataElement_MsgCatalogType()
Generated
[EMF] Model

setMsgCatalogType

void setMsgCatalogType(java.lang.String value)
Sets the value of the 'Msg Catalog Type' attribute.

Parameters:
value - the new value of the 'Msg Catalog Type' attribute.
See Also:
getMsgCatalogType()
Generated

TPTP 4.5.0 Platform Project
Public API Specification