com.inductiveautomation.ignition.designer.db.namedquery

Class NamedQueryDesignerRpc

java.lang.Object

com.inductiveautomation.ignition.designer.db.namedquery.NamedQueryDesignerRpc

All Implemented Interfaces:

NamedQueryRpc

public class NamedQueryDesignerRpc
extends java.lang.Object
implements NamedQueryRpc

Constructor Summary

Constructors

Constructor and Description
NamedQueryDesignerRpc(DesignerContext context, Project project)

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 projectName, ProjectVersion version, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters)
java.lang.Object	execute(java.lang.String projectName, ProjectVersion version, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean useLimit, int limit) Executes a named query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NamedQueryDesignerRpc

public NamedQueryDesignerRpc(DesignerContext context,
                             Project project)

Method Detail

execute

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

Specified by:

execute in interface NamedQueryRpc

Throws:

java.lang.Exception

execute

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

Description copied from interface: NamedQueryRpc

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

Specified by:

execute in interface NamedQueryRpc

Parameters:

projectName - 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

public 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

Description copied from interface: NamedQueryRpc

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

Specified by:

execute in interface NamedQueryRpc

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.