001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.services.controller.ui;
066:
067: import com.jcorporate.expresso.core.controller.Block;
068: import com.jcorporate.expresso.core.controller.ControllerException;
069: import com.jcorporate.expresso.core.controller.ControllerRequest;
070: import com.jcorporate.expresso.core.controller.ControllerResponse;
071: import com.jcorporate.expresso.core.controller.ErrorCollection;
072: import com.jcorporate.expresso.core.controller.Input;
073: import com.jcorporate.expresso.core.dataobjects.DataObject;
074:
075: /**
076: * This interface is for objects that provide an automatic rendering capability
077: * to the system. It's in sort of a way a bridge between DBObjects and
078: * ControllerElements
079: *
080: * @author Michael Rimov, portions from Adam Rossi, Michael Nash, Shash Chatterjee
081: * @since Expresso 5.0
082: */
083: public interface AutoControllerElement {
084:
085: /**
086: * Renders an Input in a update method per field name.
087: *
088: * @param response a ControllerResponse Object
089: * @param dbobj A DBObject to transform into an Input
090: * @param fieldName the name of the field to render
091: * @param defaultValue the default value to use in the field
092: * @param readOnly true if the Input should be a read only input.
093: * @return an instantiated Input object
094: */
095: public Input renderDBObjectField(ControllerResponse response,
096: DataObject dbobj, String fieldName, String defaultValue,
097: boolean readOnly) throws ControllerException;
098:
099: /**
100: * Creates a DBObject Block that contains all the non-secret fields for
101: * the DBObject. The Block will have a nested Output that matches DBObject's
102: * description unless one is not supplied in which case the nested Output will
103: * have the title "Untitled"
104: *
105: * @param response a <code>ControllerResponse</code> Object
106: * @param request The <code>ControllerRequest</code> Object
107: * @param dbobj The dbObject to automatically render.
108: * @return an instantiated DBObject block based upon the parameters
109: * @throws ControllerException if there's an error rendering the DBObject
110: */
111: public Block createDBObjectBlock(ControllerRequest request,
112: ControllerResponse response, DataObject dbobj)
113: throws ControllerException;
114:
115: /**
116: * Creates a DBObject Block that contains all the non-secret fields for
117: * the DBObject.
118: *
119: * @param response a <code>ControllerResponse</code> Object
120: * @param request The <code>ControllerRequest</code> Object
121: * @param title The title to give this block. The system renders a nested
122: * Output called "block-title" for the block that contains this data.
123: * @param dbobj The dbObject to automatically render.
124: * @return an instantiated DBObject block based upon the parameters
125: * @throws ControllerException if there's an error rendering the DBObject
126: */
127: public Block createDBObjectBlock(ControllerRequest request,
128: ControllerResponse response, String title, DataObject dbobj)
129: throws ControllerException;
130:
131: /**
132: * Convienence method if you only expect one DBObject to be returned from
133: * a particular form.
134: *
135: * @param request The ControllerRequest object handed down by the framework
136: * @param oneObject A single DBObject to fill into fill out from the block.
137: * @param ec An instantiated ErrorCollection that is filled in with any error
138: * @return an instatiated <code>DBObject</code>
139: * @throws ControllerException if there's an error parsing the block or communicating
140: * with the underlying DBObject
141: * @throws IllegalArgumentException if request, DBObjectNames, or ec is null
142: */
143: public DataObject parseBlock(ControllerRequest request,
144: DataObject oneObject, ErrorCollection ec)
145: throws ControllerException;
146:
147: /**
148: * Convienence method if you only expect one DBObject to be returned from
149: * a particular form, and unlike the ParseBlock, there is no DBOBject name
150: * prefix attached to the parameter names. This is similar to the ControllerRequest
151: * validateDBObject functionality, but we're consolodating things here.
152: *
153: * @param request The ControllerRequest object handed down by the framework
154: * @param oneObject a Single DBObject to fill out.
155: * @param ec An instantiated ErrorCollection that is filled in with any error
156: * @return an instatiated <code>DBObject</code>
157: * @throws ControllerException if there's an error parsing the block or communicating
158: * with the underlying DBObject
159: * @throws IllegalArgumentException if request, DBObjectNames, or ec is null
160: */
161: public DataObject parseDBObject(ControllerRequest request,
162: DataObject oneObject, ErrorCollection ec)
163: throws ControllerException;
164:
165: public DataObject parseDBObject(ControllerRequest request,
166: DataObject oneObject, ErrorCollection ec, boolean validate)
167: throws ControllerException;
168:
169: /**
170: * Parses the appropriate DBObject from the block. Returns the fully constructed
171: * DBOBject including any errors in the DBObject
172: *
173: * @param request The ControllerRequest object handed down by the framework
174: * @param theObjects A pre-instantiated group of DBObjects in which you expect
175: * to have the fields overwritten/filled. By using instantiated DBObjects,
176: * you can pre-fill any potentially blank fields and thus remove any Errors.
177: * @param ec An instantiated ErrorCollection that is filled in with any error
178: * @return an array of <code>DBObject</code>s
179: * @throws ControllerException if there's an error parsing the block or communicating
180: * with the underlying DBObject
181: */
182: public DataObject[] parseBlocks(ControllerRequest request,
183: DataObject[] theObjects, ErrorCollection ec)
184: throws ControllerException;
185:
186: /**
187: * Takes the Controller Request and appropriately parses a string for a
188: * particular field. If the field is a Date, then it parses it as such,
189: * if it is money, then it perses it as such. Etc.
190: *
191: * @param request the ControllerRequest object
192: * @param fieldName the name of the field to parse
193: * @param dbobj The DBObject for which we're going to put the field to
194: * @param parameterName The name of the http paramter to parse May be null
195: * in which case, the funciton will by default use the fieldName as the
196: * parameter name.
197: * @param ec An instantiated ErrorCollection object that gets filled out
198: * by the function.
199: * @return an properly parsed String
200: * @throws ControllerException if there's an error parsing the block or communicating
201: * with the underlying DBObject
202: */
203: public String parseSingleInput(ControllerRequest request,
204: DataObject dbobj, String fieldName, String parameterName,
205: ErrorCollection ec) throws ControllerException;
206:
207: /**
208: * Allows for easy overriding of the style name for special customization
209: *
210: * @return a String naming the CSS class to use under normal circumstanes.
211: */
212: public String getNormalStyle() throws ControllerException;
213:
214: /**
215: * Allows for easy overriding fo the style name for special customization.
216: *
217: * @return a String naming the CSS class to use to render required fields.
218: */
219: public String getRequiredStyle() throws ControllerException;
220:
221: /**
222: * Allows for easy overriding fo the style name for special customization.
223: *
224: * @return the class name that is used for error conditions.
225: */
226: public String getErrorStyle() throws ControllerException;
227: }
|