Package ca.uhn.fhir.batch2.model

Class JobInstance

java.lang.Object

ca.uhn.fhir.batch2.model.JobInstance

All Implemented Interfaces:

IJobInstance, ca.uhn.fhir.model.api.IModelJson

public class JobInstance
extends Object
implements ca.uhn.fhir.model.api.IModelJson, IJobInstance

Field Summary

Fields inherited from interface ca.uhn.fhir.model.api.IModelJson

SENSITIVE_DATA_FILTER_NAME

Constructor Summary

Constructors

Constructor	Description
JobInstance()	Constructor
JobInstance(JobInstance theJobInstance)	Copy constructor

Method Summary

Modifier and Type	Method	Description
static JobInstance	fromInstanceId(String theInstanceId)
static JobInstance	fromJobDefinition(JobDefinition<?> theJobDefinition)
Integer	getCombinedRecordsProcessed()
Double	getCombinedRecordsProcessedPerSecond()
Date	getCreateTime()
String	getCurrentGatedStepId()
Date	getEndTime()
int	getErrorCount()
String	getErrorMessage()
String	getEstimatedTimeRemaining()
String	getInstanceId()
String	getJobDefinitionId()
int	getJobDefinitionVersion()
String	getParameters()
<T extends ca.uhn.fhir.model.api.IModelJson> T	getParameters(Class<T> theType)
double	getProgress()
String	getReport()
Date	getStartTime()
StatusEnum	getStatus()
Integer	getTotalElapsedMillis()
String	getTriggeringClientId()
String	getTriggeringUsername()
Date	getUpdateTime()
String	getWarningMessages()
boolean	hasGatedStep()
boolean	isCancelled()
boolean	isFastTracking()
boolean	isFinished()
boolean	isPendingCancellationRequest()
boolean	isRunning()	Returns true if the job instance is in: StatusEnum.IN_PROGRESS StatusEnum.FINALIZE and is not cancelled
boolean	isWorkChunksPurged()
void	setCancelled(boolean theCancelled)
void	setCombinedRecordsProcessed(Integer theCombinedRecordsProcessed)
void	setCombinedRecordsProcessedPerSecond(Double theCombinedRecordsProcessedPerSecond)
JobInstance	setCreateTime(Date theCreateTime)
void	setCurrentGatedStepId(String theCurrentGatedStepId)
JobInstance	setEndTime(Date theEndTime)
JobInstance	setErrorCount(int theErrorCount)
JobInstance	setErrorMessage(String theErrorMessage)
void	setEstimatedTimeRemaining(String theEstimatedTimeRemaining)
void	setFastTracking(boolean theFastTracking)
void	setInstanceId(String theInstanceId)
void	setJobDefinition(JobDefinition<?> theJobDefinition)
void	setJobDefinitionId(String theJobDefinitionId)
void	setJobDefinitionVersion(int theJobDefinitionVersion)
void	setParameters(ca.uhn.fhir.model.api.IModelJson theParameters)
void	setParameters(String theParameters)
void	setProgress(double theProgress)
void	setReport(String theReport)
JobInstance	setStartTime(Date theStartTime)
JobInstance	setStatus(StatusEnum theStatus)
void	setTotalElapsedMillis(Integer theTotalElapsedMillis)
JobInstance	setTriggeringClientId(String theTriggeringClientId)
JobInstance	setTriggeringUsername(String theTriggeringUsername)
void	setUpdateTime(Date theUpdateTime)
JobInstance	setWarningMessages(String theWarningMessages)
void	setWorkChunksPurged(boolean theWorkChunksPurged)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JobInstance

public JobInstance()

Constructor

JobInstance

public JobInstance(JobInstance theJobInstance)

Copy constructor

Method Details

getJobDefinitionId

public String getJobDefinitionId()

setJobDefinitionId

public void setJobDefinitionId(String theJobDefinitionId)

getParameters

public String getParameters()

setParameters

public void setParameters(String theParameters)

getParameters

public <T extends ca.uhn.fhir.model.api.IModelJson>
T getParameters(Class<T> theType)

setParameters

public void setParameters(ca.uhn.fhir.model.api.IModelJson theParameters)

setUpdateTime

public void setUpdateTime(Date theUpdateTime)

getUpdateTime

public Date getUpdateTime()

fromJobDefinition

public static JobInstance fromJobDefinition(JobDefinition<?> theJobDefinition)

fromInstanceId

public static JobInstance fromInstanceId(String theInstanceId)

getCurrentGatedStepId

public String getCurrentGatedStepId()

Specified by:

getCurrentGatedStepId in interface IJobInstance

setCurrentGatedStepId

public void setCurrentGatedStepId(String theCurrentGatedStepId)

getErrorCount

public int getErrorCount()

Specified by:

getErrorCount in interface IJobInstance

setErrorCount

public JobInstance setErrorCount(int theErrorCount)

getEstimatedTimeRemaining

public String getEstimatedTimeRemaining()

Specified by:

getEstimatedTimeRemaining in interface IJobInstance

setEstimatedTimeRemaining

public void setEstimatedTimeRemaining(String theEstimatedTimeRemaining)

isWorkChunksPurged

public boolean isWorkChunksPurged()

Specified by:

isWorkChunksPurged in interface IJobInstance

setWorkChunksPurged

public void setWorkChunksPurged(boolean theWorkChunksPurged)

getStatus

public StatusEnum getStatus()

Specified by:

getStatus in interface IJobInstance

setStatus

public JobInstance setStatus(StatusEnum theStatus)

getJobDefinitionVersion

public int getJobDefinitionVersion()

Specified by:

getJobDefinitionVersion in interface IJobInstance

setJobDefinitionVersion

public void setJobDefinitionVersion(int theJobDefinitionVersion)

getInstanceId

public String getInstanceId()

Specified by:

getInstanceId in interface IJobInstance

setInstanceId

public void setInstanceId(String theInstanceId)

getStartTime

public Date getStartTime()

Specified by:

getStartTime in interface IJobInstance

setStartTime

public JobInstance setStartTime(Date theStartTime)

getEndTime

public Date getEndTime()

Specified by:

getEndTime in interface IJobInstance

setEndTime

public JobInstance setEndTime(Date theEndTime)

getCombinedRecordsProcessed

public Integer getCombinedRecordsProcessed()

Specified by:

getCombinedRecordsProcessed in interface IJobInstance

setCombinedRecordsProcessed

public void setCombinedRecordsProcessed(Integer theCombinedRecordsProcessed)

getCombinedRecordsProcessedPerSecond

public Double getCombinedRecordsProcessedPerSecond()

Specified by:

getCombinedRecordsProcessedPerSecond in interface IJobInstance

setCombinedRecordsProcessedPerSecond

public void setCombinedRecordsProcessedPerSecond(Double theCombinedRecordsProcessedPerSecond)

getCreateTime

public Date getCreateTime()

Specified by:

getCreateTime in interface IJobInstance

setCreateTime

public JobInstance setCreateTime(Date theCreateTime)

getTotalElapsedMillis

public Integer getTotalElapsedMillis()

Specified by:

getTotalElapsedMillis in interface IJobInstance

setTotalElapsedMillis

public void setTotalElapsedMillis(Integer theTotalElapsedMillis)

getProgress

public double getProgress()

Specified by:

getProgress in interface IJobInstance

setProgress

public void setProgress(double theProgress)

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface IJobInstance

setErrorMessage

public JobInstance setErrorMessage(String theErrorMessage)

getWarningMessages

public String getWarningMessages()

Specified by:

getWarningMessages in interface IJobInstance

setWarningMessages

public JobInstance setWarningMessages(String theWarningMessages)

setJobDefinition

public void setJobDefinition(JobDefinition<?> theJobDefinition)

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface IJobInstance

setCancelled

public void setCancelled(boolean theCancelled)

getReport

public String getReport()

Specified by:

getReport in interface IJobInstance

setReport

public void setReport(String theReport)

getTriggeringUsername

public String getTriggeringUsername()

setTriggeringUsername

public JobInstance setTriggeringUsername(String theTriggeringUsername)

getTriggeringClientId

public String getTriggeringClientId()

setTriggeringClientId

public JobInstance setTriggeringClientId(String theTriggeringClientId)

toString

public String toString()

Overrides:

toString in class Object

isRunning

public boolean isRunning()

Returns true if the job instance is in: StatusEnum.IN_PROGRESS StatusEnum.FINALIZE and is not cancelled

isFinished

public boolean isFinished()

hasGatedStep

public boolean hasGatedStep()

isPendingCancellationRequest

public boolean isPendingCancellationRequest()

isFastTracking

public boolean isFastTracking()

Specified by:

isFastTracking in interface IJobInstance

Returns:

true if every step of the job has produced exactly 1 chunk.

setFastTracking

public void setFastTracking(boolean theFastTracking)

Specified by:

setFastTracking in interface IJobInstance