com.interfaceware.iguana.plugin
Class LogMessage

java.lang.Object
  com.interfaceware.iguana.plugin.LogMessage

public class LogMessage
extends java.lang.Object

This class is used to represent an individual Iguana log message.

Constructor Summary

LogMessage()

LogMessage(long Handle)

Method Summary

protected void	finalize()
java.lang.String	getChannelName() Provides the name of the source channel associated with the message, or an empty string if the message is not associated with a specific channel.
java.lang.String	getContent() Provides the full body of the message.
boolean	getDeleted() This flag is set if the message has been deleted through Iguana dashboard by an administrator.
boolean	getIsResubmission() This flag is set if this message is a re-submission of an earlier message.
boolean	getMarkedError() This flag is set if this error has been marked (acknowledged) through Iguana dashboard by an administrator.
java.lang.String	getMessageLogId() Provides the ID that is used to uniquely identify this message.
java.lang.String	getMessageType() Provides the type of this message (Message/Ack/Success/Warning/Error/Info/Debug)
int	getMilliseconds() Provides the number of milliseconds (0-999) associated with the TimeStamp property.
java.lang.String	getReferenceLogId() Provides the ID of the parent of this message.
boolean	getResubmitted() This flag is set if this message is the original of a separate resubmitted message.
java.util.Date	getTimeStamp() Provides a timestamp of the message with second precision.
void	release()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogMessage

public LogMessage()
           throws PluginException

Throws:

PluginException

LogMessage

public LogMessage(long Handle)
           throws PluginException

Throws:

PluginException

Method Detail

release

public void release()
             throws PluginException

Throws:

PluginException

finalize

protected void finalize()
                 throws PluginException

Overrides:

finalize in class java.lang.Object

Throws:

PluginException

getChannelName

public java.lang.String getChannelName()
                                throws PluginException

Provides the name of the source channel associated with the message, or an empty string if the message is not associated with a specific channel.

Throws:

PluginException

getMessageType

public java.lang.String getMessageType()
                                throws PluginException

Provides the type of this message (Message/Ack/Success/Warning/Error/Info/Debug)

Throws:

PluginException

getContent

public java.lang.String getContent()
                            throws PluginException

Provides the full body of the message.

Throws:

PluginException

getMessageLogId

public java.lang.String getMessageLogId()
                                 throws PluginException

Provides the ID that is used to uniquely identify this message. This ID can be used to query related messages.

Throws:

PluginException

getReferenceLogId

public java.lang.String getReferenceLogId()
                                   throws PluginException

Provides the ID of the parent of this message. It will be empty if there is no parent.

Throws:

PluginException

getTimeStamp

public java.util.Date getTimeStamp()
                            throws PluginException

Provides a timestamp of the message with second precision. Milliseconds are available via the Milliseconds property.

Throws:

PluginException

getMilliseconds

public int getMilliseconds()
                    throws PluginException

Provides the number of milliseconds (0-999) associated with the TimeStamp property.

Throws:

PluginException

getDeleted

public boolean getDeleted()
                   throws PluginException

This flag is set if the message has been deleted through Iguana dashboard by an administrator.

Throws:

PluginException

getMarkedError

public boolean getMarkedError()
                       throws PluginException

This flag is set if this error has been marked (acknowledged) through Iguana dashboard by an administrator. (Only applicable to message type Error)

Throws:

PluginException

getResubmitted

public boolean getResubmitted()
                       throws PluginException

This flag is set if this message is the original of a separate resubmitted message. (Only applicable to message Type Message)

Throws:

PluginException

getIsResubmission

public boolean getIsResubmission()
                          throws PluginException

This flag is set if this message is a re-submission of an earlier message. (Only applicable to message Type Message)

Throws:

PluginException