JobStatus (webcentral-platform-core DEVELOP-23.2-20170615.132754 API)

java.lang.Object
- com.archibus.jobmanager.JobStatus

All Implemented Interfaces:: com.archibus.utility.ThreadSafe

public class JobStatus
extends java.lang.Object
implements com.archibus.utility.ThreadSafe

Default job status implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JobStatus.JobResult
Describes a file or document that is a result of the job execution.

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobStatus.JobResult` Describes a file or document that is a result of the job execution.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`JOB_COMPLETE` The job has been completed successfully.
`static int`	`JOB_CREATED` The job has been created but not yet started.
`static int`	`JOB_FAILED` The job has failed with exception.
`static int`	`JOB_NOT_FOUND` The job is not found on the server; typically means that the job has never been started.
`static int`	`JOB_STARTED` The job has been started.
`static int`	`JOB_STOP_ACKNOWLEDGED` The job has been requested to stop, has acknowledged the request, but did not stop yet.
`static int`	`JOB_STOP_REQUESTED` The job has been requested to stop, but did not respond yet.
`static int`	`JOB_STOPPED` The job has been stopped.
`static int`	`JOB_TERMINATED` The job thread has been terminated.

Constructor Summary

Constructors
Constructor and Description

JobStatus()
Constructor.

Constructors
Constructor and Description
`JobStatus()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPartialResult(JobStatus.JobResult result)` Add a partial job result.
`void`	`addProperty(java.lang.String name, java.lang.String value)` Adds a property to the map.
`boolean`	`canCollect()` Returns true if the job can be removed from the list of active jobs.
`boolean`	`canStop()` Returns true if the job can be stopped.
`boolean`	`canTerminate()` Returns true if the job can be terminated.
`JobStatus`	`createCopy()` Creates a copy of the status object.
`int`	`getCode()`
`long`	`getCurrentNumber()`
`com.archibus.datasource.data.DataSet`	`getDataSet()`
`java.lang.String`	`getDetails()`
`long`	`getElapsedTime()` Returns the job elapsed time.
`java.lang.String`	`getJobStatusMessage(EventHandlerContext context, int percentComplete)`
`java.lang.String`	`getMessage()`
`java.util.List<JobStatus.JobResult>`	`getPartialResults()` Returns the list of partial job results.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns a reference to the property map.
`JobStatus.JobResult`	`getResult()`
`java.util.Date`	`getTimeCompleted()`
`java.util.Date`	`getTimeStarted()`
`java.lang.String`	`getTitle()` Returns formatted status string representation.
`long`	`getTotalNumber()`
`void`	`incrementCurrentNumber()`
`void`	`incrementTotalNumber(int number)`
`boolean`	`isStopRequested()` Returns true if the job should stop.
`void`	`setCode(int code)`
`void`	`setCurrentNumber(long currentNumber)`
`void`	`setDataSet(com.archibus.datasource.data.DataSet dataSet)`
`void`	`setDetails(java.lang.String details)`
`void`	`setMessage(java.lang.String message)`
`void`	`setPartialResults(java.util.List<JobStatus.JobResult> results)` Sets the new list of partial results.
`void`	`setResult(JobStatus.JobResult result)`
`void`	`setResult(java.lang.String resultMessage)`
`void`	`setTimeCompleted(java.util.Date timeCompleted)`
`void`	`setTimeStarted(java.util.Date timeStarted)`
`void`	`setTotalNumber(long totalNumber)`
`java.lang.String`	`toString()` Returns formatted status string representation, with the custom message if present.
`void`	`updateLastPartialResult(JobStatus.JobResult result)` Updates the last added partial job result.

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

- Field Detail
  - JOB_NOT_FOUND
```
public static final int JOB_NOT_FOUND
```
    The job is not found on the server; typically means that the job has never been started.
    
    See Also:
    
    Constant Field Values
  - JOB_CREATED
```
public static final int JOB_CREATED
```
    The job has been created but not yet started.
    
    See Also:
    
    Constant Field Values
  - JOB_STARTED
```
public static final int JOB_STARTED
```
    The job has been started.
    
    See Also:
    
    Constant Field Values
  - JOB_COMPLETE
```
public static final int JOB_COMPLETE
```
    The job has been completed successfully.
    
    See Also:
    
    Constant Field Values
  - JOB_STOP_REQUESTED
```
public static final int JOB_STOP_REQUESTED
```
    The job has been requested to stop, but did not respond yet.
    
    See Also:
    
    Constant Field Values
  - JOB_STOP_ACKNOWLEDGED
```
public static final int JOB_STOP_ACKNOWLEDGED
```
    The job has been requested to stop, has acknowledged the request, but did not stop yet. This status means that the job is performing clean-up operations before stopping.
    
    See Also:
    
    Constant Field Values
  - JOB_STOPPED
```
public static final int JOB_STOPPED
```
    The job has been stopped.
    
    See Also:
    
    Constant Field Values
  - JOB_TERMINATED
```
public static final int JOB_TERMINATED
```
    The job thread has been terminated.
    
    See Also:
    
    Constant Field Values
  - JOB_FAILED
```
public static final int JOB_FAILED
```
    The job has failed with exception.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JobStatus
```
public JobStatus()
```
    Constructor.
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Returns formatted status string representation, with the custom message if present.
    
    Overrides:
    
    toString in class java.lang.Object
  - getTitle
```
public java.lang.String getTitle()
```
    Returns formatted status string representation.
  - createCopy
```
public JobStatus createCopy()
```
    Creates a copy of the status object.
    
    Returns:
  - canStop
```
public boolean canStop()
```
    Returns true if the job can be stopped.
    
    Returns:
  - canTerminate
```
public boolean canTerminate()
```
    Returns true if the job can be terminated.
    
    Returns:
  - canCollect
```
public boolean canCollect()
```
    Returns true if the job can be removed from the list of active jobs.
    
    Returns:
  - isStopRequested
```
public boolean isStopRequested()
```
    Returns true if the job should stop.
    
    Returns:
  - getCode
```
public int getCode()
```
  - setCode
```
public void setCode(int code)
```
  - getMessage
```
public java.lang.String getMessage()
```
  - setMessage
```
public void setMessage(java.lang.String message)
```
  - getTotalNumber
```
public long getTotalNumber()
```
  - setTotalNumber
```
public void setTotalNumber(long totalNumber)
```
  - getCurrentNumber
```
public long getCurrentNumber()
```
  - setCurrentNumber
```
public void setCurrentNumber(long currentNumber)
```
  - getTimeStarted
```
public java.util.Date getTimeStarted()
```
  - setTimeStarted
```
public void setTimeStarted(java.util.Date timeStarted)
```
  - getTimeCompleted
```
public java.util.Date getTimeCompleted()
```
  - setTimeCompleted
```
public void setTimeCompleted(java.util.Date timeCompleted)
```
  - getElapsedTime
```
public long getElapsedTime()
```
    Returns the job elapsed time.
    
    Returns:
  - getResult
```
public JobStatus.JobResult getResult()
```
  - setResult
```
public void setResult(JobStatus.JobResult result)
```
  - setResult
```
public void setResult(java.lang.String resultMessage)
```
  - getPartialResults
```
public java.util.List<JobStatus.JobResult> getPartialResults()
```
    Returns the list of partial job results. This list can be safely iterated from any thread, but cannot be modified (an exception will be throws on modification attempt).
    
    Returns:
    
    List
  - addPartialResult
```
public void addPartialResult(JobStatus.JobResult result)
```
    Add a partial job result.
    
    Parameters:
    
    resultData -
  - updateLastPartialResult
```
public void updateLastPartialResult(JobStatus.JobResult result)
```
    Updates the last added partial job result.
    
    Parameters:
    
    resultData -
  - setPartialResults
```
public void setPartialResults(java.util.List<JobStatus.JobResult> results)
```
    Sets the new list of partial results. The existing list is lost.
    
    Parameters:
    
    results -
  - addProperty
```
public void addProperty(java.lang.String name,
                        java.lang.String value)
