Package ca.bc.gov.open.cpf.api.domain

Interface BatchJobStatus

  • public interface BatchJobStatus

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String CANCELLED
      The cancelled BatchJobStatus indicates that request was cancelled and all requests and results have been removed.
      static String CREATING_REQUESTS
      The creatingRequests BatchJobStatus indicates the objects are being created by downloading the input data (if required), splitting the input data into BusinessApplicationRequests, and validating the data for each BusinessApplicationRequests.
      static String CREATING_RESULTS
      The creatingResults BatchJobStatus indicates that the BatchJobResults are in the process of being created.
      static String DOWNLOAD_INITIATED
      The downloadInitiated BatchJobStatus indicates that the user initiated the download of the BatchJobResults.
      static String PROCESSED
      The processed BatchJobStatus indicates that all the BusinessApplicationRequests of the BatchJob have been either successfully completed or permanently failed.
      static String PROCESSING
      The processing BatchJobStatus indicates that the BatchJob has been scheduled for execution by the BusinessApplication and some of the BusinessApplicationRequests may currently be executing.
      static String RESULTS_CREATED
      The resultsCreated BatchJobStatus indicates that the BatchJobResults have been created from the BusinessApplicationRequests for the BatchJob.
      static String SUBMITTED
      The submitted BatchJobStatus indicates that job has been accepted by the application as is ready for the BusinessApplicationRequests be created by downloading the input data (if required), splitting the input data into tasks, and validating the data for each task.

    • Field Detail

      • CANCELLED

        static final String CANCELLED
        The cancelled BatchJobStatus indicates that request was cancelled and all requests and results have been removed.
        See Also:
        Constant Field Values

      • CREATING_REQUESTS

        static final String CREATING_REQUESTS
        The creatingRequests BatchJobStatus indicates the objects are being created by downloading the input data (if required), splitting the input data into BusinessApplicationRequests, and validating the data for each BusinessApplicationRequests.
        See Also:
        Constant Field Values

      • CREATING_RESULTS

        static final String CREATING_RESULTS
        The creatingResults BatchJobStatus indicates that the BatchJobResults are in the process of being created.
        See Also:
        Constant Field Values

      • DOWNLOAD_INITIATED

        static final String DOWNLOAD_INITIATED
        The downloadInitiated BatchJobStatus indicates that the user initiated the download of the BatchJobResults.
        See Also:
        Constant Field Values

      • PROCESSED

        static final String PROCESSED
        The processed BatchJobStatus indicates that all the BusinessApplicationRequests of the BatchJob have been either successfully completed or permanently failed. The BatchJob is ready for the BatchJobResults to be created.
        See Also:
        Constant Field Values

      • PROCESSING

        static final String PROCESSING
        The processing BatchJobStatus indicates that the BatchJob has been scheduled for execution by the BusinessApplication and some of the BusinessApplicationRequests may currently be executing.
        See Also:
        Constant Field Values

      • RESULTS_CREATED

        static final String RESULTS_CREATED
        The resultsCreated BatchJobStatus indicates that the BatchJobResults have been created from the BusinessApplicationRequests for the BatchJob. The file is ready to be downloaded.
        See Also:
        Constant Field Values

      • SUBMITTED

        static final String SUBMITTED
        The submitted BatchJobStatus indicates that job has been accepted by the application as is ready for the BusinessApplicationRequests be created by downloading the input data (if required), splitting the input data into tasks, and validating the data for each task.
        See Also:
        Constant Field Values