Package com.inductiveautomation.factorypmi.application.binding

Class QueryAlarmJournalBinding

java.lang.Object

com.inductiveautomation.factorypmi.application.binding.QueryAlarmJournalBinding

All Implemented Interfaces:

BindingType

public class QueryAlarmJournalBinding
extends Object
implements BindingType

Constructor Summary

Constructors

Constructor	Description
QueryAlarmJournalBinding()
QueryAlarmJournalBinding(AlarmingRpc rpc)

Method Summary

Modifier and Type	Method	Description
Object	execute(ClientContext context, GatewayInterface gi, Map<String,Object> params)	Execute this binding.
String	getCategoryKey()	A resource bundle key used to group this binding into a category.
List<BindingParameter<?>>	getParameters()	A list of the binding parameters that this binding expects upon BindingType.execute(ClientContext, GatewayInterface, Map)
Class<?>	getReturnType()	The type that this binding returns.
String	getTitleKey()	A resource bundle key used to display this binding type in the binding types list
String	getTypeKey()	A string that uniquely identifies this binding type.

Methods inherited from class java.lang.Object

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

Constructor Details

QueryAlarmJournalBinding

public QueryAlarmJournalBinding(AlarmingRpc rpc)

QueryAlarmJournalBinding

public QueryAlarmJournalBinding()

Method Details

execute

public Object execute(ClientContext context,
 GatewayInterface gi,
 Map<String,Object> params)
               throws BindingException

Description copied from interface: BindingType

Execute this binding.

Specified by:

execute in interface BindingType

Parameters:

context - The client context.

gi - The gateway interface.

params - The parameters for the binding execution.

Returns:

The result of the binding execution.

Throws:

BindingException - If an error occurs during binding execution.

getCategoryKey

public String getCategoryKey()

Description copied from interface: BindingType

A resource bundle key used to group this binding into a category. If null, this binding will be put into the "other" category.

Specified by:

getCategoryKey in interface BindingType

getParameters

public List<BindingParameter<?>> getParameters()

Description copied from interface: BindingType

A list of the binding parameters that this binding expects upon BindingType.execute(ClientContext, GatewayInterface, Map)

Specified by:

getParameters in interface BindingType

getReturnType

public Class<?> getReturnType()

Description copied from interface: BindingType

The type that this binding returns. Should be a basic scalar type, or Dataset.class

Specified by:

getReturnType in interface BindingType

getTitleKey

public String getTitleKey()

Description copied from interface: BindingType

A resource bundle key used to display this binding type in the binding types list

Specified by:

getTitleKey in interface BindingType

getTypeKey

public String getTypeKey()

Description copied from interface: BindingType

A string that uniquely identifies this binding type. Common convention is to have this string start with "moduleid." to avoid conflict between modules.

Specified by:

getTypeKey in interface BindingType