DispatchCallback (sqlline 1.11.0 API)

java.lang.Object

sqlline.DispatchCallback

public class DispatchCallback
extends java.lang.Object

Callback.

Constructor Summary

Constructors

Constructor Description

DispatchCallback()

Method Summary

Modifier and Type	Method	Description
`void`	`forceKillSqlQuery()`	If a statement has been set by `trackSqlQuery(java.sql.Statement)` then calls `Statement.cancel()` on it.
`sqlline.DispatchCallback.Status`	`getStatus()`
`boolean`	`isCanceled()`
`boolean`	`isFailure()`
`boolean`	`isRunning()`
`boolean`	`isSuccess()`
`void`	`setStatus(sqlline.DispatchCallback.Status status)`
`void`	`setToCancel()`
`void`	`setToFailure()`
`void`	`setToSuccess()`
`void`	`trackSqlQuery(java.sql.Statement statement)`	Sets the sql statement the callback should keep track of so that it can be canceled.

Methods inherited from class java.lang.Object

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

Constructor Details
- DispatchCallback
  
  public DispatchCallback()
Method Details
- trackSqlQuery
  
  public void trackSqlQuery(java.sql.Statement statement)
  
  Sets the sql statement the callback should keep track of so that it can be canceled.
  
  Parameters:
  
  statement - the statement to track
- setToSuccess
  
  public void setToSuccess()
- isSuccess
  
  public boolean isSuccess()
- setToFailure
  
  public void setToFailure()
- isFailure
  
  public boolean isFailure()
- isRunning
  
  public boolean isRunning()
- setToCancel
  
  public void setToCancel()
- isCanceled
  
  public boolean isCanceled()
- forceKillSqlQuery
  
  public void forceKillSqlQuery() throws java.sql.SQLException
  
  If a statement has been set by trackSqlQuery(java.sql.Statement) then calls Statement.cancel() on it. As with Statement.cancel() the effect of calling this is dependent on the underlying DBMS and driver.
  
  Throws:
  
  java.sql.SQLException - on database error
- getStatus
  
  public sqlline.DispatchCallback.Status getStatus()
- setStatus
  
  public void setStatus(sqlline.DispatchCallback.Status status)