com.kapowtech.robosuite.api.java.rql.engine

Interface RQLEngine

All Known Implementing Classes:

AbstractRQLEngine, ClientSideDistributingRQLEngine, DeploymentSupportRQLEngine, RemoteRQLEngine

public interface RQLEngine

Represents an engine that generates a number of RQLResponses when it receives a RQLRequest.

The implementation must be thread safe. Also implementing classes must conform exactly to the contract provided for the request method.

Method Summary

Modifier and Type	Method and Description
java.util.List<RQLResponse>	request(RQLRequest request, RQLHandler handler) Executes an RQLRequest.

Method Detail

request

java.util.List<RQLResponse> request(RQLRequest request,
                                    RQLHandler handler)
                             throws RQLException

Executes an RQLRequest.

The request method executes synchronously. It blocks until the request has been processed or a fatal error has stopped the execution.

Parameters:

request - the request that will be executed.

handler - receives notification of generated RQLResponses or exceptions. It can be null, meaning that both RQLResponses and exceptions are ignored.

Returns:

a list of RQLResponses generated from the request.

Throws:

java.lang.NullPointerException - if the request parameter is null.

RQLException - if a serious error occurs when trying to process the request.