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.core.dataobjects;
066:
067: import java.util.List;
068:
069: /**
070: * This interface provides a standard interface to deal with parts that
071: * operate and return multiple DataObjects. This is in an attempt to make a
072: * DataObject more focused than before. [ie to cut down on size] by separating
073: * operations on a single dbobject from operations on a multiple dbobject.
074: *
075: * @author Michael Rimov
076: * @since Expresso 5.0
077: */
078: public interface DataQueryInterface {
079:
080: /**
081: * Performs a datasource search so that the criteria set in the DataObject
082: * is used.
083: *
084: * @param criteria a <code>DataObject</code> with the fields filled out so that
085: * all objects returned will match the fields specified in the <code>DataObject</code>
086: * @param sortOrder A pipe delimited string specifying the field(s) to be sorted upon.
087: * May be a single field without any pipes.
088: * @return <code>java.util.List</code> of objects. May be an empty list if no
089: * objects were found.
090: * @throws DataException upon error performing the search
091: */
092: public List searchAndRetrieve(DataObject criteria, String sortOrder)
093: throws DataException;
094:
095: /**
096: * Performs a datasource search so that the criteria set in the DataObject
097: * is used. There is no specified sort order for this version of the method
098: *
099: * @param criteria a <code>DataObject</code> with the fields filled out so that
100: * all objects returned will match the fields specified in the <code>DataObject</code>
101: * @return <code>java.util.List</code> of objects. May be an empty list if no
102: * objects were found.
103: * @throws DataException upon error performing the search
104: */
105: public List searchAndRetrieve(DataObject criteria)
106: throws DataException;
107:
108: /**
109: * Performs a datasource search so that the criteria set by a <code>DataTransferObject</code>
110: * is used. This is different from the DataObject search in that it is often meant
111: * to be used on remote machines where serializing lots of DataObjects is more expensive. Since
112: * a typical DataTransferObject is 1/2 the size of a DataObject, we significantly reduce
113: * network traffic by using this method at the expense of CPU time to translate the <code>DataTransferObject</code>
114: * back into a <code>DataObject</code>
115: *
116: * @param criteria a <code>DataTransferObject</code> with the fields filled out so that
117: * all objects returned will match the fields specified in the <code>DataTransferObject</code>
118: * @return <code>java.util.List</code> of <code>DataTransferObject</code>. May be an empty list if no
119: * objects were found.
120: * @throws DataException upon error performing the search
121: */
122: public List searchAndRetrieve(DataTransferObject criteria)
123: throws DataException;
124:
125: /**
126: * Performs a datasource search so that the criteria set by a <code>DataTransferObject</code>
127: * is used. This is different from the DataObject search in that it is often meant
128: * to be used on remote machines where serializing lots of DataObjects is more expensive. Since
129: * a typical DataTransferObject is 1/2 the size of a DataObject, we significantly reduce
130: * network traffic by using this method at the expense of CPU time to translate the <code>DataTransferObject</code>
131: * back into a <code>DataObject</code>
132: *
133: * @param criteria a <code>DataTransferObject</code> with the fields filled out so that
134: * all objects returned will match the fields specified in the <code>DataTransferObject</code>
135: * @param sortOrder A pipe delimited string specifying the field(s) to be sorted upon.
136: * May be a single field without any pipes.
137: * @return <code>java.util.List</code> of <code>DataTransferObject</code>. May be an empty list if no
138: * objects were found.
139: * @throws DataException upon error performing the search
140: */
141: public List searchAndRetrieve(DataTransferObject criteria,
142: String sortOrder) throws DataException;
143:
144: /**
145: * Finds a single record based upon the criteria specified by the <code>DataObject</code>
146: *
147: * @param criteria a <code>DataObject</code> with the fields to match filled out.
148: * @return boolean true if a record was found, and the <i>criteria</i> parameter
149: * is filled with the first data object found.
150: * @throws DataException upon error performing the search
151: */
152: public boolean find(DataObject criteria) throws DataException;
153:
154: /**
155: * Finds a single record based upon the criteria specified by the <code>DataTransferObject</code>
156: *
157: * @param criteria a <code>DataTransferObject</code> with the fields to match filled out.
158: * @return boolean true if a record was found, and the <i>criteria</i> parameter
159: * is filled with the first data object found.
160: * @throws DataException upon error performing the search
161: */
162: public boolean find(DataTransferObject criteria)
163: throws DataException;
164:
165: /**
166: * Release the query and all connections/resources associated with the
167: * query.
168: */
169: public void release();
170:
171: }
|