KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > html > ReportPageParam


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 /**
66  * ReportPageParam.java
67  *
68  * Copyright 1999, 2000, 2001 Jcorporate Ltd.
69  */

70 package com.jcorporate.expresso.services.html;
71
72
73 /**
74  * ReportPage objects may have parameters that indicate the range of data
75  * or options they display. These correspond to the ReportParam class
76  * in the Reports Online package, but may be used with or without Reports Online
77  * to determine the parameters to a report
78  *
79  * @author Michael Nash
80  * @version $Revision: 1.8 $ $Date: 2004/11/17 20:48:18 $
81  */

82 public class ReportPageParam {
83     private String JavaDoc paramCode = null;
84     private String JavaDoc paramDescrip = null;
85     private String JavaDoc paramType = null;
86     private String JavaDoc paramDefaultValue = null;
87     private String JavaDoc thisClass = (getClass().getName() + ".");
88
89     /**
90      * Constructor
91      */

92     public ReportPageParam() {
93     } /* ReportPage() */
94
95     /**
96      * Constructor that sets all the values
97      *
98      * @param newCode the new parameter code
99      * @param newDescrip the new description
100      * @param newType the java type
101      * @param newDefaultValue the default value
102      * @throws HtmlException upon error
103      */

104     public ReportPageParam(String JavaDoc newCode, String JavaDoc newDescrip, String JavaDoc newType,
105                            String JavaDoc newDefaultValue)
106             throws HtmlException {
107         String JavaDoc myName = (thisClass +
108                 "ReportPageParam(String, String" +
109                 ", String, String)");
110
111         if (newCode == null) {
112             throw new HtmlException(myName + ":Parameter code cannot be null");
113         }
114
115         paramCode = newCode;
116
117         if (newDescrip == null) {
118             throw new HtmlException(myName + ":Description cannot be null");
119         }
120
121         paramDescrip = newDescrip;
122
123         if (newType.equals("N") || newType.equals("C") ||
124                 newType.equals("D")) {
125             paramType = newType;
126         } else {
127             throw new HtmlException(myName + ":Parameter type must be " +
128                     "(N)umeric, (C)haracter or (D)ate");
129         }
130
131         paramDefaultValue = newDefaultValue;
132     } /* ReportPageParam(String, String, String, String) */
133
134     /**
135      * Return the code of this parameter
136      *
137      * @return A unique code that identifies this parameter
138      */

139     public String JavaDoc getCode() {
140         return paramCode;
141     } /* getCode() */
142
143     /**
144      * Return the default value for this parameter
145      *
146      * @return A string with the default value of this parameter
147      */

148     public String JavaDoc getDefaultValue() {
149         return paramDefaultValue;
150     } /* getDefaultValue() */
151
152     /**
153      * Return the description of this parameter
154      *
155      * @return A string describing this parameter
156      */

157     public String JavaDoc getDescrip() {
158         return paramDescrip;
159     } /* getDescrip() */
160
161     /**
162      * Return the type code for this parameter
163      *
164      * @return (C)haracter, (D)ate or (N)umeric
165      */

166     public String JavaDoc getType() {
167         return paramType;
168     } /* getType() */
169
170 } /* ReportPageParam */
171
Popular Tags