KickJava   Java API By Example, From Geeks To Geeks.

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


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  *
23  * ***** END LICENSE BLOCK ***** */
24 package org.riotfamily.riot.job;
25
26 /**
27  * Description created by a Job's {@link Job#setup(String) setup()}-method.
28  *
29  * @author Felix Gnass [fgnass at neteye dot de]
30  */
31 public class JobDescription {
32
33     private String JavaDoc name;
34     
35     private String JavaDoc description;
36
37     private int steps;
38
39     
40     public JobDescription() {
41     }
42
43     public JobDescription(String JavaDoc name, int steps) {
44         this.name = name;
45         this.steps = steps;
46     }
47     
48     public JobDescription(String JavaDoc name, String JavaDoc description, int steps) {
49         this.name = name;
50         this.description = description;
51         this.steps = steps;
52     }
53
54     public String JavaDoc getName() {
55         return this.name;
56     }
57
58     public void setName(String JavaDoc name) {
59         this.name = name;
60     }
61
62     /**
63      * Returns a String that describes what the job is/will be doing.
64      */
65     public String JavaDoc getDescription() {
66         return this.description;
67     }
68
69     public void setDescription(String JavaDoc description) {
70         this.description = description;
71     }
72
73     /**
74      * Returns the number of steps needed to complete the job. This information
75      * is used to provide progress information.
76      */
77     public int getSteps() {
78         return this.steps;
79     }
80
81     public void setSteps(int steps) {
82         this.steps = steps;
83     }
84     
85 }
86
Popular Tags