KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > dbobj > JobQueueParam


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.services.dbobj;
66
67 import com.jcorporate.expresso.core.db.DBException;
68 import com.jcorporate.expresso.core.dbobj.RequestContext;
69 import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
70
71
72 /**
73  * A JobQueueParam entry provides information to the job that is being
74  * queued that tell it how to run & what data to operate on. They are
75  * exactly like parameters to a method call, only marshalled via the
76  * database
77  *
78  * @author Michael Nash
79  * @version $Revision: 1.10 $ $Date: 2004/11/17 20:48:18 $
80  */
81 public class JobQueueParam
82         extends SecuredDBObject {
83
84     public static final String JavaDoc FLD_JOB_NUMBER = "JobNumber";
85     public static final String JavaDoc FLD_PARAM_NUMBER = "ParamNumber";
86     public static final String JavaDoc FLD_PARAM_CODE = "ParamCode";
87     public static final String JavaDoc FLD_PARAM_VALUE = "ParamValue";
88
89
90     /**
91      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject
92      */
93     public JobQueueParam()
94             throws DBException {
95         super();
96     } /* JobQueueParam() */
97
98
99     /**
100      * Initializes the JobQueueParam with the appropriate user.
101      *
102      * @param uid the Expresso user id.
103      * @throws DBException upon initialization error
104      */
105     public JobQueueParam(int uid)
106             throws DBException {
107         super(uid);
108     }
109
110     /**
111      * For using DBObjects within Controllers. Initializes based upon the current
112      * user and the requested db. [Of course this can be modified later]
113      *
114      * @param request - The controller request handed to you by the framework.
115      * @throws DBException upon initialization error
116      */
117     public JobQueueParam(RequestContext request)
118             throws DBException {
119         super(request);
120     }
121
122     /**
123      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#setupFields
124      */
125     protected synchronized void setupFields()
126             throws DBException {
127         setTargetTable("JOBQUEUEPARAM");
128         setDescription("DBjobQueueParams");
129         setCharset("ISO-8859-1");
130         addField(FLD_JOB_NUMBER, "int", 0, false, "jobSerial");
131         addField(FLD_PARAM_NUMBER, "smallint", 0, false, "paramNumber");
132         addField(FLD_PARAM_VALUE, "text", 0, true, "paramValue");
133         addField(FLD_PARAM_CODE, "varchar", 80, true, "paramCode");
134         setStringFilter(FLD_PARAM_VALUE, "rawFilter");
135         setStringFilter(FLD_PARAM_CODE, "stripFilter");
136         addKey(FLD_JOB_NUMBER);
137         setLookupObject(FLD_JOB_NUMBER,
138                 "com.jcorporate.expresso.services.dbobj.JobQueue");
139         addKey(FLD_PARAM_NUMBER);
140     } /* setupFields() */
141
142
143 } /* JobQueueParam */
144
145 /* JobQueueParam */
Popular Tags