Interface BindingType
-
- All Known Implementing Classes:
QueryAlarmJournalBinding
,QueryAlarmStatusBinding
,QueryAlertHistoryBinding
,QueryAlertStatusBinding
,QueryAuditLogBinding
public interface BindingType
A binding type describes and implements a custom binding.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
execute(ClientContext context, GatewayInterface gi, java.util.Map<java.lang.String,java.lang.Object> params)
Execute this binding.java.lang.String
getCategoryKey()
A resource bundle key used to group this binding into a category.java.util.List<BindingParameter<?>>
getParameters()
A list of the binding parameters that this binding expects upon#execute(Map)
java.lang.Class<?>
getReturnType()
The type that this binding returns.java.lang.String
getTitleKey()
A resource bundle key used to display this binding type in the binding types listjava.lang.String
getTypeKey()
A string that uniquely identifies this binding type.
-
-
-
Method Detail
-
getTypeKey
java.lang.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
java.lang.String getTitleKey()
A resource bundle key used to display this binding type in the binding types list
-
getCategoryKey
java.lang.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
java.util.List<BindingParameter<?>> getParameters()
A list of the binding parameters that this binding expects upon#execute(Map)
-
getReturnType
java.lang.Class<?> getReturnType()
The type that this binding returns. Should be a basic scalar type, orDataset
.class
-
execute
java.lang.Object execute(ClientContext context, GatewayInterface gi, java.util.Map<java.lang.String,java.lang.Object> params) throws BindingException
Execute this binding.- Throws:
BindingException
-
-