|
IBM Rational Functional Tester Version 8.2.1 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 |
getEventSubType()
Return the Event Sub Type |
java.lang.String |
getHeadline()
Returns the simple (one line) headline of the message being specified. |
java.util.Vector<LogMessageProperty> |
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 |
maskProperty(java.lang.String name)
Mask a property. |
void |
setCustomProperty(java.lang.String name,
java.util.HashMap<java.lang.String,java.lang.String> value)
Sets one piece of detailed custom information into the message. |
void |
setEvent(int eventCode)
Set the event code (e.g. |
void |
setEventSubType(java.lang.String eventSubType)
Set the event Sub Type |
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()
|
void |
unMaskProperty(java.lang.String name)
Unmask a property. |
| 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.Objectpublic void setResult(int resultCode)
setResult in interface ILogMessageresultCode - The message status (e.g. success)ISimpleLog.LOG_FAILURE,
ISimpleLog.LOG_PASS,
ISimpleLog.LOG_WARNING,
ISimpleLog.LOG_INFORMATIONpublic int getResult()
getResult in interface ILogMessageISimpleLog.LOG_FAILURE,
ISimpleLog.LOG_PASS,
ISimpleLog.LOG_WARNING,
ISimpleLog.LOG_INFORMATIONpublic void setEvent(int eventCode)
setEvent in interface ILogMessageeventCode - The message event (e.g. script start)ISimpleLog.EVENT_SCRIPT_START,
ISimpleLog.EVENT_SCRIPT_END,
ISimpleLog.EVENT_VP,
ISimpleLog.EVENT_GENERALpublic int getEvent()
getEvent in interface ILogMessageISimpleLog.EVENT_SCRIPT_START,
ISimpleLog.EVENT_SCRIPT_END,
ISimpleLog.EVENT_VP,
ISimpleLog.EVENT_GENERALpublic void setHeadline(java.lang.String headline)
setHeadline in interface ILogMessagenote - 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 ILogMessagename - The name of the piece of information.value - The value of the piece of information.
public void setCustomProperty(java.lang.String name,
java.util.HashMap<java.lang.String,java.lang.String> value)
setCustomProperty in interface ILogMessagename - The name of the informationvalue - The value of the information contained in a Hashmappublic void maskProperty(java.lang.String name)
maskProperty in interface ILogMessagename - public void unMaskProperty(java.lang.String name)
name - public void setProperty(LogMessageProperty property)
property - A name/value pairLogMessagePropertypublic java.lang.Object getPropertyValue(java.lang.String name)
getPropertyValue in interface ILogMessagename - The name of the piece of information.
public java.util.Vector<LogMessageProperty> getProperties()
getProperties in interface ILogMessagepublic java.lang.String getEventSubType()
getEventSubType in interface ILogMessagepublic void setEventSubType(java.lang.String eventSubType)
eventSubType -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||