com.ibm.etools.logging.pd.artifacts
Class PD_Message

java.lang.Object
  |
  +--com.ibm.etools.logging.pd.artifacts.PD_BaseProblemArtifact
        |
        +--com.ibm.etools.logging.pd.artifacts.PD_ProblemArtifact
              |
              +--com.ibm.etools.logging.pd.artifacts.PD_Message

public class PD_Message
extends PD_ProblemArtifact


Constructor Summary
PD_Message()
          PD_Message constructors
 
Method Summary
 long getElapsedTime()
          Gets the value of the elapsedTime instance variable.
 java.lang.String getLocaleOfOrigin()
          Gets the value of the localeOfOrigin instance variable.
 java.lang.String getLocaleOfText()
          Gets the value of the localeOfText instance variable.
 int getMessageCount()
          Gets the value of the messageCount instance variable.
 java.lang.String getMessageTypeID()
          Gets the value of the messageTypeID instance variable.
 java.lang.String getOtherTypeIDFormat()
          Gets the value of the otherTypeIDFormat instance variable.
 java.lang.String getSeverity()
          Gets the value of the severity instance variable.
 java.lang.String getSourceID()
          Gets the value of the sourceID instance variable.
 java.lang.String getText()
          Gets the value of the text instance variable.
 java.lang.String[] getTokens()
          Gets the value of the tokens instance variable.
 java.lang.String getTypeIDFormat()
          Gets the value of the typeIDFormat instance variable.
 java.lang.String getUniqueInstanceID()
          Gets the value of the uniqueInstanceID instance variable.
 void init()
          Initializes the object to a newly constructed state.
 void regenerateUniqueInstanceID()
          Regenerates a new unique instance ID for the object.
 void setElapsedTime(long pd_Message_elapsedTime)
          Sets value of the elapsedTime instance variable to the specified value.
 void setLocaleOfOrigin(java.lang.String pd_Message_localeOfOrigin)
          Sets value of the localeOfOrigin instance variable to the specified value.
 void setLocaleOfText(java.lang.String pd_Message_localeOfText)
          Sets value of the localeOfText instance variable to the specified value.
 void setMessageCount(int pd_Message_messageCount)
          Sets value of the messageCount instance variable to the specified value.
 void setMessageTypeID(java.lang.String pd_Message_messageTypeID)
          Sets value of the messageTypeID instance variable to the specified value.
 void setOtherTypeIDFormat(java.lang.String pd_Message_otherTypeIDFormat)
          Sets value of the otherTypeIDFormat instance variable to the specified value.
 void setSeverity(java.lang.String pd_Message_severity)
          Sets value of the severity instance variable to the specified value.
 void setSourceID(java.lang.String pd_Message_sourceID)
          Sets value of the sourceID instance variable to the specified value.
 void setText(java.lang.String pd_Message_text)
          Sets value of the text instance variable to the specified value.
 void setTokens(java.lang.String[] pd_Message_tokens)
          Sets value of the tokens instance variable to the specified value.
 void setTypeIDFormat(java.lang.String pd_Message_typeIDFormat)
          Sets value of the typeIDFormat instance variable to the specified value.
 java.lang.String toCanonicalXMLString()
          Creates the canonical XML representation of this object.
 
Methods inherited from class com.ibm.etools.logging.pd.artifacts.PD_ProblemArtifact
getArtifactCausesArtifactRefList, getArtifactContainsArtifactsRefList, getCorrelationTypeList, getLogRecordCorrelator, getProblemArtifactTokenList, getRawData, setArtifactCausesArtifactRefList, setArtifactContainsArtifactsRefList, setCorrelationTypeList, setLogRecordCorrelator, setProblemArtifactTokenList, setRawData
 
Methods inherited from class com.ibm.etools.logging.pd.artifacts.PD_BaseProblemArtifact
getArtifactCreatorID, getArtifactEncodingFormat, getCreationTime, getHostID, getHostIDFormat, getId, getOtherHostIDFormat, getProcessID, getThreadID, setArtifactCreatorID, setArtifactEncodingFormat, setCreationTime, setHostID, setHostIDFormat, setId, setOtherHostIDFormat, setProcessID, setThreadID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PD_Message

public PD_Message()
PD_Message constructors

Method Detail

getUniqueInstanceID

public java.lang.String getUniqueInstanceID()
Gets the value of the uniqueInstanceID instance variable.

Overrides:
getUniqueInstanceID in class PD_ProblemArtifact
Returns:
The value of the uniqueInstanceID instance variable.

setMessageTypeID

public void setMessageTypeID(java.lang.String pd_Message_messageTypeID)
Sets value of the messageTypeID instance variable to the specified value.

Parameters:
pd_Message_messageTypeID - The new value of the messageTypeID instance variable.

getMessageTypeID

public java.lang.String getMessageTypeID()
Gets the value of the messageTypeID instance variable.

