org.instrumentmiddleware.cima.extension.operation
Interface ICIMAOperationExtension

All Superinterfaces:

IPlugin

All Known Implementing Classes:

AbstractMultiPollerParcelProducer, AbstractProducer, AbstractSinglePollerParcelProducer, OnDataSinglePollerParcelProducer, RegularIntervalMultiPollerParcelProducer, RegularIntervalSinglePollerParcelProducer

public interface ICIMAOperationExtension
extends IPlugin

A plugin that can process SET and GET operation on CIMA predefined variables. A class implementing this interface is a plugin that can set/get CIMA predefined variables values. Currently predefined CIMA variables are DataInterval and Endpoint.

Author:

Romain

Method Summary

org.instrumentmiddleware.cima.parcel.CimaOperationResponseType	processGetOperation(org.instrumentmiddleware.cima.parcel.CimaVariable[] variables, java.util.Calendar creationTime, ISession session, org.instrumentmiddleware.cima.parcel.CimaOperationResponseType response) Gets the given variables value.
org.instrumentmiddleware.cima.parcel.CimaOperationResponseType	processSetOperation(org.instrumentmiddleware.cima.parcel.CimaVariable[] variables, java.util.Calendar creationTime, ISession session, org.instrumentmiddleware.cima.parcel.CimaOperationResponseType response) Sets the given variables value.

Methods inherited from interface org.instrumentmiddleware.cima.plugin.IPlugin

doSubscribe, getId, getInformation, getSequenceNumber, processParcel, setStartOnLoad, start, startOnLoad, stop

Method Detail

processGetOperation

org.instrumentmiddleware.cima.parcel.CimaOperationResponseType processGetOperation(org.instrumentmiddleware.cima.parcel.CimaVariable[] variables,
                                                                                   java.util.Calendar creationTime,
                                                                                   ISession session,
                                                                                   org.instrumentmiddleware.cima.parcel.CimaOperationResponseType response)
                                                                                   throws PluginException

Gets the given variables value. The result is a parcel containing the value of given variables

Parameters:

variables - The variables to get the value from

session - The session this communication belongs to

response - response the partly built response

Returns:

a parcel containing the value of given variables

Throws:

PluginException - if something goes wrong while retrieving variables values

processSetOperation

org.instrumentmiddleware.cima.parcel.CimaOperationResponseType processSetOperation(org.instrumentmiddleware.cima.parcel.CimaVariable[] variables,
                                                                                   java.util.Calendar creationTime,
                                                                                   ISession session,
                                                                                   org.instrumentmiddleware.cima.parcel.CimaOperationResponseType response)
                                                                                   throws PluginException

Sets the given variables value.

Parameters:

variables - The variables to be set

session - The session this communication belongs to

response - The partly built response

Returns:

a parcel containing the result of set execution

Throws:

PluginException - if something goes wrong while setting variables values