public class TaskConfiguration extends java.lang.Object implements JobContainerConfiguration, Configuration
Constructor and Description |
---|
TaskConfiguration() |
Modifier and Type | Method and Description |
---|---|
void |
addJob(JobConfiguration job)
Adds a job to the job list.
|
void |
addJob(JobConfiguration job,
int index)
Adds a job to the job list.
|
void |
checkConfiguration()
Checks the current state of the configuration.
|
void |
clearJobs()
Removes all jobs from the job list.
|
java.lang.Object |
clone() |
java.lang.String |
getDescription()
Returns a description of this task
|
JobConfiguration[] |
getJobs()
Returns the job list which might be edited by the caller.
|
PeriodConfiguration |
getPeriod() |
java.lang.String |
getTypeIdentifier()
Returns a unique identifier for this configuration type.
|
void |
removeJobAt(int index)
Removes the job at the given index.
|
void |
setJobs(JobConfiguration[] jobs)
Sets the job list to the given list.
|
void |
setPeriod(PeriodConfiguration period) |
public JobConfiguration[] getJobs()
JobContainerConfiguration
getJobs
in interface JobContainerConfiguration
public void setJobs(JobConfiguration[] jobs)
JobContainerConfiguration
setJobs
in interface JobContainerConfiguration
jobs
- New job list.public void addJob(JobConfiguration job)
JobContainerConfiguration
addJob
in interface JobContainerConfiguration
job
- Job to be added.public void clearJobs()
JobContainerConfiguration
clearJobs
in interface JobContainerConfiguration
public void removeJobAt(int index)
JobContainerConfiguration
removeJobAt
in interface JobContainerConfiguration
index
- Index of the job to be removed.public void addJob(JobConfiguration job, int index)
JobContainerConfiguration
addJob
in interface JobContainerConfiguration
job
- Job to be added.index
- Index where the job should be added.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public java.lang.String getDescription()
public void setPeriod(PeriodConfiguration period)
period
- the period to setpublic PeriodConfiguration getPeriod()
public java.lang.String getTypeIdentifier()
Configuration
getTypeIdentifier
in interface Configuration
public void checkConfiguration() throws ConfigurationException
Configuration
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).checkConfiguration
in interface Configuration
ConfigurationException