|
IBM Rational Functional Tester Version 8.1.1000 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.rational.test.ft.services.LogMessageAdapter
public class LogMessageAdapter
The base implementation of the log message.
Constructor Summary | |
---|---|
LogMessageAdapter()
Create a log message with default values. |
|
LogMessageAdapter(int resultCode)
Create a log message with a specified status. |
|
LogMessageAdapter(int resultCode,
int eventCode)
Create a log message with a specified status and event. |
|
LogMessageAdapter(int resultCode,
int eventCode,
java.lang.String headline)
Create a log message with a specified status, event, and brief message. |
Method Summary | |
---|---|
int |
getEvent()
Returns the event code (e.g. |
java.lang.String |
getHeadline()
Returns the simple (one line) headline of the message being specified. |
java.util.Vector |
getProperties()
Return the properties of this message. |
java.lang.Object |
getPropertyValue(java.lang.String name)
Returns the value of one piece of detailed information from the message. |
int |
getResult()
Returns the message status (e.g. |
void |
setEvent(int eventCode)
Set the event code (e.g. |
void |
setHeadline(java.lang.String headline)
Set a simple (one line) headline of the message being specified. |
void |
setProperty(LogMessageProperty property)
Set one piece of detailed information into the message. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set one piece of detailed information into the message. |
void |
setResult(int resultCode)
Set the message status (e.g. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LogMessageAdapter()
public LogMessageAdapter(int resultCode)
resultCode
- The message status (e.g. success)public LogMessageAdapter(int resultCode, int eventCode)
resultCode
- The message status (e.g. success)eventCode
- The message event (e.g. script start)public LogMessageAdapter(int resultCode, int eventCode, java.lang.String headline)
resultCode
- The message status (e.g. success)eventCode
- The message event (e.g. script start)headline
- A simple (one line) headline of the
message being specified.Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public void setResult(int resultCode)
setResult
in interface ILogMessage
resultCode
- The message status (e.g. success)ISimpleLog.LOG_FAILURE
,
ISimpleLog.LOG_PASS
,
ISimpleLog.LOG_WARNING
,
ISimpleLog.LOG_INFORMATION
public int getResult()
getResult
in interface ILogMessage
ISimpleLog.LOG_FAILURE
,
ISimpleLog.LOG_PASS
,
ISimpleLog.LOG_WARNING
,
ISimpleLog.LOG_INFORMATION
public void setEvent(int eventCode)
setEvent
in interface ILogMessage
eventCode
- The message event (e.g. script start)ISimpleLog.EVENT_SCRIPT_START
,
ISimpleLog.EVENT_SCRIPT_END
,
ISimpleLog.EVENT_VP
,
ISimpleLog.EVENT_GENERAL
public int getEvent()
getEvent
in interface ILogMessage
ISimpleLog.EVENT_SCRIPT_START
,
ISimpleLog.EVENT_SCRIPT_END
,
ISimpleLog.EVENT_VP
,
ISimpleLog.EVENT_GENERAL
public void setHeadline(java.lang.String headline)
setHeadline
in interface ILogMessage
note
- The simple headline.public java.lang.String getHeadline()
getHeadline
in interface ILogMessage
public void setProperty(java.lang.String name, java.lang.Object value)
setProperty
in interface ILogMessage
name
- The name of the piece of information.value
- The value of the piece of information.public void setProperty(LogMessageProperty property)
property
- A name/value pairLogMessageProperty
public java.lang.Object getPropertyValue(java.lang.String name)
getPropertyValue
in interface ILogMessage
name
- The name of the piece of information.
public java.util.Vector getProperties()
getProperties
in interface ILogMessage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |