Package ca.uhn.fhir.jpa.bulk.imprt.api

Interface IBulkDataImportSvc

public interface IBulkDataImportSvc

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IBulkDataImportSvc.JobInfo

Method Summary

Modifier and Type	Method	Description
ActivateJobResult	activateNextReadyJob()	This method is intended to be called from the job scheduler, and will begin execution on the next job in status READY
void	addFilesToJob(String theJobId, List<BulkImportJobFileJson> theFiles)	Add more files to a job in STAGING state
String	createNewJob(BulkImportJobJson theJobDescription, List<BulkImportJobFileJson> theInitialFiles)	Create a new job in STAGING state (meaning it won't yet be worked on and can be added to)
void	deleteJobFiles(String theJobId)	Delete all input files associated with a particular job
BulkImportJobFileJson	fetchFile(String theJobId, int theFileIndex)	Fetch a given file by job ID
BulkImportJobJson	fetchJob(String theJobId)	Gets the number of files available for a given Job ID
String	getFileDescription(String theJobId, int theFileIndex)	Fetch just the file description for the given file
IBulkDataImportSvc.JobInfo	getJobStatus(String theJobId)	Gets the job status for the given job.
void	markJobAsReadyForActivation(String theJobId)	Move a job from STAGING state to READY state, meaning that is is a candidate to be picked up for processing
void	setJobToStatus(String theJobId, BulkImportJobStatusEnum theStatus)	Updates the job status for the given job
void	setJobToStatus(String theJobId, BulkImportJobStatusEnum theStatus, String theStatusMessage)	Updates the job status for the given job

Method Details

createNewJob

String createNewJob(BulkImportJobJson theJobDescription,
 @Nonnull
 List<BulkImportJobFileJson> theInitialFiles)

Create a new job in STAGING state (meaning it won't yet be worked on and can be added to)

addFilesToJob

void addFilesToJob(String theJobId,
 List<BulkImportJobFileJson> theFiles)

Add more files to a job in STAGING state

Parameters:

theJobId - The job ID

theFiles - The files to add to the job

markJobAsReadyForActivation

void markJobAsReadyForActivation(String theJobId)

Move a job from STAGING state to READY state, meaning that is is a candidate to be picked up for processing

Parameters:

theJobId - The job ID

activateNextReadyJob

ActivateJobResult activateNextReadyJob()

This method is intended to be called from the job scheduler, and will begin execution on the next job in status READY

Returns:

Returns true if a job was activated

setJobToStatus

void setJobToStatus(String theJobId,
 BulkImportJobStatusEnum theStatus)

Updates the job status for the given job

setJobToStatus

void setJobToStatus(String theJobId,
 BulkImportJobStatusEnum theStatus,
 String theStatusMessage)

Updates the job status for the given job

getJobStatus

IBulkDataImportSvc.JobInfo getJobStatus(String theJobId)

Gets the job status for the given job.

fetchJob

BulkImportJobJson fetchJob(String theJobId)

Gets the number of files available for a given Job ID

Parameters:

theJobId - The job ID

Returns:

The file count

fetchFile

BulkImportJobFileJson fetchFile(String theJobId,
 int theFileIndex)

Fetch a given file by job ID

Parameters:

theJobId - The job ID

theFileIndex - The index of the file within the job

Returns:

The file

deleteJobFiles

void deleteJobFiles(String theJobId)

Delete all input files associated with a particular job

getFileDescription

String getFileDescription(String theJobId,
 int theFileIndex)

Fetch just the file description for the given file