| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IResultInstance
Represents a result in SQL Results View. There are two groups of methods defined in this interface: ResultsViewAPI.
 An instance of IResultInstance contains a list of ResultItem instances and a list of
 Parameter instances.
Parameter, 
ResultItem| Method Summary | |
|---|---|
|  int | calculateStatus()Calculates the status of this result instance based on the status of its sub-results | 
|  void | createSubResult(OperationCommand cmd,
                java.lang.Runnable terminateHandler)Creates a sub results | 
|  void | dispose()Disposes resources after the instance terminated. | 
|  java.util.Date | getExecuteDate()Returns the date-time this result instance was created | 
|  java.lang.String | getExecuteTime()Returns the time in string this result instance was created | 
|  java.lang.Throwable[] | getFailThrowables()Returns the exceptions thrown when generating the result instance | 
|  int | getFrequency()Returns the execution frequency | 
|  ResultItem | getItem(int index)Returns the result item at given index (base on 0) | 
|  int | getItemCount()Returns number of result items. | 
|  OperationCommand | getOperationCommand()Returns the operation command that produces this result instance. | 
|  java.util.List | getParameters()Returns the parameters | 
|  IResultInstance | getParentResult()Returns the parent result of this result | 
|  int | getStatus()Returns the current status. | 
|  java.util.List | getSubResults()Returns the sub-results of this result | 
|  boolean | hasTerminateHandler()Checks if there is a terminate handler | 
|  void | increaseFrequency()Inceases the execution frequency by 1, will only be called when this instance is re-executing | 
|  boolean | isFinished()Checks if this result is finished | 
|  boolean | isMayHaveSubResults()Return the current flag value which indicates that this IResultInstance object may have sub results. | 
|  boolean | isParentResult()Checks if the result instance is a parent result | 
|  void | morePlainMessage(java.lang.String text)Appends a plain message. | 
|  void | moreResultItem(ResultItem item)Appends a new result item. | 
|  void | moreResultSet(IResultSetObject resultset)Appends a new result set. | 
|  void | moreResultSet(java.sql.ResultSet resultset)Appends a new result set. | 
|  void | moreStatusMessage(java.lang.String message)Appends a status message, which will be displayed on 'Status' tab when using multiple tabs display mode | 
|  void | moreThrowable(java.lang.Throwable th)Appends an exception | 
|  void | moreUpdateCount(int updateCount)Appends a new update count. | 
|  void | resetInstance()Clears all the result items and parameters | 
|  void | setMayHaveSubResults(boolean flag)Set new value to the flag which indicates that this IResultInstance object may have sub results. | 
|  void | showParameters(java.util.List params)Shows the given parameters on SQL Results View | 
|  void | terminate()Terminates the instance. | 
|  void | updateStatus(int status)Updates the status of this result instance | 
| Method Detail | 
|---|
void morePlainMessage(java.lang.String text)
text - the plain messagevoid moreStatusMessage(java.lang.String message)
message - the status messagevoid moreUpdateCount(int updateCount)
updateCount - the update countvoid updateStatus(int status)
status - the new statusOperationCommand.STATUS_STARTED, 
OperationCommand.STATUS_RUNNING, 
OperationCommand.STATUS_SUCCEEDED, 
OperationCommand.STATUS_FAILED, 
OperationCommand.STATUS_TERMINATED, 
OperationCommand.STATUS_WARNING, 
OperationCommand.STATUS_CRITICAL_ERRORvoid showParameters(java.util.List params)
params - the Parameter instances listParameter
void moreResultSet(java.sql.ResultSet resultset)
                   throws java.sql.SQLException
resultset - instance of JDBC ResultSet
java.sql.SQLException - - if a database access error occursvoid moreResultSet(IResultSetObject resultset)
resultset - the IResultSetObject instancevoid moreResultItem(ResultItem item)
item - the result itemOperationCommand getOperationCommand()
int getItemCount()
ResultItem getItem(int index)
index - the index
int getStatus()
OperationCommand.STATUS_RUNNING, 
OperationCommand.STATUS_SUCCEEDED, 
OperationCommand.STATUS_FAILED, 
OperationCommand.STATUS_TERMINATED, 
OperationCommand.STATUS_STARTED, 
OperationCommand.STATUS_CRITICAL_ERROR, 
OperationCommand.STATUS_WARNINGboolean isFinished()
true if this instance finishsvoid terminate()
void dispose()
java.lang.String getExecuteTime()
java.util.Date getExecuteDate()
void resetInstance()
boolean hasTerminateHandler()
true if there is a terminate handlerjava.util.List getParameters()
Parameter instances listint getFrequency()
void increaseFrequency()
java.lang.Throwable[] getFailThrowables()
void moreThrowable(java.lang.Throwable th)
th - the exceptionjava.util.List getSubResults()
void createSubResult(OperationCommand cmd,
                     java.lang.Runnable terminateHandler)
cmd - the operation request object of the new resultterminateHandler - the terminate handlerIResultInstance getParentResult()
boolean isParentResult()
true if it is a parent result, false if it is a sub-resultint calculateStatus()
boolean isMayHaveSubResults()
void setMayHaveSubResults(boolean flag)
flag - the new flag value| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||