com.ibm.ia.global.jobs

Interface JobService



  • public interface JobService
    The job service API for the Agent programming model.

    The JobService can be retrieved from the process method of an Agent and used to submit a new job instance in order to update the value of a global aggregate that is used by other rule agents.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void submitJob(java.lang.String name)
      Submits a job that corresponds to the given global variable name in order to update its value.
      void submitJob(java.lang.String name, java.lang.String description, java.util.List<JobParameter> params)
      Submits a job that corresponds to the given global variable name in order to update its value.
    • Method Detail

      • submitJob

        void submitJob(java.lang.String name)
                       throws JobException
        Submits a job that corresponds to the given global variable name in order to update its value. The job is submitted to be run asynchronously after agent processing completes.

        If a job with the same name is already in the job queue, the submitted job is skipped, otherwise it is put into the job queue. Note that even if a job with the same name is already running, the sbmitted job is still put into the queue.

        Throws:
        JobException
        Parameters:
        name - The name of the job to submit. The name is the technical name of the global aggregate variable defined in the tooling.
      • submitJob

        void submitJob(java.lang.String name,
                     java.lang.String description,
                     java.util.List<JobParameter> params)
                       throws JobException
        Submits a job that corresponds to the given global variable name in order to update its value. The job is submitted to be run asynchronously after agent processing completes.
        Throws:
        JobException
        Parameters:
        jobName - The name of the job to submit. The name is the technical name of the global aggregate variable defined in the tooling.
        description - An optional description of the job, which will appear in the JobRunInfo when looking at job history.
        params - An optional list of JobParameters.
        See Also:
        submitJob(String)

© Copyright IBM 2020