KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Jan-Frederic Linde [jfl at neteye dot de]
23  *
24  * ***** END LICENSE BLOCK ***** */
25 package org.riotfamily.riot.job;
26
27
28
29 /**
30  * Context that is passed to a {@link Job} upon execution.
31  *
32  * @author Felix Gnass [fgnass at neteye dot de]
33  */
34 public interface JobContext {
35
36     /**
37      * Returns the objectId.
38      */
39     public String JavaDoc getObjectId();
40
41     /**
42      * Notifies the DAO that a step has been completed.
43      * @throws JobInterruptedException if the job has been interrupted
44      */
45     public void stepCompleted() throws JobInterruptedException;
46             
47     /**
48      * Logs an info message.
49      */
50     public void logInfo(String JavaDoc message);
51     
52     /**
53      * Logs an error message.
54      */
55     public void logError(String JavaDoc message);
56     
57     /**
58      * Changes the job's description.
59      */
60     public void updateDescription(String JavaDoc description);
61     
62     /**
63      * Changes the number of total steps.
64      */
65     public void updateStepsTotal(int stepsTotal);
66         
67 }
68
Popular Tags