BindingType

All Known Implementing Classes:: QueryAlarmJournalBinding, QueryAlarmStatusBinding, QueryAlertHistoryBinding, QueryAlertStatusBinding, QueryAuditLogBinding

public interface BindingType

A binding type describes and implements a custom binding.

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 #execute(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.

Method Details
- getTypeKey
  
  String getTypeKey()
  
  A string that uniquely identifies this binding type. Common convention is to have this string start with "moduleid." to avoid conflict between modules.
- getTitleKey
  
  String getTitleKey()
  
  A resource bundle key used to display this binding type in the binding types list
- getCategoryKey
  
  String getCategoryKey()
  
  A resource bundle key used to group this binding into a category. If null, this binding will be put into the "other" category.
- getParameters
  
  List<BindingParameter<?>> getParameters()
  
  A list of the binding parameters that this binding expects upon #execute(Map)
- getReturnType
  
  Class<?> getReturnType()
  
  The type that this binding returns. Should be a basic scalar type, or Dataset.class
- execute
  
  Object execute(ClientContext context, GatewayInterface gi, Map<String,Object> params) throws BindingException
  
  Execute this binding.
  
  Throws:
  
  BindingException