Job (DAISY Pipeline 2 :: Java Client Library 4.3.0 API)

java.lang.Object
- org.daisy.pipeline.client.models.Job

All Implemented Interfaces:

Comparable<Job>
```
public class Job
extends Object
implements Comparable<Job>
```
A representation of a Pipeline 2 job. This represents a job both before (job request) and after (job response) it is submitted to the engine.

Author:

jostein

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Job.Priority

static class Job.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`Job.Priority`
`static class`	`Job.Status`

Constructor Summary

Constructors
Constructor and Description

Job()
Create an empty representation of a job.

Job(Node jobXml)
Parse the job described by the provided XML document/node.

Constructors
Constructor and Description
`Job()` Create an empty representation of a job.
`Job(Node jobXml)` Parse the job described by the provided XML document/node.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Job o)`
`Argument`	`getArgument(String name)`
`List<Argument>`	`getArguments()` Get all arguments, both inputs and outputs.
`String`	`getBatchId()`
`List<Callback>`	`getCallback()`
`String`	`getDescription()`
`String`	`getHref()`
`String`	`getId()`
`List<Argument>`	`getInputs()`
`JobStorage`	`getJobStorage()`
`String`	`getLogHref()`
`List<Message>`	`getMessages()` Get a list of all messages for the job.
`String`	`getNicename()`
`List<Argument>`	`getOutputs()`
`Job.Priority`	`getPriority()`
`Result`	`getResult()` Get the main Result object.
`Result`	`getResult(String argumentName)` Get the Result representing the argument with the given name.
`Result`	`getResult(String argumentName, String href)` Get the Result representing the file with the given name from the argument with the given name.
`static Result`	`getResultFromHref(Node resultsXml, String href)` Given the absolute href for the result, get the result without parsing the entire jobXml.
`Result`	`getResultFromHref(String href)` Get a result object for the result with the given absolute or relative href.
`SortedMap<Result,List<Result>>`	`getResults()` Get a map of all the Result objects.
`List<Result>`	`getResults(String argumentName)` Get the list of Results for the argument with the given name.
`Script`	`getScript()`
`String`	`getScriptHref()`
`Job.Status`	`getStatus()`
`static List<Job>`	`parseJobsXml(Node jobsXml)` Parse the list of jobs described by the provided XML document/node.
`void`	`setBatchId(String batchId)`
`void`	`setCallback(List<Callback> callback)`
`void`	`setDescription(String description)`
`void`	`setHref(String href)`
`void`	`setId(String id)`
`void`	`setInputs(List<Argument> argumentInputs)`
`void`	`setJobStorage(JobStorage storage)`
`void`	`setJobXml(Node jobXml)` Set job XML and re-enable lazy loading for the new XML.
`void`	`setLogHref(String logHref)`
`void`	`setMessages(List<Message> messages)`
`void`	`setNicename(String nicename)`
`void`	`setOutputs(List<Argument> argumentOutputs)`
`void`	`setPriority(Job.Priority priority)`
`void`	`setResults(Result result, SortedMap<Result,List<Result>> results)`
`void`	`setScript(Script script)`
`void`	`setScriptHref(String scriptHref)`
`void`	`setStatus(Job.Status status)`
`Document`	`toJobRequestXml(boolean absoluteUris)` Create jobRequest XML.
`Document`	`toXml()`
`String`	`validate()` Check that all the inputs and options is filled out properly.
`String`	`validate(String name)` Check that the argument with then provided name is filled out properly.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Job
```
public Job()
```
    Create an empty representation of a job.
  - Job
```
public Job(Node jobXml)
    throws Pipeline2Exception
```
    Parse the job described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/job.xml
    
    Parameters:
    
    jobXml -
    
    Throws:
    
    Pipeline2Exception
- Method Detail
  - getResultFromHref
```
public static Result getResultFromHref(Node resultsXml,
                                       String href)
```
    Given the absolute href for the result, get the result without parsing the entire jobXml.
    
    Parameters:
    
    resultsXml -
    
    href -
    
    base -
    
    Returns:
    
    Throws:
    
    Pipeline2Exception
    
    URISyntaxException
  - getMessages
```
public List<Message> getMessages()
```
    Get a list of all messages for the job.
    
    Returns:
  - getResult
```
public Result getResult()
```
    Get the main Result object.
    
    Returns:
    
    The returned Result represents "all results".
  - getResult
```
public Result getResult(String argumentName)
```
    Get the Result representing the argument with the given name.
    
    Parameters:
    
    argumentName -
    
    Returns:
  - getResult
```
public Result getResult(String argumentName,
                        String href)
```
    Get the Result representing the file with the given name from the argument with the given name.
    
    Parameters:
    
    argumentName -
    
    href - filename with path relative to the argument.
    
    Returns:
  - getResults
```
public List<Result> getResults(String argumentName)
```
    Get the list of Results for the argument with the given name.
    
    Parameters:
    
    argumentName -
    
    Returns:
  - getResults
```
public SortedMap<Result,List<Result>> getResults()
```
    Get a map of all the Result objects. The keys are the result objects for each named output. Each key is associated with a list of Result objects, each representing a file in the named output.
    
    Returns:
    
    The returned map contains all named outputs and associated files.
  - parseJobsXml
```
public static List<Job> parseJobsXml(Node jobsXml)
                              throws Pipeline2Exception
```
    Parse the list of jobs described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/jobs.xml
    
    Parameters:
    
    response -
    
    Returns:
    
    Throws:
    
    Pipeline2Exception
  - validate
```
public String validate()
```
    Check that all the inputs and options is filled out properly. The script associated with this job must be defined.
    
    Returns:
    
    a message describing the first error, or null if there is no error
  - validate
```
public String validate(String name)
```
    Check that the argument with then provided name is filled out properly. The script associated with this job must be defined.
    
    Returns:
    
    a message describing the error, or null if there is no error
  - getId
```
public String getId()
```
  - getHref
```
public String getHref()
```
  - getScriptHref
```
public String getScriptHref()
```
  - getScript
```
public Script getScript()
```
  - getStatus
```
public Job.Status getStatus()
```
  - getLogHref
```
public String getLogHref()
```
  - getNicename
```
public String getNicename()
```
  - getDescription
```
public String getDescription()
```
  - getBatchId
```
public String getBatchId()
```
  - getPriority
```
public Job.Priority getPriority()
```
  - getCallback
```
public List<Callback> getCallback()
```
  - getJobStorage
```
public JobStorage getJobStorage()
```
  - setId
```
public void setId(String id)
```
  - setNicename
```
public void setNicename(String nicename)
```
  - setDescription
```
public void setDescription(String description)
```
  - setBatchId
```
public void setBatchId(String batchId)
```
  - setPriority
```
public void setPriority(Job.Priority priority)
```
  - setCallback
```
public void setCallback(List<Callback> callback)
```
  - setJobStorage
```
public void setJobStorage(JobStorage storage)
```
  - setHref
```
public void setHref(String href)
```
  - setStatus
```
public void setStatus(Job.Status status)
```
  - setScriptHref
```
public void setScriptHref(String scriptHref)
```
  - setScript
```
public void setScript(Script script)
```
  - setLogHref
```
public void setLogHref(String logHref)
```
  - setMessages
```
public void setMessages(List<Message> messages)
```
  - setResults
```
public void setResults(Result result,
                       SortedMap<Result,List<Result>> results)
```
  - setJobXml
```
public void setJobXml(Node jobXml)
```
    Set job XML and re-enable lazy loading for the new XML.
  - getInputs
```
public List<Argument> getInputs()
```
  - getOutputs
```
public List<Argument> getOutputs()
```
  - setInputs
```
public void setInputs(List<Argument> argumentInputs)
```
  - setOutputs
```
public void setOutputs(List<Argument> argumentOutputs)
```
  - getArgument
```
public Argument getArgument(String name)
```
  - compareTo
```
public int compareTo(Job o)
```
    Specified by:
    
    compareTo in interface Comparable<Job>
  - getResultFromHref
```
public Result getResultFromHref(String href)
```
    Get a result object for the result with the given absolute or relative href.
    
    Parameters:
    
    href - if relative, must be relative to the top-level `…/results/` URL segment.
    
    Returns:
  - toXml
```
public Document toXml()
```
  - toJobRequestXml
```
public Document toJobRequestXml(boolean absoluteUris)
```
    Create jobRequest XML. If absoluteUris is true, file hrefs will be absolute file:/ URLs.
    
    Parameters:
    
    absoluteUris - base directory for files
    
    Returns:
    
    jobRequest XML document
  - getArguments
```
public List<Argument> getArguments()
```
    Get all arguments, both inputs and outputs. See also getInputs and getOutputs.
    
    Returns:
    
    a list of all arguments.

Class Job

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Job

Job

Method Detail

getResultFromHref

getMessages

getResult

getResult

getResult

getResults

getResults

parseJobsXml

validate

validate

getId

getHref

getScriptHref

getScript

getStatus

getLogHref

getNicename

getDescription

getBatchId

getPriority

getCallback

getJobStorage

setId

setNicename

setDescription

setBatchId

setPriority

setCallback

setJobStorage

setHref

setStatus

setScriptHref

setScript

setLogHref

setMessages

setResults

setJobXml

getInputs

getOutputs

setInputs

setOutputs

getArgument

compareTo

getResultFromHref

toXml

toJobRequestXml

getArguments