public class JobData extends CommonData
Job
,
Developer documentation: Plug-ins, jobs and job agentsModifier and Type | Field and Description |
---|---|
private int |
activeProjectId |
private Set<ArrayDesignData> |
arrayDesigns |
private Integer |
contextItem |
private Integer |
contextType |
private Date |
created |
private Set<DerivedBioAssayData> |
derivedBioAssays |
private boolean |
dryRun |
private Date |
ended |
private int |
estimatedExecutionTime |
private String |
executeCommand |
private ExperimentData |
experiment |
private String |
externalId |
private Integer |
jobAgentId |
static int |
MAX_COMMAND_LENGTH
The maximum allowed length of the execute command.
|
static int |
MAX_EXTERNAL_ID_LENGTH
The maximum allowed length of the external ID.
|
static int |
MAX_PLUGIN_VERSION_LENGTH
The maximum allowed length of the plugin version.
|
static int |
MAX_SERVER_LENGTH
The maximum allowed length of the server name.
|
static int |
MAX_SIGNAL_TRANSPORTER_LENGTH
The maximum allowed length of the signal transporter string.
|
static int |
MAX_STACK_TRACE_LENGTH
The maximum allowed length of the stack trace message.
|
static int |
MAX_STATUS_MESSAGE_LENGTH
The maximum allowed length of the status message.
|
static int |
MAX_SUBCONTEXT_LENGTH
The maximum allowed length of the subcontext name.
|
private Set<MessageData> |
messages |
private Map<String,ParameterValueData<?>> |
parameters |
private int |
parameterVersion |
private int |
percentComplete |
private PluginConfigurationData |
pluginConfiguration |
private PluginDefinitionData |
pluginDefinition |
private String |
pluginVersion |
private int |
priority |
private Set<RawBioAssayData> |
rawBioAssays |
private boolean |
removeJobWhenFinished |
private Date |
scheduled |
private boolean |
sendMessage |
private String |
server |
private String |
signalTransporter |
private String |
stackTrace |
private Date |
started |
private int |
status |
private String |
statusMessage |
private String |
subContext |
private Set<TransformationData> |
transformations |
private int |
type |
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
Constructor and Description |
---|
JobData() |
Modifier and Type | Method and Description |
---|---|
int |
getActiveProjectId()
The ID of the project that should be made active when running this job.
|
(package private) Set<ArrayDesignData> |
getArrayDesigns()
This is the inverse end.
|
Integer |
getContextItem()
The item type of the context that was active when configuring
this job. null = no context was known
|
Integer |
getContextType()
The context type that was active when configuring
this job. 0 = single item, 1 = list
|
Date |
getCreated()
Get the date and time the job was created.
|
(package private) Set<DerivedBioAssayData> |
getDerivedBioAssays()
This is the inverse end.
|
Date |
getEnded()
Get the date and time the job was ended or null if the job hasn't ended.
|
int |
getEstimatedExecutionTime()
Get the estimated execution time of the job.
0 = <1 minute, 1 = 1 - 10 minutes, 2 = <1 hour, 3 = >1 hour
|
String |
getExecuteCommand()
The command to send to the plug-in when starting to
execute it.
|
ExperimentData |
getExperiment()
The experiment this job is a part of.
|
String |
getExternalId()
External ID of a job running on an external system.
|
Integer |
getJobAgentId()
The ID of the job agent this job should run/is running/was running on.
|
(package private) Set<MessageData> |
getMessages()
This is the inverse end.
|
Map<String,ParameterValueData<?>> |
getParameters()
The parameters for this job.
|
int |
getParameterVersion()
Get the parameter version of the configuration used for this job.
|
int |
getPercentComplete()
If the job is running, how many percent has been completed.
|
PluginConfigurationData |
getPluginConfiguration()
The plugin configuration for the plugin.
|
PluginDefinitionData |
getPluginDefinition()
The plugin that executes the job.
|
String |
getPluginVersion()
Get the version of the plugin used to execute this job at the time the
job was executed or registered.
|
int |
getPriority()
The jobs priority.
|
(package private) Set<RawBioAssayData> |
getRawBioAssays()
This is the inverse end.
|
boolean |
getRemoveJobWhenFinished()
If the core should delete the job when it's finished successfully.
|
Date |
getScheduled()
Get the date and time the job was scheduled to the job queue, or null
if it hasn't been scheduled yet.
|
boolean |
getSendMessage()
If the core should send a message to the owner when the job is finished
or not.
|
String |
getServer()
The name of the server where the job is executing.
|
String |
getSignalTransporter()
Identifies the signal transporter to use.
|
String |
getStackTrace()
Get the stack trace in case of an error
|
Date |
getStarted()
Get the date and time the job was started or null if the job hasn't been started.
|
int |
getStatus()
Get the status of the job. 1 = waiting, 2 = running, 3 = completed ok, 4 = error
|
String |
getStatusMessage()
Get a status message.
|
String |
getSubContext()
The name of the subcontext that was active whjen configuring
this job.
|
(package private) Set<TransformationData> |
getTransformations()
This is the inverse end.
|
int |
getType()
The type of job: 1 = run plugin, 2 = other
|
boolean |
isDryRun()
If the job should be/was executed as a dry-run job.
|
void |
setActiveProjectId(int activeProjectId) |
(package private) void |
setArrayDesigns(Set<ArrayDesignData> arrayDesigns) |
void |
setContextItem(Integer contextItem) |
void |
setContextType(Integer contextType) |
void |
setCreated(Date created) |
(package private) void |
setDerivedBioAssays(Set<DerivedBioAssayData> derivedBioAssays) |
void |
setDryRun(boolean dryRun) |
void |
setEnded(Date ended) |
void |
setEstimatedExecutionTime(int estimatedExecutionTime) |
void |
setExecuteCommand(String command) |
void |
setExperiment(ExperimentData experiment) |
void |
setExternalId(String externalId) |
void |
setJobAgentId(Integer jobAgentId) |
(package private) void |
setMessages(Set<MessageData> messages) |
(package private) void |
setParameters(Map<String,ParameterValueData<?>> parameters) |
void |
setParameterVersion(int parameterVersion) |
void |
setPercentComplete(int percentComplete) |
void |
setPluginConfiguration(PluginConfigurationData pluginConfiguration) |
void |
setPluginDefinition(PluginDefinitionData pluginDefinition) |
void |
setPluginVersion(String pluginVersion) |
void |
setPriority(int priority) |
(package private) void |
setRawBioAssays(Set<RawBioAssayData> rawBioAssays) |
void |
setRemoveJobWhenFinished(boolean removeJobWhenFinished) |
void |
setScheduled(Date scheduled) |
void |
setSendMessage(boolean sendMessage) |
void |
setServer(String server) |
void |
setSignalTransporter(String signalTransporter) |
void |
setStackTrace(String stackTrace) |
void |
setStarted(Date started) |
void |
setStatus(int status) |
void |
setStatusMessage(String statusMessage) |
void |
setSubContext(String subContext) |
(package private) void |
setTransformations(Set<TransformationData> transformations) |
void |
setType(int type) |
getDescription, getName, isRemoved, setDescription, setName, setRemoved
getItemKey, getProjectKey, setItemKey, setProjectKey
equals, getId, getVersion, hashCode, setId, setVersion, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getVersion
getOwner, setOwner
private int type
public static final int MAX_EXTERNAL_ID_LENGTH
private String externalId
private PluginDefinitionData pluginDefinition
private PluginConfigurationData pluginConfiguration
private ExperimentData experiment
public static final int MAX_PLUGIN_VERSION_LENGTH
private String pluginVersion
private int parameterVersion
private boolean sendMessage
private boolean removeJobWhenFinished
private int status
private boolean dryRun
public static final int MAX_COMMAND_LENGTH
private String executeCommand
public static final int MAX_STATUS_MESSAGE_LENGTH
private String statusMessage
public static final int MAX_STACK_TRACE_LENGTH
private String stackTrace
private int estimatedExecutionTime
private int percentComplete
private int priority
private int activeProjectId
private Date created
private Date scheduled
private Date started
private Date ended
public static final int MAX_SERVER_LENGTH
private String server
private Integer contextItem
private Integer contextType
public static final int MAX_SUBCONTEXT_LENGTH
private String subContext
public static final int MAX_SIGNAL_TRANSPORTER_LENGTH
private String signalTransporter
private Integer jobAgentId
private Map<String,ParameterValueData<?>> parameters
private Set<MessageData> messages
private Set<DerivedBioAssayData> derivedBioAssays
private Set<RawBioAssayData> rawBioAssays
private Set<ArrayDesignData> arrayDesigns
private Set<TransformationData> transformations
public int getType()
public void setType(int type)
public String getExternalId()
public void setExternalId(String externalId)
public PluginDefinitionData getPluginDefinition()
public void setPluginDefinition(PluginDefinitionData pluginDefinition)
public PluginConfigurationData getPluginConfiguration()
public void setPluginConfiguration(PluginConfigurationData pluginConfiguration)
public ExperimentData getExperiment()
public void setExperiment(ExperimentData experiment)
public String getPluginVersion()
public void setPluginVersion(String pluginVersion)
public int getParameterVersion()
public void setParameterVersion(int parameterVersion)
public boolean getSendMessage()
public void setSendMessage(boolean sendMessage)
public boolean getRemoveJobWhenFinished()
public void setRemoveJobWhenFinished(boolean removeJobWhenFinished)
public int getStatus()
public void setStatus(int status)
public boolean isDryRun()
public void setDryRun(boolean dryRun)
public String getExecuteCommand()
public void setExecuteCommand(String command)
public String getStatusMessage()
public void setStatusMessage(String statusMessage)
public String getStackTrace()
public void setStackTrace(String stackTrace)
public int getEstimatedExecutionTime()
public void setEstimatedExecutionTime(int estimatedExecutionTime)
public int getPercentComplete()
public void setPercentComplete(int percentComplete)
public int getPriority()
public void setPriority(int priority)
public int getActiveProjectId()
public void setActiveProjectId(int activeProjectId)
public Date getCreated()
public void setCreated(Date created)
public Date getScheduled()
public void setScheduled(Date scheduled)
public Date getStarted()
public void setStarted(Date started)
public Date getEnded()
public void setEnded(Date ended)
public String getServer()
public void setServer(String server)
public Integer getContextItem()
public void setContextItem(Integer contextItem)
public Integer getContextType()
public void setContextType(Integer contextType)
public String getSubContext()
public void setSubContext(String subContext)
public String getSignalTransporter()
public void setSignalTransporter(String signalTransporter)
public Integer getJobAgentId()
JobAgentData
since it would then be impossible to delete a job agent without also deleting
all jobs that has been running on it.public void setJobAgentId(Integer jobAgentId)
public Map<String,ParameterValueData<?>> getParameters()
void setParameters(Map<String,ParameterValueData<?>> parameters)
Set<MessageData> getMessages()
MessageData.getJob()
void setMessages(Set<MessageData> messages)
Set<DerivedBioAssayData> getDerivedBioAssays()
DerivedBioAssayData.getJob()
void setDerivedBioAssays(Set<DerivedBioAssayData> derivedBioAssays)
Set<RawBioAssayData> getRawBioAssays()
RawBioAssayData.getJob()
void setRawBioAssays(Set<RawBioAssayData> rawBioAssays)
Set<ArrayDesignData> getArrayDesigns()
ArrayDesignData.getJob()
void setArrayDesigns(Set<ArrayDesignData> arrayDesigns)
Set<TransformationData> getTransformations()
TransformationData.getJob()
void setTransformations(Set<TransformationData> transformations)