com.interfaceware.iguana.plugin
Class LogQueryResult

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

public class LogQueryResult
extends java.lang.Object

This class is used to describe the result of execute.

Constructor Summary

LogQueryResult()

LogQueryResult(long Handle)

Method Summary

int	countMessages() Returns the total number of Messages.
protected void	finalize()
java.lang.String	getErrorDescription() Provides a textual description of the error which occurred if Success is false.
LogMessage	getMessage(int MessageIndex) Provides an array of LogMessage which were returned by Iguana in response to the query.
boolean	getSuccess() Indicates that the query was executed successfully.
void	release()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogQueryResult

public LogQueryResult()
               throws PluginException

Throws:

PluginException

LogQueryResult

public LogQueryResult(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

getSuccess

public boolean getSuccess()
                   throws PluginException

Indicates that the query was executed successfully.

Throws:

PluginException

getErrorDescription

public java.lang.String getErrorDescription()
                                     throws PluginException

Provides a textual description of the error which occurred if Success is false.

Throws:

PluginException

getMessage

public LogMessage getMessage(int MessageIndex)
                      throws PluginException

Provides an array of LogMessage which were returned by Iguana in response to the query.

Parameters:

MessageIndex - The index of the Message to return.

Throws:

PluginException

countMessages

public int countMessages()
                  throws PluginException

Returns the total number of Messages.

See also the Message property.

Throws:

PluginException