Package com.inductiveautomation.ignition.client.gateway_interface.messages

Class RunPrepStmtMessage

java.lang.Object

com.inductiveautomation.ignition.client.gateway_interface.messages.MessageBuilder

com.inductiveautomation.ignition.client.gateway_interface.messages.RunPrepStmtMessage

All Implemented Interfaces:

GatewayInterface.MessagePrinter

public class RunPrepStmtMessage
extends MessageBuilder

Builds the proper message to invoke the RunPrepStmt function

Constructor Summary

Constructors

Constructor	Description
RunPrepStmtMessage(String query)

Method Summary

Modifier and Type	Method	Description
RunPrepStmtMessage	database(String database)
RunPrepStmtMessage	getIds(boolean getIds)
int	getMinConnectionMode()	Minimum connection mode needed to run, or zero to always run.
RunPrepStmtMessage	queryArgs(Object... args)	Sets the query arguments.
RunPrepStmtMessage	skipAudit(boolean skipAudit)
RunPrepStmtMessage	transactionId(String txId)

Methods inherited from class com.inductiveautomation.ignition.client.gateway_interface.messages.MessageBuilder

arg, arg, build, getStatMetric, printMessage

Methods inherited from class java.lang.Object

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

Constructor Details

RunPrepStmtMessage

public RunPrepStmtMessage(String query)

Method Details

queryArgs

public RunPrepStmtMessage queryArgs(Object... args)
                             throws GatewayException

Sets the query arguments. These must be serializable as they'll be serialized to send to the gateway.

Throws:

GatewayException

database

public RunPrepStmtMessage database(String database)

transactionId

public RunPrepStmtMessage transactionId(String txId)

getIds

public RunPrepStmtMessage getIds(boolean getIds)

skipAudit

public RunPrepStmtMessage skipAudit(boolean skipAudit)

getMinConnectionMode

public int getMinConnectionMode()

Description copied from interface: GatewayInterface.MessagePrinter

Minimum connection mode needed to run, or zero to always run.

Specified by:

getMinConnectionMode in interface GatewayInterface.MessagePrinter

Overrides:

getMinConnectionMode in class MessageBuilder