flux
Interface DatabaseConditionAction

All Superinterfaces:

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

All Known Subinterfaces:

DatabaseConditionTrigger

public interface DatabaseConditionAction
extends DatabaseActionInfo

Executes an SQL query and then, using the first row of JDBC result set information returned from the query, evaluates a condition expression to see if it is satisfied. Useful for determining when the data in a database meets certain conditions and satisfies certain criteria.

For this purpose, the database connection available to the flow context can be used, or alternately, database connection information can be provided to connect to a data source or use a direct JDBC connection.

The Database Condition 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 flag indicating whether the condition was satisfied.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Nested Class Summary

static class

DatabaseConditionAction.DatabaseConditionActionResult The result when a DatabaseConditionAction runs.

Method Summary

java.lang.String	getCondition() Returns the expression that is tested to detect when the data in a database satisfies certain criteria.
java.util.List<java.lang.Object>	getParameters() Returns the parameters for the SQL query.
java.lang.String	getQuery() Returns the SQL query that is used to detect when the data in a database satisfies certain criteria.
void	setCondition(java.lang.String condition) Sets the expression that is tested to detect when the data in a database satisfies certain criteria.
void	setParameters(java.util.List<java.lang.Object> parameters) Sets the parameters for the SQL query.
void	setQuery(java.lang.String query) Sets the SQL query that is used to detect when the data in a database satisfies certain criteria.

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

getCondition

java.lang.String getCondition()

Returns the expression that is tested to detect when the data in a database satisfies certain criteria. The syntax is similar to an SQL WHERE clause. The exact syntax is described in the Flux Manual.

Returns:

The expression that is tested to detect when the data in a database satisfies certain criteria.

getParameters

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

Returns the parameters for the SQL query.

Returns:

The parameters for the SQL query.

getQuery

java.lang.String getQuery()

Returns the SQL query that is used to detect when the data in a database satisfies certain criteria. The condition property on this action is tested using the results of this database query.

Returns:

The SQL query that is used to detect when the data in a database satisfies certain criteria.

setCondition

void setCondition(java.lang.String condition)

Sets the expression that is tested to detect when the data in a database satisfies certain criteria. The syntax is similar to an SQL WHERE clause. The exact syntax is described in the Flux Manual.

Parameters:

condition - The expression that is tested to detect when the data in a database satisfies certain criteria.

setParameters

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

Sets the parameters for the SQL query.

Parameters:

parameters - The parameters for the SQL query.

setQuery

void setQuery(java.lang.String query)

Sets the SQL query that is used to detect when the data in a database satisfies certain criteria. The condition property on this action is tested using the results of this database query.

Parameters:

query - The SQL query that is used to detect when the data in a database satisfies certain criteria.