KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ofbiz > service > job > Job


1 /*
2  * $Id: Job.java 5462 2005-08-05 18:35:48Z jonesde $
3  *
4  * Copyright (c) 2001, 2002 The Open For Business Project - www.ofbiz.org
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
21  * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  */
25 package org.ofbiz.service.job;
26
27 import java.io.Serializable JavaDoc;
28
29 /**
30  * Job Interface
31  *
32  * @author <a HREF="mailto:jaz@ofbiz.org">Andy Zeneski</a>
33  * @version $Rev: 5462 $
34  * @since 2.0
35  */
36 public interface Job extends Serializable JavaDoc {
37
38     /**
39      * Executes the Job.
40      */
41     public void exec() throws InvalidJobException;
42
43     /**
44      * Returns the ID of this Job.
45      */
46     public String JavaDoc getJobId();
47
48     /**
49      * Returns the name of this Job.
50      */
51     public String JavaDoc getJobName();
52
53     /**
54      * Returns the time to run in milliseconds.
55      */
56     public long getRuntime();
57
58     /**
59      * Returns true if this job is still valid.
60      */
61     public boolean isValid();
62
63     /**
64      * Flags this job as 'is-queued'
65      */
66     public void queue() throws InvalidJobException;
67 }
68
69
Popular Tags