Package ca.uhn.fhir.batch2.api

Interface IJobCoordinator

All Known Implementing Classes:
JobCoordinatorImpl
public interface IJobCoordinator

  • Method Details

    • startInstance

      @Deprecated(since="6.8.0", forRemoval=true) default Batch2JobStartResponse startInstance(JobInstanceStartRequest theStartRequest) throws ca.uhn.fhir.rest.server.exceptions.InvalidRequestException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use startInstance(RequestDetails, JobInstanceStartRequest)
      Starts a new job instance
      Parameters:
      theStartRequest - The request, containing the job type and parameters
      Returns:
      Returns a unique ID for this job execution
      Throws:
      ca.uhn.fhir.rest.server.exceptions.InvalidRequestException - If the request is invalid (incorrect/missing parameters, etc)

    • startInstance

      Batch2JobStartResponse startInstance(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, JobInstanceStartRequest theStartRequest) throws ca.uhn.fhir.rest.server.exceptions.InvalidRequestException
      Starts a new job instance
      Parameters:
      theRequestDetails - The request details associated with the request. This will get used to validate that the request is appropriate for the given user, so if at all possible it should be the original RequestDetails from the server request.
      theStartRequest - The request, containing the job type and parameters
      Returns:
      Returns a unique ID for this job execution
      Throws:
      ca.uhn.fhir.rest.server.exceptions.InvalidRequestException - If the request is invalid (incorrect/missing parameters, etc)

    • getInstance

      @Nonnull JobInstance getInstance(String theInstanceId) throws ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException
      Fetch details about a job instance
      Parameters:
      theInstanceId - The instance ID
      Returns:
      Returns the current instance details
      Throws:
      ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException - If the instance ID can not be found

    • getInstances

      List<JobInstance> getInstances(int thePageSize, int thePageIndex)
      Fetch all job instances

    • getRecentInstances

      List<JobInstance> getRecentInstances(int theCount, int theStart)
      Fetch recent job instances

    • cancelInstance

      JobOperationResultJson cancelInstance(String theInstanceId) throws ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException
      Throws:
      ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException

    • getInstancesbyJobDefinitionIdAndEndedStatus

      List<JobInstance> getInstancesbyJobDefinitionIdAndEndedStatus(String theJobDefinitionId, @Nullable Boolean theEnded, int theCount, int theStart)

    • fetchAllJobInstances

      org.springframework.data.domain.Page<JobInstance> fetchAllJobInstances(JobInstanceFetchRequest theFetchRequest)
      Fetches all job instances tht meet the FetchRequest criteria
      Parameters:
      theFetchRequest - - fetch request
      Returns:
      - page of job instances

    • getJobInstancesByJobDefinitionIdAndStatuses

      List<JobInstance> getJobInstancesByJobDefinitionIdAndStatuses(String theJobDefinitionId, Set<StatusEnum> theStatuses, int theCount, int theStart)
      Fetches all job instances by job definition id and statuses

    • getJobInstancesByJobDefinitionId

      List<JobInstance> getJobInstancesByJobDefinitionId(String theJobDefinitionId, int theCount, int theStart)
      Fetches all jobs by job definition id