/* ====================================================================
* The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
*
* Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by Jcorporate Ltd.
* (http://www.jcorporate.com/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. "Jcorporate" and product names such as "Expresso" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written permission,
* please contact info@jcorporate.com.
*
* 5. Products derived from this software may not be called "Expresso",
* or other Jcorporate product names; nor may "Expresso" or other
* Jcorporate product names appear in their name, without prior
* written permission of Jcorporate Ltd.
*
* 6. No product derived from this software may compete in the same
* market space, i.e. framework, without prior written permission
* of Jcorporate Ltd. For written permission, please contact
* partners@jcorporate.com.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Jcorporate Ltd. Contributions back
* to the project(s) are encouraged when you make modifications.
* Please send them to support@jcorporate.com. For more information
* on Jcorporate Ltd. and its products, please see
* <http://www.jcorporate.com/>.
*
* Portions of this software are based upon other open source
* products and are subject to their respective licenses.
*/
package com.jcorporate.expresso.core.dataobjects;
import java.util.List;
/**
* This interface provides a standard interface to deal with parts that
* operate and return multiple DataObjects. This is in an attempt to make a
* DataObject more focused than before. [ie to cut down on size] by separating
* operations on a single dbobject from operations on a multiple dbobject.
*
* @author Michael Rimov
* @since Expresso 5.0
*/
public interface DataQueryInterface {
/**
* Performs a datasource search so that the criteria set in the DataObject
* is used.
*
* @param criteria a <code>DataObject</code> with the fields filled out so that
* all objects returned will match the fields specified in the <code>DataObject</code>
* @param sortOrder A pipe delimited string specifying the field(s) to be sorted upon.
* May be a single field without any pipes.
* @return <code>java.util.List</code> of objects. May be an empty list if no
* objects were found.
* @throws DataException upon error performing the search
*/
public List searchAndRetrieve(DataObject criteria, String sortOrder) throws DataException;
/**
* Performs a datasource search so that the criteria set in the DataObject
* is used. There is no specified sort order for this version of the method
*
* @param criteria a <code>DataObject</code> with the fields filled out so that
* all objects returned will match the fields specified in the <code>DataObject</code>
* @return <code>java.util.List</code> of objects. May be an empty list if no
* objects were found.
* @throws DataException upon error performing the search
*/
public List searchAndRetrieve(DataObject criteria) throws DataException;
/**
* Performs a datasource search so that the criteria set by a <code>DataTransferObject</code>
* is used. This is different from the DataObject search in that it is often meant
* to be used on remote machines where serializing lots of DataObjects is more expensive. Since
* a typical DataTransferObject is 1/2 the size of a DataObject, we significantly reduce
* network traffic by using this method at the expense of CPU time to translate the <code>DataTransferObject</code>
* back into a <code>DataObject</code>
*
* @param criteria a <code>DataTransferObject</code> with the fields filled out so that
* all objects returned will match the fields specified in the <code>DataTransferObject</code>
* @return <code>java.util.List</code> of <code>DataTransferObject</code>. May be an empty list if no
* objects were found.
* @throws DataException upon error performing the search
*/
public List searchAndRetrieve(DataTransferObject criteria) throws DataException;
/**
* Performs a datasource search so that the criteria set by a <code>DataTransferObject</code>
* is used. This is different from the DataObject search in that it is often meant
* to be used on remote machines where serializing lots of DataObjects is more expensive. Since
* a typical DataTransferObject is 1/2 the size of a DataObject, we significantly reduce
* network traffic by using this method at the expense of CPU time to translate the <code>DataTransferObject</code>
* back into a <code>DataObject</code>
*
* @param criteria a <code>DataTransferObject</code> with the fields filled out so that
* all objects returned will match the fields specified in the <code>DataTransferObject</code>
* @param sortOrder A pipe delimited string specifying the field(s) to be sorted upon.
* May be a single field without any pipes.
* @return <code>java.util.List</code> of <code>DataTransferObject</code>. May be an empty list if no
* objects were found.
* @throws DataException upon error performing the search
*/
public List searchAndRetrieve(DataTransferObject criteria, String sortOrder) throws DataException;
/**
* Finds a single record based upon the criteria specified by the <code>DataObject</code>
*
* @param criteria a <code>DataObject</code> with the fields to match filled out.
* @return boolean true if a record was found, and the <i>criteria</i> parameter
* is filled with the first data object found.
* @throws DataException upon error performing the search
*/
public boolean find(DataObject criteria) throws DataException;
/**
* Finds a single record based upon the criteria specified by the <code>DataTransferObject</code>
*
* @param criteria a <code>DataTransferObject</code> with the fields to match filled out.
* @return boolean true if a record was found, and the <i>criteria</i> parameter
* is filled with the first data object found.
* @throws DataException upon error performing the search
*/
public boolean find(DataTransferObject criteria) throws DataException;
/**
* Release the query and all connections/resources associated with the
* query.
*/
public void release();
}
|