com.inductiveautomation.ignition.common.db.namedquery

Interface NamedQueryRpc

All Known Implementing Classes:

NamedQueryClientRpc, NamedQueryDesignerRpc

public interface NamedQueryRpc

This allows NamedQueries to use unsaved queries in the Designer (so other resources can use them without forcing a save), but not the Client.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	execute(java.lang.String project, NamedQuery query, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean useLimit, int limit) This overload is used by the Designer to run unsaved versions of queries.
java.lang.Object	execute(java.lang.String project, ProjectVersion version, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters)
java.lang.Object	execute(java.lang.String project, ProjectVersion version, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean useLimit, int limit) Executes a named query.

Method Detail

execute

java.lang.Object execute(java.lang.String project,
                         ProjectVersion version,
                         java.lang.String queryPath,
                         java.util.Map<java.lang.String,java.lang.Object> parameters)
                  throws java.lang.Exception

Throws:

java.lang.Exception

execute

java.lang.Object execute(java.lang.String project,
                         ProjectVersion version,
                         java.lang.String queryPath,
                         java.util.Map<java.lang.String,java.lang.Object> parameters,
                         boolean useLimit,
                         int limit)
                  throws java.lang.Exception

Executes a named query. useLimit/limit overload for user testing of queries.

Parameters:

project - The project name.

version - Staging or published

queryPath - Full query path

parameters - Optional query parameters

useLimit - Testing may limit the number of results. Default true.

limit - If useLimit, the limit to use, else ignored.

Returns:

Result of the query. May be null or empty.

Throws:

java.lang.Exception - Throws exception if path not found or sql error.

execute

java.lang.Object execute(java.lang.String project,
                         NamedQuery query,
                         java.util.Map<java.lang.String,java.lang.Object> parameters,
                         boolean useLimit,
                         int limit)
                  throws java.lang.Exception

This overload is used by the Designer to run unsaved versions of queries. Returns null in the client context.

Parameters:

project - The project name.

query - A named query resource.

parameters - Map of parameter values

useLimit - Testing may limit the number of results. Default true.

limit - If useLimit, the limit to use, else ignored.

Returns:

Result of the query. May be null or empty.

Throws:

java.lang.Exception - Throws exception if path not found or sql error.