Package de.xima.fc.e2e.environment.api

Interface IFormcycleQueryExecutor

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FormcycleQueryExecutor

public interface IFormcycleQueryExecutor
extends AutoCloseable

Query executor that allows to retrieve data from the currently running formcycle app. Note that no formcycle classes are used since those exist only within the isolated servlet container context.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
<Params extends IFormcycleQueryParams,Result extends IFormcycleQueryResult,Query extends IFormcycleQuery<Params,Result>> List<Result>	executeQuery(Class<Query> queryType, Params params)	Executes a generic query against the running formcycle app.
List<FormRecordData>	getAllFormRecordsByClient(long clientId)
List<FormRecordData>	getAllFormRecordsByForm(long clientId, long formId)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

executeQuery

<Params extends IFormcycleQueryParams,Result extends IFormcycleQueryResult,Query extends IFormcycleQuery<Params,Result>> List<Result> executeQuery(Class<Query> queryType,
                                                                                                                                                                     Params params)
                                                                                                                                                              throws FormcycleQueryExecutionFailedException

Executes a generic query against the running formcycle app.

Type Parameters:

Params - Type of the query data.

Result - Type of the response data.

Parameters:

queryType - Type of the query descriptor.

params - Query data to send.

Returns:

The resulting of all responses to the query from all listeners.

Throws:

FormcycleQueryExecutionFailedException - When the query failed to execute.

getAllFormRecordsByClient

List<FormRecordData> getAllFormRecordsByClient(long clientId)
                                        throws FormcycleQueryExecutionFailedException

Parameters:

clientId - ID of a client.

Returns:

A list of all form records for the given client.

Throws:

FormcycleQueryExecutionFailedException - When the query could not be executed.

getAllFormRecordsByForm

List<FormRecordData> getAllFormRecordsByForm(long clientId,
                                             long formId)
                                      throws FormcycleQueryExecutionFailedException

Parameters:

clientId - ID of a client.

formId - The ID of a form.

Returns:

A list of all form records for the given client and form.

Throws:

FormcycleQueryExecutionFailedException - When the query could not be executed.