BEAST
eu.baltrad.beast.adaptor.IAdaptorConfigurationManager Interface Reference

Defines what is nessecary in order to be able to configure and persist adaptor configurations. More...

Inheritance diagram for eu.baltrad.beast.adaptor.IAdaptorConfigurationManager:
eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager

Public Member Functions

String getType ()
 Returns the type that is managed by this configuration manager.
 
IAdaptorConfiguration createConfiguration (String name)
 Creates a new instance of an adaptor configuration.
 
IAdaptor store (int id, IAdaptorConfiguration configuration)
 Persists the adaptor configuration.
 
IAdaptor update (int id, IAdaptorConfiguration configuration)
 Updates the adaptor configuration for the specified adaptor id.
 
void remove (int id)
 Removes the adaptor configuration.
 
IAdaptor read (int id, String name)
 Reads the adaptor from the database.
 

Detailed Description

Defines what is nessecary in order to be able to configure and persist adaptor configurations.

Author
Anders Henja

Member Function Documentation

◆ createConfiguration()

IAdaptorConfiguration eu.baltrad.beast.adaptor.IAdaptorConfigurationManager.createConfiguration ( String name)

Creates a new instance of an adaptor configuration.

Parameters
namethe name of the adaptor that should be created
Returns
a new adaptor configuration

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager.

◆ getType()

String eu.baltrad.beast.adaptor.IAdaptorConfigurationManager.getType ( )

Returns the type that is managed by this configuration manager.

Returns
the type

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager.

◆ read()

IAdaptor eu.baltrad.beast.adaptor.IAdaptorConfigurationManager.read ( int id,
String name )

Reads the adaptor from the database.

the id and name are the unique identifiers defining the adaptor (from the BltAdaptorManager point of view).

Parameters
idthe unique id
namethe unique name
Returns
the read adaptor
Exceptions
AdaptorExceptionif it is not possible to read the specified adaptor

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager.

◆ remove()

void eu.baltrad.beast.adaptor.IAdaptorConfigurationManager.remove ( int id)

Removes the adaptor configuration.

Parameters
idthe configuration that should be removed

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager.

◆ store()

IAdaptor eu.baltrad.beast.adaptor.IAdaptorConfigurationManager.store ( int id,
IAdaptorConfiguration configuration )

Persists the adaptor configuration.

Parameters
idthe unique id that defines this adaptor
configurationthe configuration
Returns
a new adaptor on success
Exceptions
AdaptorExceptionon failure

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager.

◆ update()

IAdaptor eu.baltrad.beast.adaptor.IAdaptorConfigurationManager.update ( int id,
IAdaptorConfiguration configuration )

Updates the adaptor configuration for the specified adaptor id.

Parameters
idthe adaptor id
configurationthe configuration
Returns
the updated adaptor (or a new one, implementation specific)

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcConfigurationManager.


The documentation for this interface was generated from the following file: