Package com.peterphi.carbon.type.immutable

Class CarbonJobInfo

java.lang.Object

com.peterphi.carbon.type.XMLWrapper

com.peterphi.carbon.type.immutable.CarbonJobInfo

public class CarbonJobInfo
extends XMLWrapper

Field Summary

Fields inherited from class com.peterphi.carbon.type.XMLWrapper

element

Constructor Summary

Constructors

Constructor	Description
CarbonJobInfo(org.jdom2.Element element)

Method Summary

Modifier and Type	Method	Description
String	getError()	Return the error text (if present)
String	getGUID()
String	getName()
int	getProgress()
String	getState()	Possible values (according to Carbon API 1.40.6 section 3.4.1: possible values can be: NEX_JOB_PREPARING, NEX_JOB_QUEUE, NEX_JOB_STARTING, NEX_JOB_COMPLETED, NEX_JOB_ERROR, etc. Deprecated by Rhozet - use status field instead
String	getStatus()	Possible values (according to Carbon API 1.40.6 section 3.4.1: possible values can be: Preparing, Queued, Starting, Started, Stopping, Stopped, Pausing, Paused, Resuming, Completed, Error and Invalid.

Methods inherited from class com.peterphi.carbon.type.XMLWrapper

getAttribute, getElement, getElement, setAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CarbonJobInfo

public CarbonJobInfo(org.jdom2.Element element)

Method Details

getName

public String getName()

getGUID

public String getGUID()

getState

public String getState()

Possible values (according to Carbon API 1.40.6 section 3.4.1: possible values can be: NEX_JOB_PREPARING, NEX_JOB_QUEUE, NEX_JOB_STARTING, NEX_JOB_COMPLETED, NEX_JOB_ERROR, etc.
Deprecated by Rhozet - use status field instead

Returns:

getStatus

public String getStatus()

Possible values (according to Carbon API 1.40.6 section 3.4.1: possible values can be: Preparing, Queued, Starting, Started, Stopping, Stopped, Pausing, Paused, Resuming, Completed, Error and Invalid.

Returns:

getProgress

public int getProgress()

getError

public String getError()

Return the error text (if present)

Returns: