DataExecutorInterface


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  package com.jcorporate.expresso.core.dataobjects;
66  
67  import java.util.List  ;
68  
69  /**
70   * This class' job is to provide an interface between DataObjects and the
71   * underlying data source.  It provides the actual execution.  By separating the
72   * logic, we gain the ability to do things such as have the actual Execution
73   * take place on another machine.  Just write an executor facade and be done
74   * with it.
75   *
76   * @author Michael Rimov
77   * @since Expresso 5.0
78   */
79  
80  public interface DataExecutorInterface {
81  
82      /**
83       * Takes a <code>DataObject</code> and adds it to the underlying data source
84       *
85       * @param valueObject the <code>DataObject</code> to add.
86       * @throws DataException         upon error adding the object to the data source
87       * @throws DuplicateKeyException if the object already existed in the data
88       *                               source.
89       */
90      public void add(DataObject valueObject) throws DataException, DuplicateKeyException;
91  
92      /**
93       * Takes a <code>DataObject</code> and deletes it from the underlying data source
94       *
95       * @param valueObject the <code>DataObject</code> to delete.
96       * @throws DataException upon error deleting the object to the data source
97       */
98      public void delete(DataObject valueObject) throws DataException;
99  
100     /**
101      * Takes a <code>DataObject</code> and updates it to the underlying data source
102      *
103      * @param valueObject             the <code>DataObject</code> to update.
104      * @param updateChangedFieldsOnly flag to signify if only fields whose value
105      *                                has changed should be included in the update.
106      * @throws DataException upon error updating the object to the data source
107      */
108     public void update(DataObject valueObject, boolean updateChangedFieldsOnly) throws DataException;
109 
110     /**
111      * Takes a <code>DataObject</code> and retrieves it from the underlying data source
112      *
113      * @param valueObject the <code>DataObject</code> to add.
114      * @return true if the object was successfully found, false if no object
115      *         found that represents the criteria specified
116      * @throws DataException upon error retriving the object from the data source
117      */
118     public boolean retrieve(DataObject valueObject) throws DataException;
119 
120 
121     /**
122      * Adds an entire batch of <code>DataObject</code>s to the underlying data source
123      *
124      * @param valueObjectList A list of <code>DataObject</code>s to add to the underlying
125      *                        data source
126      * @throws DataException         upon error communicating with the underlying data source
127      * @throws DuplicateKeyException if one of the records was already in the
128      *                               data source
129      */
130     public void addBatch(List   valueObjectList) throws DataException, DuplicateKeyException;
131 
132     /**
133      * Updates an entire batch of <code>DataObject</code>s
134      *
135      * @param valueObjectList A list of <code>DataObject</code>s to update to the underlying
136      *                        data source
137      * @throws DataException upon error updating the data source
138      */
139     public void deleteBatch(List   valueObjectList) throws DataException;
140 
141     /**
142      * Updates an entire batch of <code>DataObject</code>s
143      *
144      * @param valueObjectList         A list of <code>DataObject</code>s to update to the underlying
145      *                                data source
146      * @param updateChangedFieldsOnly flag to signify if only fields whose value
147      *                                has changed should be included in the update.
148      * @throws DataException upon error updating the data source
149      */
150     public void deleteBatch(List   valueObjectList, boolean deleteWithSetFieldsOnly) throws DataException;
151 
152     /**
153      * Takes a <code>DataObject</code> and updates it to the underlying data source
154      * @param valueObject the <code>DataObject</code> to update.
155      * @param updateChangedFieldsOnly flag to signify if only fields whose value
156      *         has changed should be included in the update.
157      * @throws DataException upon error updating the object to the data source
158      */
159 
160     /**
161      * Updates an entire batch of <code>DataObject</code>s
162      *
163      * @param valueObjectList A list of <code>DataObject</code>s to update to the underlying
164      *                        data source
165      * @throws DataException upon error updating the data source
166      */
167     public void updateBatch(List   valueObjectList) throws DataException;
168 
169     /**
170      * Updates an entire batch of <code>DataObject</code>s
171      *
172      * @param valueObjectList         A list of <code>DataObject</code>s to update to the underlying
173      *                                data source
174      * @param updateChangedFieldsOnly flag to signify if only fields whose value
175      *                                has changed should be included in the update.
176      * @throws DataException upon error updating the data source
177      */
178     public void updateBatch(List   valueObjectList, boolean updateChangedFieldsOnly) throws DataException;
179 
180     /**
181      * Takes a <code>DataObject</code> and updates it to the underlying data source
182      *
183      * @param valueObject             the <code>DataObject</code> to update.
184      * @param updateChangedFieldsOnly flag to signify if only fields whose value
185      *                                has changed should be included in the update.
186      * @throws DataException upon error updating the object to the data source
187      */
188     public void updateAll(DataObject valueObject, boolean updateChangedCache) throws DataException;
189 
190     /**
191      * Takes a <code>DataObject</code> and deletes it from the underlying data source
192      *
193      * @param valueObject the <code>DataObject</code> to delete.
194      * @throws DataException upon error deleting the objects to the data source
195      */
196     public void deleteAll(DataObject valueObject, boolean deleteChangedCache) throws DataException;
197 
198     /**
199      * Takes a <code>DataObject</code> and run it from the underlying data source
200      *
201      * @param valueObject the <code>DataObject</code> to run.
202      * @throws DataException upon error retriving the object from the data source
203      */
204     public void runStoreProcedure(DataObject valueObject) throws DataException;
205 
206 
207 }
208
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags