Package ca.uhn.fhir.batch2.model

Class JobDefinition<PT extends ca.uhn.fhir.model.api.IModelJson>

java.lang.Object

ca.uhn.fhir.batch2.model.JobDefinition<PT>

public class JobDefinition<PT extends ca.uhn.fhir.model.api.IModelJson>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobDefinition.Builder<PT extends ca.uhn.fhir.model.api.IModelJson,NIT extends ca.uhn.fhir.model.api.IModelJson>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ID_MAX_LENGTH

Method Summary

Modifier and Type	Method	Description
IJobCompletionHandler<PT>	getCompletionHandler()
IJobCompletionHandler<PT>	getErrorHandler()
String	getFirstStepId()
String	getJobDefinitionId()
int	getJobDefinitionVersion()
String	getJobDescription()
Class<PT>	getParametersType()
IJobParametersValidator<PT>	getParametersValidator()
JobDefinitionStep<?,?,?>	getStepById(String theId)
int	getStepIndex(String theStepId)
List<JobDefinitionStep<PT,?,?>>	getSteps()
boolean	isGatedExecution()
boolean	isLastStepReduction()
static JobDefinition.Builder<ca.uhn.fhir.model.api.IModelJson,VoidModel>	newBuilder()

Methods inherited from class java.lang.Object

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

Field Details

ID_MAX_LENGTH

public static final int ID_MAX_LENGTH

See Also:

• Constant Field Values

Method Details

getCompletionHandler

@Nullable
public IJobCompletionHandler<PT> getCompletionHandler()

getErrorHandler

@Nullable
public IJobCompletionHandler<PT> getErrorHandler()

getParametersValidator

@Nullable
public IJobParametersValidator<PT> getParametersValidator()

getJobDescription

public String getJobDescription()

getJobDefinitionId

public String getJobDefinitionId()

Returns:

Returns a unique identifier for the job definition (i.e. for the "kind" of job)

getJobDefinitionVersion

public int getJobDefinitionVersion()

Returns:

Returns a unique identifier for the version of the job definition. Higher means newer but numbers have no other meaning. Must be greater than 0.

getParametersType

public Class<PT> getParametersType()

Returns:

Returns the parameters that this job can accept as input to create a new instance

getSteps

public List<JobDefinitionStep<PT,?,?>> getSteps()

Returns:

Returns the processing steps for this job

getFirstStepId

public String getFirstStepId()

Returns:

Returns the stepId of the first step

Throws:

IndexOutOfBoundsException - if there is no first step

isGatedExecution

public boolean isGatedExecution()

getStepById

public JobDefinitionStep<?,?,?> getStepById(String theId)

isLastStepReduction

public boolean isLastStepReduction()

getStepIndex

public int getStepIndex(String theStepId)

newBuilder

public static JobDefinition.Builder<ca.uhn.fhir.model.api.IModelJson,VoidModel> newBuilder()