flux

Interface DatabaseQueryCollectionAction

All Superinterfaces:

Action, java.lang.Cloneable, DatabaseActionInfo, RuntimeDataMap, java.io.Serializable

public interface DatabaseQueryCollectionAction
extends DatabaseActionInfo

Executes an SQL query in the engine's database and makes the resulting JDBC result set available (as a list) to flow chart actions.

When this action runs, it returns a list representation of the JDBC result set.

The Database Query Collection Action returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.

Flow Context Variable	Field	Java Type	Description
RESULT	result	boolean	A boolean value indicating whether there are more results available in the underlying JDBC result set.
RESULT	rows	java.util.List<java.lang.Object>	A List representing the rows in the result set.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DatabaseQueryCollectionAction.DatabaseQueryCollectionActionResult A list returned over a JDBC result set that is returned after this action runs.

Method Summary

Modifier and Type	Method and Description
Flow	addFlow(Action action) The flow that is followed when this Database Query Collection Action fires.
java.util.List<java.lang.Object>	getParameters() Returns the parameters for the SQL query to be executed.
java.lang.String	getQuery() Returns the SQL query that is used to query a database.
void	setParameters(java.util.List<java.lang.Object> parameters) Sets the parameters for the SQL query to be executed.
void	setQuery(java.lang.String query) Sets the SQL query that is used to query a database.

Methods inherited from interface flux.DatabaseActionInfo

getDataSource, getDataSourceInitialContextFactory, getDataSourceInitialContextPassword, getDataSourceInitialContextProviderUrl, getDataSourceInitialContextUsername, getDataSourcePassword, getDataSourceUsername, getJdbcDriver, getJdbcPassword, getJdbcUrl, getJdbcUsername, isBuiltinDatabaseConnectionUsed, setBuiltinDatabaseConnectionUsed, setDataSource, setDataSourceInitialContextFactory, setDataSourceInitialContextPassword, setDataSourceInitialContextProviderUrl, setDataSourceInitialContextUsername, setDataSourcePassword, setDataSourceUsername, setJdbcDriver, setJdbcPassword, setJdbcUrl, setJdbcUsername

Methods inherited from interface flux.Action

addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

addFlow

Flow addFlow(Action action)

The flow that is followed when this Database Query Collection Action fires. Delegates to addFlow(Action, EngineHelper.useLastResult("result")).

To add a flow that is followed under different conditions with this Database Query Collection Action, use a different flow condition by calling addFlow(Action action, String condition). For example, to unconditionally follow a flow to a certain action, call DatabaseQueryCollectionAction.addFlow(action, "true").

Note that with actions other than Database Query Collection Action, addFlow(Action) may not delegate to addFlow(Action, EngineHelper.useLastResult("result")). Most actions do not delegate in this manner. When using these other actions, use caution to ensure the flow condition is as intended.

Specified by:

addFlow in interface Action

Parameters:

action - The flow that is followed when this Database Query Action fires.

Returns:

The newly created flow.

See Also:

Action.addFlow(Action, String), EngineHelper.useLastResult(String)

getParameters

java.util.List<java.lang.Object> getParameters()

Returns the parameters for the SQL query to be executed.

Returns:

The parameters for the SQL query to be executed.

getQuery

java.lang.String getQuery()

Returns the SQL query that is used to query a database.

Returns:

The SQL query that is used to query a database.

setParameters

void setParameters(java.util.List<java.lang.Object> parameters)

Sets the parameters for the SQL query to be executed.

Parameters:

parameters - The parameters for the SQL query to be executed.

setQuery

void setQuery(java.lang.String query)

Sets the SQL query that is used to query a database.

Parameters:

query - The query that is used to query a database.