org.quartz.jobs.JobDetail Maven / Gradle / Ivy

Go to download
/*
 * All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy
 * of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 */

package org.quartz.jobs;

import java.io.Serializable;

import org.quartz.builders.JobBuilder;
import org.quartz.core.Scheduler;

/**
 * Conveys the detail properties of a given Job instance. JobDetails are to be created/defined with {@link JobBuilder}.
 * 
 * Quartz does not store an actual instance of a Job class, but instead allows you to define an instance of one, through the use of a
 * JobDetail.
 * 
 * 
 * Jobs have a name and group associated with them, which should uniquely identify them within a single {@link Scheduler}.
 * 
 * 
 * Triggers are the 'mechanism' by which Jobs are scheduled. Many Triggers can point to the same
 * Job, but a single Trigger can only point to one Job.
 * 
 *
 * @author James House
 */
public interface JobDetail extends Serializable, Cloneable {

  public String getName();

  /**
   * 
   * Return the description given to the Job instance by its creator (if any).
   * 
   *
   * @return null if no description was set.
   */
  public String getDescription();

  /**
   * 
   * Get the instance of Job that will be executed.
   * 
   */
  public Class getJobClass();

  /**
   * 
   * Get the JobDataMap that is associated with the Job.
   * 
   */
  public JobDataMap getJobDataMap();

  /**
   * The default behavior is to veto any job is currently running concurrent. However, concurrent jobs can be created by setting the 'Concurrency' to
   * true
   *
   * @return
   */
  public boolean isConcurrencyAllowed();

  public Object clone();

  /**
   * Get a {@link JobBuilder} that is configured to produce a JobDetail identical to this one.
   */
  public JobBuilder getJobBuilder();

}