org.instrumentmiddleware.cima.extension.operation
Interface ICommandEnable

All Superinterfaces:

IPlugin

All Known Implementing Classes:

ExampleOperationPlugin

public interface ICommandEnable
extends IPlugin

A plugin that can receive command. A class implementing this interface is a plugin that can process command operation. The command is then executed locally or sent to the device.

Author:

Romain

Method Summary

org.instrumentmiddleware.cima.parcel.CommandOperationResponseType

processCommandOperation(org.instrumentmiddleware.cima.parcel.CommandType operation, java.util.Calendar creationTime, ISession session, org.instrumentmiddleware.cima.parcel.CommandOperationResponseType response) Process the command.

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

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

Method Detail

processCommandOperation

org.instrumentmiddleware.cima.parcel.CommandOperationResponseType processCommandOperation(org.instrumentmiddleware.cima.parcel.CommandType operation,
                                                                                          java.util.Calendar creationTime,
                                                                                          ISession session,
                                                                                          org.instrumentmiddleware.cima.parcel.CommandOperationResponseType response)
                                                                                          throws PluginException

Process the command. The response returned is a parcel containing the result of the command execution.

Parameters:

operation - The command to process and execute

session - The session this communication belongs to

response - The partly built response

Returns:

a parcel containing the result of the command execution

Throws:

PluginException - if something goes wrong while processing the command