Package ca.uhn.fhir.batch2.api

Class RunOutcome

java.lang.Object

ca.uhn.fhir.batch2.api.RunOutcome

public class RunOutcome
extends Object

Return type for IJobStepWorker.run(StepExecutionDetails, IJobDataSink)

Field Summary

Fields

Modifier and Type	Field	Description
static final RunOutcome	SUCCESS	RunOutcome with 0 records processed

Constructor Summary

Constructors

Constructor	Description
RunOutcome(int theRecordsProcessed)	Constructor

Method Summary

Modifier and Type	Method	Description
int	getRecordsProcessed()

Methods inherited from class java.lang.Object

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

Field Details

SUCCESS

public static final RunOutcome SUCCESS

RunOutcome with 0 records processed

Constructor Details

RunOutcome

public RunOutcome(int theRecordsProcessed)

Constructor

Parameters:

theRecordsProcessed - The number of records processed by this step. This number is not used for anything other than calculating the total number of records processed by the job. Therefore in many cases it will make sense to return a count of 0 for all steps except for the final step. For example, if you have a step that fetches files and a step that saves them, you might choose to only return a non-zero count indicating the number of saved files (or even the number of records within those files) so that the ultimate total reflects the real total.

Method Details

getRecordsProcessed

public int getRecordsProcessed()