org.youscope.common.job.basicjobs

Interface DeviceSettingJob

All Superinterfaces:

Component, Job, java.rmi.Remote, TableConsumer

public interface DeviceSettingJob
extends Job, TableConsumer

Author:

Moritz Lang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TYPE_IDENTIFIER The type identifier of the default implementation of this job.

Method Summary

Modifier and Type	Method and Description
void	addDeviceSetting(java.lang.String device, java.lang.String property, java.lang.String value) Adds a new device setting.
void	clearDeviceSettings() Removes all settings.
DeviceSetting[]	getDeviceSettings() Returns the device settings made when job runs.
void	setDeviceSettings(DeviceSetting[] settings) Sets the device settings made when job runs.

Methods inherited from interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Methods inherited from interface org.youscope.common.table.TableConsumer

consumeTable, getConsumedTableDefinition

Field Detail

DEFAULT_TYPE_IDENTIFIER

static final java.lang.String DEFAULT_TYPE_IDENTIFIER

The type identifier of the default implementation of this job. Basic jobs are considered such essential to YouScope such that their interfaces are made part of the shared library. However, their implementation are not, and there might be several addons providing (different) implementations of this job. Most of these implementations, however, are specific for a given application and not general. The addon exposing this identifier should be general, that is, every other part of YouScope accessing this job over the default identifier is expecting the job to behave in the general way. Only one implementation (addon) should expose the default identifier. Typically, this implementation is already part of YouScope, such that implementing this addon is not necessary. However, there might be cases when the default implementation should be overwritten, which is why the interface, but not the implementation is part of YouScope's core elements. In this case, the default implementation already part of YouScope should be removed (i.e. the corresponding default plug-in deleted).

See Also:

Constant Field Values

Method Detail

getDeviceSettings

DeviceSetting[] getDeviceSettings()
                           throws java.rmi.RemoteException

Returns the device settings made when job runs.

Returns:

List of device settings.

Throws:

java.rmi.RemoteException

setDeviceSettings

void setDeviceSettings(DeviceSetting[] settings)
                throws java.rmi.RemoteException,
                       MeasurementRunningException

Sets the device settings made when job runs.

Parameters:

settings - List of device settings.

Throws:

java.rmi.RemoteException

MeasurementRunningException

clearDeviceSettings

void clearDeviceSettings()
                  throws java.rmi.RemoteException,
                         MeasurementRunningException

Removes all settings.

Throws:

java.rmi.RemoteException

MeasurementRunningException

addDeviceSetting

void addDeviceSetting(java.lang.String device,
                      java.lang.String property,
                      java.lang.String value)
               throws java.rmi.RemoteException,
                      MeasurementRunningException

Adds a new device setting.

Parameters:

device - Name of the device.

property - Name of the device's property.

value - Value to set device's property to.

Throws:

java.rmi.RemoteException

MeasurementRunningException