```
    Adds a property to the map.
    
    Parameters:
    
    name -
    
    value -
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Returns a reference to the property map.
    
    Returns:
  - getDataSet
```
public com.archibus.datasource.data.DataSet getDataSet()
```
  - setDataSet
```
public void setDataSet(com.archibus.datasource.data.DataSet dataSet)
```
  - getDetails
```
public java.lang.String getDetails()
```
  - setDetails
```
public void setDetails(java.lang.String details)
```
  - incrementTotalNumber
```
public void incrementTotalNumber(int number)
```
  - incrementCurrentNumber
```
public void incrementCurrentNumber()
```
  - getJobStatusMessage
```
public java.lang.String getJobStatusMessage(EventHandlerContext context,
                                            int percentComplete)
```

Class JobStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JOB_NOT_FOUND

JOB_CREATED

JOB_STARTED

JOB_COMPLETE

JOB_STOP_REQUESTED

JOB_STOP_ACKNOWLEDGED

JOB_STOPPED

JOB_TERMINATED

JOB_FAILED

Constructor Detail

JobStatus

Method Detail

toString

getTitle

createCopy

canStop

canTerminate

canCollect

isStopRequested

getCode

setCode

getMessage

setMessage

getTotalNumber

setTotalNumber

getCurrentNumber

setCurrentNumber

getTimeStarted

setTimeStarted

getTimeCompleted

setTimeCompleted

getElapsedTime

getResult

setResult

setResult

getPartialResults

addPartialResult

updateLastPartialResult

setPartialResults

addProperty

getProperties

getDataSet

setDataSet

getDetails

setDetails

incrementTotalNumber

incrementCurrentNumber

getJobStatusMessage