org.quartz.Job Maven / Gradle / Ivy
/*
* Copyright 2001-2009 Terracotta, Inc.
*
* 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;
/**
*
* The interface to be implemented by classes which represent a 'job' to be
* performed.
*
*
*
* Instances of Job must have a public
* no-argument constructor.
*
*
*
* JobDataMap provides a mechanism for 'instance member data'
* that may be required by some implementations of this interface.
*
*
* @see JobDetail
* @see JobBuilder
* @see ExecuteInJTATransaction
* @see DisallowConcurrentExecution
* @see PersistJobDataAfterExecution
* @see Trigger
* @see Scheduler
*
* @author James House
*/
public interface Job {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
*
* Called by the {@link Scheduler} when a {@link Trigger}
* fires that is associated with the Job.
*
*
*
* The implementation may wish to set a
* {@link JobExecutionContext#setResult(Object) result} object on the
* {@link JobExecutionContext} before this method exits. The result itself
* is meaningless to Quartz, but may be informative to
* {@link JobListener}s or
* {@link TriggerListener}s that are watching the job's
* execution.
*
*
* @throws JobExecutionException
* if there is an exception while executing the job.
*/
void execute(JobExecutionContext context)
throws JobExecutionException;
}