KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: AbstractJob.java 5462 2005-08-05 18:35:48Z jonesde $
3  *
4  * Copyright (c) 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 /**
28  * Abstract Service Job - Invokes a service
29  *
30  * @author <a HREF="mailto:jaz@ofbiz.org">Andy Zeneski</a>
31  * @version $Rev: 5462 $
32  * @since 2.0
33  */
34 public abstract class AbstractJob implements Job {
35
36     public static final String JavaDoc module = AbstractJob.class.getName();
37
38     protected long runtime = -1;
39     protected long sequence = 0;
40     private String JavaDoc jobId;
41     private String JavaDoc jobName;
42     private boolean queued = false;
43
44     protected AbstractJob(String JavaDoc jobId, String JavaDoc jobName) {
45         this.jobId = jobId;
46         this.jobName = jobName;
47     }
48
49     /**
50      * Returns the time to run in milliseconds.
51      */
52     public long getRuntime() {
53         return runtime;
54     }
55
56     /**
57      * Returns true if this job is still valid.
58      */
59     public boolean isValid() {
60         if (runtime > 0)
61             return true;
62         return false;
63     }
64
65     /**
66      * Returns the ID of this Job.
67      */
68     public String JavaDoc getJobId() {
69         return this.jobId;
70     }
71
72     /**
73      * Returns the name of this Job.
74      */
75     public String JavaDoc getJobName() {
76         return this.jobName;
77     }
78
79     /**
80      * Flags this job as 'is-queued'
81      */
82     public void queue() throws InvalidJobException {
83         this.queued = true;
84     }
85
86     /**
87      * Executes the Job.
88      */
89     public abstract void exec() throws InvalidJobException;
90 }
91
Popular Tags