Package com.veeva.vault.sdk.api.job

Interface JobInitContext

All Superinterfaces:
JobContext
public interface JobInitContext extends JobContext
Context given to Job.init(JobInitContext).

  • Method Details

    • setJobInitParameter

      void setJobInitParameter(String name, Object value)
      Sets the name and value of a job parameter that can be retrieved in later job phases.

      Use this method to pass data or calculated values from the Job.init(JobInitContext) phase to the Job.process(JobProcessContext) and Job.completeWithSuccess(JobCompletionContext)/Job.completeWithError(JobCompletionContext) phases. Retrieve the value in those phases using JobContext.getJobInitParameter(java.lang.String, com.veeva.vault.sdk.api.job.JobValueType<T>).

      Parameters:
      name - name of the parameter for which a value will be set
      value - new value to set on the parameter. Value must be one of the data types specified in JobValueType Or JobValue

    • newJobInput

      JobInputSupplier newJobInput(String query)
      Allows a VQL query to be used as a Job input. The query's SELECT must contain one or more fields of the following types:
      • String
      • Date
      • Boolean
      • Number
      This method supports id fields for Vault Objects in the query's SELECT. All other id fields are not supported. Validation only occurs at runtime, after the Job.init(JobInitContext) method completes. If there are any issues encountered in VQL execution, the job will be marked as ERROR_ENCOUNTERED and errors are logged to the job log file.
      Parameters:
      query - VQL query to use as an input
      Returns:
      a JobInputSupplier which can be used in a Job init method. Throws RuntimeException if VQL SELECT contains unsupported type.

    • newJobInput

      JobInputSupplier newJobInput(List<JobItem> items)
      Allows a List of JobItems to be used as input to a job.
      Parameters:
      items - specifies the List of items to use as input
      Returns:
      a JobInputSupplier which can be used in a Job init method

    • newJobItem

      JobItem newJobItem()
      Retrieves a new JobItem object.
      Returns:
      JobItem object