org.youscope.common.job.basicjobs

Interface WaitJob

All Superinterfaces:

Component, EditableJobContainer, Job, JobContainer, java.rmi.Remote

public interface WaitJob
extends Job, EditableJobContainer

A job for waiting a given time. If this job has child job, it executes the child jobs first and then waits the given time minus the execution time of the child jobs. This job can thus be used to guarantee a minimum execution time of one or more jobs.

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
long	getWaitTime() Returns the time delay/sleeping period in ms when this job runs.
void	setWaitTime(long waitTime) Sets the time delay in ms.

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.job.EditableJobContainer

addJob, clearJobs, insertJob, removeJob

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

getJob, getJobs, getNumJobs

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

getWaitTime

long getWaitTime()
          throws java.rmi.RemoteException

Returns the time delay/sleeping period in ms when this job runs.

Returns:

Delay when this job runs in ms.

Throws:

java.rmi.RemoteException

setWaitTime

void setWaitTime(long waitTime)
          throws java.rmi.RemoteException,
                 MeasurementRunningException

Sets the time delay in ms.

Parameters:

waitTime - Delay in ms.

Throws:

java.rmi.RemoteException

MeasurementRunningException