01: /*******************************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: *******************************************************************************/package org.ofbiz.service.job;
19:
20: import java.io.Serializable;
21:
22: /**
23: * Job Interface
24: */
25: public interface Job extends Serializable {
26:
27: /**
28: * Executes the Job.
29: */
30: public void exec() throws InvalidJobException;
31:
32: /**
33: * Returns the ID of this Job.
34: */
35: public String getJobId();
36:
37: /**
38: * Returns the name of this Job.
39: */
40: public String getJobName();
41:
42: /**
43: * Returns the time to run in milliseconds.
44: */
45: public long getRuntime();
46:
47: /**
48: * Returns true if this job is still valid.
49: */
50: public boolean isValid();
51:
52: /**
53: * Flags this job as 'is-queued'
54: */
55: public void queue() throws InvalidJobException;
56: }
|