Returns:
The value of the messageTypeID instance variable, or null if the value of the messageTypeID instance variable has not been set or is set to null.

setTypeIDFormat

public void setTypeIDFormat(java.lang.String pd_Message_typeIDFormat)
Sets value of the typeIDFormat instance variable to the specified value.

Parameters:
pd_Message_typeIDFormat - The new value of the typeIDFormat instance variable.

getTypeIDFormat

public java.lang.String getTypeIDFormat()
Gets the value of the typeIDFormat instance variable.

Returns:
The value of the typeIDFormat instance variable, or null if the value of the typeIDFormat instance variable has not been set or is set to null.

setOtherTypeIDFormat

public void setOtherTypeIDFormat(java.lang.String pd_Message_otherTypeIDFormat)
Sets value of the otherTypeIDFormat instance variable to the specified value.

Parameters:
pd_Message_otherTypeIDFormat - The new value of the otherTypeIDFormat instance variable.

getOtherTypeIDFormat

public java.lang.String getOtherTypeIDFormat()
Gets the value of the otherTypeIDFormat instance variable.

Returns:
The value of the otherTypeIDFormat instance variable, or null if the value of the otherTypeIDFormat instance variable has not been set or is set to null.

setSourceID

public void setSourceID(java.lang.String pd_Message_sourceID)
Sets value of the sourceID instance variable to the specified value.

Parameters:
pd_Message_sourceID - The new value of the sourceID instance variable.

getSourceID

public java.lang.String getSourceID()
Gets the value of the sourceID instance variable.

Returns:
The value of the sourceID instance variable, or null if the value of the sourceID instance variable has not been set or is set to null.

setSeverity

public void setSeverity(java.lang.String pd_Message_severity)
Sets value of the severity instance variable to the specified value.

Parameters:
pd_Message_severity - The new value of the severity instance variable.

getSeverity

public java.lang.String getSeverity()
Gets the value of the severity instance variable.

Returns:
The value of the severity instance variable, or null if the value of the severity instance variable has not been set or is set to null.

setText

public void setText(java.lang.String pd_Message_text)
Sets value of the text instance variable to the specified value.

Parameters:
pd_Message_text - The new value of the text instance variable.

getText

public java.lang.String getText()
Gets the value of the text instance variable.

Returns:
The value of the text instance variable, or null if the value of the text instance variable has not been set or is set to null.

setLocaleOfText

public void setLocaleOfText(java.lang.String pd_Message_localeOfText)
Sets value of the localeOfText instance variable to the specified value.


getLocaleOfText

public java.lang.String getLocaleOfText()
Gets the value of the localeOfText instance variable.

Returns:
The value of the localeOfText instance variable, or null if the value of the localeOfText instance variable has not been set or is set to null.

setLocaleOfOrigin

public void setLocaleOfOrigin(java.lang.String pd_Message_localeOfOrigin)
Sets value of the localeOfOrigin instance variable to the specified value.


getLocaleOfOrigin

public java.lang.String getLocaleOfOrigin()
Gets the value of the localeOfOrigin instance variable.

Returns:
The value of the localeOfOrigin instance variable, or null if the value of the localeOfOrigin instance variable has not been set or is set to null.

setMessageCount

public void setMessageCount(int pd_Message_messageCount)
Sets value of the messageCount instance variable to the specified value.


getMessageCount

public int getMessageCount()
Gets the value of the messageCount instance variable.

Returns:
The value of the messageCount instance variable, or null if the value of the messageCount instance variable has not been set or is set to null.

setElapsedTime

public void setElapsedTime(long pd_Message_elapsedTime)
Sets value of the elapsedTime instance variable to the specified value.


getElapsedTime

public long getElapsedTime()
Gets the value of the elapsedTime instance variable.

Returns:
The value of the elapsedTime instance variable, or null if the value of the elapsedTime instance variable has not been set or is set to null.

setTokens

public void setTokens(java.lang.String[] pd_Message_tokens)
Sets value of the tokens instance variable to the specified value.

Parameters:
pd_Message_tokens - The new value of the tokens instance variable.

getTokens

public java.lang.String[] getTokens()
Gets the value of the tokens instance variable.

Returns:
The value of the tokens instance variable, or null if the value of the tokens instance variable has not been set or is set to null.

toCanonicalXMLString

public java.lang.String toCanonicalXMLString()
Creates the canonical XML representation of this object.

Overrides:
toCanonicalXMLString in class PD_ProblemArtifact
Returns:
the canonical XML representation of this object

regenerateUniqueInstanceID

public void regenerateUniqueInstanceID()
Regenerates a new unique instance ID for the object.

Overrides:
regenerateUniqueInstanceID in class PD_ProblemArtifact

init

public void init()
Initializes the object to a newly constructed state. NOTE: To reuse the object without calling the init() API, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.

Overrides:
init in class PD_ProblemArtifact