Package overit.geocall.config.company

Class PropertiesJob

java.lang.Object
overit.geocall.config.company.PropertiesJob
public class PropertiesJob extends Object
class containing the configurations related to the configured jobs.
note: all the configuration refers to the company whose the identity belongs to.

  • Method Details

    • jobs

      public static List<String> jobs(Company company)
      Get the list of the names for the configured jobs.
      Parameters:
      company - the company from which extract the configuration
      Returns:
      the names of the configured jobs. If there's no job configured, this method will return an empty list.

    • task

      public static String task(Company company, String job)
      Retrieve the DATask or BusinessTask path to be executed.
      The path will be solved through the factory. If not specified, the job will not be executed.
      Parameters:
      company - the company from which extract the configuration
      job - the name of the selected job
      Returns:
      the task path or null if it is not configured

    • description

      public static String description(Company company, String job)
      Retrieve the string reporting a brief description of the job. If not specified, the job will not be executed;
      Parameters:
      company - the company from which extract the configuration
      job - the name of the selected job
      Returns:
      the job description or null if it is not configured

    • user

      public static String user(Company company, String job)
      Retrieve the string defining the user associated to the performance of the task.
      Parameters:
      company - the company from which extract the configuration
      job - the name of the selected job
      Returns:
      the user or null if it is not configured

    • mode

      public static int mode(Company company, String job)
      Retrieve the string defining the mode in which the job is carried out.
      The possible value are:
      • EVERY_TIME: the job is carried out at each execution cycle of the queue it belongs to.
      • SINGLE_TIME: the job is carried out once, only.
      Parameters:
      company - the company from which extract the configuration
      job - the name of the selected job
      Returns:
      the configured job's mode or Job.EVERY_TIME if it is not configured

    • queueName

      public static String queueName(Company company, String job)
      Retrieve the name of the queue this job will be executed on. If not specified, the job will not be executed;
      Parameters:
      company - the company from which extract the configuration
      job - the name of the selected job
      Returns:
      the queue name or null if it is not configured

    • parameters

      public static String parameters(Company company, String job)
      Retrieve the string reporting possible additional parameters passed to the task.
      The string must comply to the following format: param1=value1,param2=value2.
      Parameters:
      company - the company from which extract the configuration
      job - the name of the selected job
      Returns:
      the additional parameters or empty string if it is not configured