|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AsyncDataSource
Field Summary | |
---|---|
static int |
QUERY_CANCELED Status in which the query execution was canceled. |
static int |
QUERY_EXECUTING Status in which the query is currently being run. |
static int |
QUERY_FAILED Status in which the query failed to complete its execution. |
static int |
QUERY_NEEDS_CONFIRMATION Status in which the query has been paused for user input. |
static int |
QUERY_NEEDS_EXECUTING Status in which data is not yet available because the query has not yet been run. |
static int |
QUERY_NEEDS_PARAMETERS Status in which the query's parameters have no values or invalid values. |
static int |
QUERY_NOT_DEFINED Status in which the specified query does not exist |
static int |
QUERY_RESULTS_READY Status in which the query has successfully completed. |
static int |
QUERY_SCHEDULED Status in which the query has been placed on the queue in preparation for being executed. |
static int |
QUERY_VALIDATING Status in which the parameters of the query are being validated. |
static long |
UNKNOWN_TIME Constant representing an unknown duration of time. |
Method Summary | |
---|---|
void |
cancelQueryExecution() Attempts to cancel the execution of this data source's query. |
void |
continueQueryExecution() Continues execution of the query after confirmation was requested. |
void |
fetchEstimate() Causes the estimated query running time to be synchronously computed. |
int |
getEstimatedRunningTime() Returns the estimated length of time in milliseconds for the QUERY_EXECUTING state. |
int |
getEstimatedTimeToDataAvailability() Returns the number of milliseconds until this AsyncDataSource's query and all DataSources prior to it have completed executing. |
BIException[] |
getExecutionErrors() Returns errors associated with the most recent query execution attempt. |
int |
getStatus() Returns the status of this AsyncDataSource's query. |
boolean |
isLinkedTo(AsyncDataSource targetDataSource) Determines if this DataSource and the targetDataSource are linked to the same query. |
boolean |
linkTo(AsyncDataSource targetDataSource) Makes this AsyncDataSource link to the targetDataSource . |
void |
notifyListenersIfDataAvailable() Prepares this AsyncDataSource for proper rendering. |
void |
scheduleQueryExecution(boolean autoConfirm) Places the query on the queue for execution |
Field Detail |
---|
static final long UNKNOWN_TIME
getEstimatedTimeToDataAvailablity
or getEstimatedRunTime()
static final int QUERY_NOT_DEFINED
static final int QUERY_NEEDS_PARAMETERS
static final int QUERY_NEEDS_EXECUTING
static final int QUERY_SCHEDULED
static final int QUERY_NEEDS_CONFIRMATION
continueQueryExecution
or cancelQueryExecution
.
static final int QUERY_EXECUTING
static final int QUERY_RESULTS_READY
static final int QUERY_FAILED
static final int QUERY_CANCELED
static final int QUERY_VALIDATING
Method Detail |
---|
void scheduleQueryExecution(boolean autoConfirm) throws DataException
autoConfirm
- true to automatically confirm the continuation of query execution; false to allow the user or client to continue or cancel query execution. If false, the status may move to QUERY_NEEDS_CONFIRMATION
. In general, true should be used only for batch processing, such as printing and exporting.DataException
void continueQueryExecution() throws DataException
QUERY_NEEDS_CONFIRMATION
and the user approves the execution of a long-running query.DataException
QUERY_NEEDS_CONFIRMATION
void cancelQueryExecution()
int getStatus()
QUERY_
void fetchEstimate() throws DataException
DataException
int getEstimatedTimeToDataAvailability() throws DataException
DataException
int getEstimatedRunningTime() throws DataException
QUERY_EXECUTING
state. Returns UNKNOWN_TIME
if the estimated time for this AsyncDataSource has not yet been fetched.DataException
void notifyListenersIfDataAvailable() throws DataException
If the query has not changed since this method was last called, then this does nothing. Otherwise, this method updates the DataDirector and DataAccess with the latest query results and fires DataChangedEvents to registered DataDirectorListeners.
DataException
boolean isLinkedTo(AsyncDataSource targetDataSource)
boolean linkTo(AsyncDataSource targetDataSource) throws DataException
targetDataSource
.DataException
- The targetDataSource and this data source can not be linked for some reasonBIException[] getExecutionErrors()
QUERY_FAILED
or QUERY_NEEDS_PARAMETERS
, these errors explain why the query was unable to return results.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |