Package io.streamthoughts.azkarra.api.query

Interface QueryCall<K,V>

Type Parameters:

K - type of the record-key.

V - type of the record-value.

All Superinterfaces:

Query

All Known Implementing Classes:

BaseAsyncQueryCall, DistributedQueryCall, EmptyQueryCall, LocalQueryCall, RestApiQueryCall

public interface QueryCall<K,V>
extends Query

A QueryCall is a query that has been prepared for execution.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QueryCall.QueryCallFactory	A QueryCallFactory is used to create new QueryCall.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels the QueryCall, if possible.
QueryResult<K,V>	execute(QueryOptions options)	Executes this QueryCall.
CompletableFuture<QueryResult<K,V>>	executeAsync(QueryOptions options)	Executes this QueryCall asynchronously.
void	executeAsync(QueryOptions options, Consumer<QueryResult<K,V>> resultCallback)	Executes this QueryCall asynchronously.
boolean	isCanceled()
boolean	isExecuted()
QueryCall<K,V>	renew()	Create a new, identical QueryCall to this one which can be re-executed even if this call has already been.

Methods inherited from interface io.streamthoughts.azkarra.api.query.Query

getParams, getStoreName, getStoreOperation, getStoreType

Method Detail

execute

QueryResult<K,V> execute(QueryOptions options)

Executes this QueryCall.

Parameters:

options - the options to be used.

Returns:

the QueryResult.

Throws:

IllegalStateException - when the QueryCall has already been executed.

executeAsync

CompletableFuture<QueryResult<K,V>> executeAsync(QueryOptions options)

Executes this QueryCall asynchronously.

Parameters:

options - the options to be used.

Returns:

a CompletableFuture of QueryResult.

Throws:

IllegalStateException - when the QueryCall has already been executed.

executeAsync

void executeAsync(QueryOptions options,
                  Consumer<QueryResult<K,V>> resultCallback)

Executes this QueryCall asynchronously.

Parameters:

options - the options to be used.

resultCallback - the callback to be invoked when this QueryCall complete with either a success result or a failure exception.

Throws:

IllegalStateException - when the QueryCall has already been executed.

cancel

void cancel()

Cancels the QueryCall, if possible. QueryCall that are already complete cannot be canceled.

isExecuted

boolean isExecuted()

Returns:

true if this QueryCall has already been executed.

isCanceled

boolean isCanceled()

Returns:

true if this QueryCall has already been canceled.

renew

QueryCall<K,V> renew()

Create a new, identical QueryCall to this one which can be re-executed even if this call has already been.