com.rational.test.ft.services

Interface ILogMessage

All Known Implementing Classes:

LogMessageAdapter

public interface ILogMessage

Contains the base-level information that can be sent in a message to the log.

Since:

RFT1.0

Method Summary

Modifier and Type	Method and Description
int	getEvent() Returns the event code.
java.lang.String	getEventSubType() Returns the subType of the event for custom participants
java.lang.String	getHeadline() Returns the simple, one-line description of the message being specified.
java.util.Vector	getProperties() Returns the properties of this log 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.
void	maskProperty(java.lang.String name) Mask a property that it need not be persisted
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) Sets the event code.
void	setHeadline(java.lang.String headline) Sets a simple, one-line description of the message being specified.
void	setProperty(java.lang.String name, java.lang.Object value) Sets one piece of detailed information into the message.
void	setResult(int resultCode) Sets the message status.

Method Detail

setResult

void setResult(int resultCode)

Sets the message status. This is one of the ILog.LOG_ codes.

Parameters:

resultCode - The message status (for example, success)

Since:

RFT1.0

See Also:

ISimpleLog.LOG_FAILURE, ISimpleLog.LOG_PASS, ISimpleLog.LOG_WARNING, ISimpleLog.LOG_INFORMATION

getResult

int getResult()

Returns the message status. This is one of the ILog.LOG_ codes.

Since:

RFT1.0

See Also:

ISimpleLog.LOG_FAILURE, ISimpleLog.LOG_PASS, ISimpleLog.LOG_WARNING, ISimpleLog.LOG_INFORMATION

setEvent

void setEvent(int eventCode)

Sets the event code. This is one of the ILog.EVENT_ codes.

Parameters:

eventCode - The message event (for example, script start)

Since:

RFT1.0

See Also:

ISimpleLog.EVENT_SCRIPT_START, ISimpleLog.EVENT_SCRIPT_END, ISimpleLog.EVENT_VP, ISimpleLog.EVENT_GENERAL

getEvent

int getEvent()

Returns the event code. This is one of the ILog.EVENT_ codes.

Since:

RFT1.0

See Also:

ISimpleLog.EVENT_SCRIPT_START, ISimpleLog.EVENT_SCRIPT_END, ISimpleLog.EVENT_VP, ISimpleLog.EVENT_GENERAL

setHeadline

void setHeadline(java.lang.String headline)

Sets a simple, one-line description of the message being specified.

Parameters:

headline - The simple message

Since:

RFT1.0

getHeadline

java.lang.String getHeadline()

Returns the simple, one-line description of the message being specified.

Since:

RFT1.0

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)

Sets one piece of detailed information into the message. Detailed information is specified by using name/value pairs.

Parameters:

name - The name of the information

value - The value of the information

Since:

RFT1.0

setCustomProperty

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. Detailed information is specified by using name/value pairs

Parameters:

name - The name of the information

value - The value of the information

maskProperty

void maskProperty(java.lang.String name)

Mask a property that it need not be persisted

getPropertyValue

java.lang.Object getPropertyValue(java.lang.String name)

Returns the value of one piece of detailed information from the message.

Parameters:

name - The name of the piece of information

Returns:

null is returned if the name is not found.

Since:

RFT1.0

getProperties

java.util.Vector getProperties()

Returns the properties of this log message.

Since:

RFT1.0

getEventSubType

java.lang.String getEventSubType()

Returns the subType of the event for custom participants

Returns:

the String