01: /* ***** BEGIN LICENSE BLOCK *****
02: * Version: MPL 1.1
03: * The contents of this file are subject to the Mozilla Public License Version
04: * 1.1 (the "License"); you may not use this file except in compliance with
05: * the License. You may obtain a copy of the License at
06: * http://www.mozilla.org/MPL/
07: *
08: * Software distributed under the License is distributed on an "AS IS" basis,
09: * 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: * Context that is passed to a {@link Job} upon execution.
29: *
30: * @author Felix Gnass [fgnass at neteye dot de]
31: */
32: public interface JobContext {
33:
34: /**
35: * Returns the objectId.
36: */
37: public String getObjectId();
38:
39: /**
40: * Notifies the DAO that a step has been completed.
41: * @throws JobInterruptedException if the job has been interrupted
42: */
43: public void stepCompleted() throws JobInterruptedException;
44:
45: /**
46: * Logs an info message.
47: */
48: public void logInfo(String message);
49:
50: /**
51: * Logs an error message.
52: */
53: public void logError(String message);
54:
55: /**
56: * Changes the job's description.
57: */
58: public void updateDescription(String description);
59:
60: /**
61: * Changes the number of total steps.
62: */
63: public void updateStepsTotal(int stepsTotal);
64:
65: }
|