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 class' job is to provide an interface between DataObjects and the
071: * underlying data source. It provides the actual execution. By separating the
072: * logic, we gain the ability to do things such as have the actual Execution
073: * take place on another machine. Just write an executor facade and be done
074: * with it.
075: *
076: * @author Michael Rimov
077: * @since Expresso 5.0
078: */
079:
080: public interface DataExecutorInterface {
081:
082: /**
083: * Takes a <code>DataObject</code> and adds it to the underlying data source
084: *
085: * @param valueObject the <code>DataObject</code> to add.
086: * @throws DataException upon error adding the object to the data source
087: * @throws DuplicateKeyException if the object already existed in the data
088: * source.
089: */
090: public void add(DataObject valueObject) throws DataException,
091: DuplicateKeyException;
092:
093: /**
094: * Takes a <code>DataObject</code> and deletes it from the underlying data source
095: *
096: * @param valueObject the <code>DataObject</code> to delete.
097: * @throws DataException upon error deleting the object to the data source
098: */
099: public void delete(DataObject valueObject) throws DataException;
100:
101: /**
102: * Takes a <code>DataObject</code> and updates it to the underlying data source
103: *
104: * @param valueObject the <code>DataObject</code> to update.
105: * @param updateChangedFieldsOnly flag to signify if only fields whose value
106: * has changed should be included in the update.
107: * @throws DataException upon error updating the object to the data source
108: */
109: public void update(DataObject valueObject,
110: boolean updateChangedFieldsOnly) throws DataException;
111:
112: /**
113: * Takes a <code>DataObject</code> and retrieves it from the underlying data source
114: *
115: * @param valueObject the <code>DataObject</code> to add.
116: * @return true if the object was successfully found, false if no object
117: * found that represents the criteria specified
118: * @throws DataException upon error retriving the object from the data source
119: */
120: public boolean retrieve(DataObject valueObject)
121: throws DataException;
122:
123: /**
124: * Adds an entire batch of <code>DataObject</code>s to the underlying data source
125: *
126: * @param valueObjectList A list of <code>DataObject</code>s to add to the underlying
127: * data source
128: * @throws DataException upon error communicating with the underlying data source
129: * @throws DuplicateKeyException if one of the records was already in the
130: * data source
131: */
132: public void addBatch(List valueObjectList) throws DataException,
133: DuplicateKeyException;
134:
135: /**
136: * Updates an entire batch of <code>DataObject</code>s
137: *
138: * @param valueObjectList A list of <code>DataObject</code>s to update to the underlying
139: * data source
140: * @throws DataException upon error updating the data source
141: */
142: public void deleteBatch(List valueObjectList) throws DataException;
143:
144: /**
145: * Updates an entire batch of <code>DataObject</code>s
146: *
147: * @param valueObjectList A list of <code>DataObject</code>s to update to the underlying
148: * data source
149: * @param updateChangedFieldsOnly flag to signify if only fields whose value
150: * has changed should be included in the update.
151: * @throws DataException upon error updating the data source
152: */
153: public void deleteBatch(List valueObjectList,
154: boolean deleteWithSetFieldsOnly) throws DataException;
155:
156: /**
157: * Takes a <code>DataObject</code> and updates it to the underlying data source
158: * @param valueObject the <code>DataObject</code> to update.
159: * @param updateChangedFieldsOnly flag to signify if only fields whose value
160: * has changed should be included in the update.
161: * @throws DataException upon error updating the object to the data source
162: */
163:
164: /**
165: * Updates an entire batch of <code>DataObject</code>s
166: *
167: * @param valueObjectList A list of <code>DataObject</code>s to update to the underlying
168: * data source
169: * @throws DataException upon error updating the data source
170: */
171: public void updateBatch(List valueObjectList) throws DataException;
172:
173: /**
174: * Updates an entire batch of <code>DataObject</code>s
175: *
176: * @param valueObjectList A list of <code>DataObject</code>s to update to the underlying
177: * data source
178: * @param updateChangedFieldsOnly flag to signify if only fields whose value
179: * has changed should be included in the update.
180: * @throws DataException upon error updating the data source
181: */
182: public void updateBatch(List valueObjectList,
183: boolean updateChangedFieldsOnly) throws DataException;
184:
185: /**
186: * Takes a <code>DataObject</code> and updates it to the underlying data source
187: *
188: * @param valueObject the <code>DataObject</code> to update.
189: * @param updateChangedFieldsOnly flag to signify if only fields whose value
190: * has changed should be included in the update.
191: * @throws DataException upon error updating the object to the data source
192: */
193: public void updateAll(DataObject valueObject,
194: boolean updateChangedCache) throws DataException;
195:
196: /**
197: * Takes a <code>DataObject</code> and deletes it from the underlying data source
198: *
199: * @param valueObject the <code>DataObject</code> to delete.
200: * @throws DataException upon error deleting the objects to the data source
201: */
202: public void deleteAll(DataObject valueObject,
203: boolean deleteChangedCache) throws DataException;
204:
205: /**
206: * Takes a <code>DataObject</code> and run it from the underlying data source
207: *
208: * @param valueObject the <code>DataObject</code> to run.
209: * @throws DataException upon error retriving the object from the data source
210: */
211: public void runStoreProcedure(DataObject valueObject)
212: throws DataException;
213:
214: }
|