org.youscope.plugin.devicejob

Class DeviceJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.devicejob.DeviceJobConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Configuration, TableConsumerConfiguration

public class DeviceJobConfiguration
extends JobConfiguration
implements TableConsumerConfiguration

This job/task changes device settings.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
DeviceJobConfiguration	clone()
TableDefinition	getConsumedTableDefinition() Returns a information about the layout of the tables which are consumed by the TableConsumer, e.g.
java.lang.String	getDescription() Returns a short description of this job.
DeviceSetting[]	getDeviceSettings() Returns the device settings which should be activated by the job.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setDeviceSettings(DeviceSetting... deviceSettings) Sets the device settings which should be activated by the job.

Methods inherited from class org.youscope.common.job.JobConfiguration

toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceJobConfiguration

public DeviceJobConfiguration()

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from class: JobConfiguration

Returns a short description of this job.

Specified by:

getDescription in class JobConfiguration

Returns:

Short description of the job.

clone

public DeviceJobConfiguration clone()

Overrides:

clone in class JobConfiguration

setDeviceSettings

public void setDeviceSettings(DeviceSetting... deviceSettings)
                       throws java.lang.NullPointerException

Sets the device settings which should be activated by the job.

Parameters:

deviceSettings - Device settings which should be set when job is activated.

Throws:

java.lang.NullPointerException - Thrown if deviceSettings is null, or element of deviceSettings is null.

getDeviceSettings

public DeviceSetting[] getDeviceSettings()

Returns the device settings which should be activated by the job.

Returns:

settings which should be set when job is activated.

getTypeIdentifier

public java.lang.String getTypeIdentifier()

Description copied from interface: Configuration

Returns a unique identifier for this configuration type. The identifier is used to determine factories and addons to construct and configure jobs, measurements, etc., given a corresponding configuration. Make sure that the ID returned is unique. The returned identifier should conform to "XXX.YYY", where XXX stands for an identifier of the organizational unit or the person who created the configuration (e.g. ETH, Smith, Cindarella), and YYY stands for an identifier of the specific kind of configuration (e.g. AutofocusJob, PlatePosition, MicroplateMeasurement). Optionally, additional hierarchy levels can be defined by additional separators ., e.g. "YouScope.AutofocusJob.Version1.1" The identifier should not contain spaces, non-ASCII characters, or colons (except for hierarchy level separation). Identifiers should start with a capital character, i.e. A-Z. Make sure to not use the same identifier for different configurations, since this might result in unexpected behavior or errors. Make

Specified by:

getTypeIdentifier in interface Configuration

Returns:

Unique identifier of the configuration type.

getConsumedTableDefinition

public TableDefinition getConsumedTableDefinition()

Description copied from interface: TableConsumerConfiguration

Returns a information about the layout of the tables which are consumed by the TableConsumer, e.g. the number and types of columns.

Specified by:

getConsumedTableDefinition in interface TableConsumerConfiguration

Returns:

Information about of the layout of the consumed tables.

checkConfiguration

public void checkConfiguration()
                        throws ConfigurationException

Description copied from interface: Configuration

Checks the current state of the configuration. If the configuration state is valid, the method returns normally. If not, a ConfigurationException is thrown describing the error, and what has to be changed in the configuration, by the user, such that it becomes valid. This error can then e.g. be displayed to the user (see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).

Specified by:

checkConfiguration in interface Configuration

Overrides:

checkConfiguration in class JobConfiguration

Throws:

ConfigurationException