KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > riot > job > Job


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */
24 package org.riotfamily.riot.job;
25
26 /**
27  * Interface to define background jobs.
28  *
29  * @author Felix Gnass [fgnass at neteye dot de]
30  */
31 public interface Job {
32
33     /**
34      * Creates a JobDescription and optionally performs setup tasks.
35      */
36     public JobDescription setup(String JavaDoc objectId) throws JobCreationException;
37     
38     /**
39      * Returns whether the job can be executed concurrently with different
40      * objectIds.
41      */
42     public boolean isConcurrent();
43     
44     /**
45      * Returns whether the job can be executed more than once with the same
46      * objectId.
47      */
48     public boolean isRepeatable();
49     
50     /**
51      * Performs the actual work. The given context can be used to log messages
52      * or to provide progress information.
53      */
54     public void execute(JobContext context);
55
56     /**
57      * Invoked when a job is canceled or completed.
58      */
59     public void tearDown(String JavaDoc objectId);
60
61 }
62
Popular Tags