KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > riot > dao > RiotDao


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */
24 package org.riotfamily.riot.dao;
25
26 import java.util.Collection JavaDoc;
27
28 import org.springframework.dao.DataAccessException;
29
30 /**
31  * Interface that provides access to an underlying data store.
32  */
33 public interface RiotDao {
34     
35     /**
36      * Returns the class that is accessed by the dao.
37      */
38     public Class JavaDoc getEntityClass();
39
40     /**
41      * Returns the id of the given entity. Implementors will most likely need
42      * to perform a type conversion in order to return a String representation.
43      * The returned String must be parseable by the {@link #load(String) load()}
44      * method.
45      */
46     public String JavaDoc getObjectId(Object JavaDoc entity);
47     
48     /**
49      * Returns the entity with the given id.
50      */
51     public Object JavaDoc load(String JavaDoc id) throws DataAccessException;
52     
53     /**
54      * Updates the given entity.
55      */
56     public void update(Object JavaDoc entity) throws DataAccessException;
57
58     /**
59      * Saves the given entity.
60      */
61     public void save(Object JavaDoc entity, Object JavaDoc parent) throws DataAccessException;
62     
63     /**
64      * Deletes the given entity.
65      */
66     public void delete(Object JavaDoc entity, Object JavaDoc parent) throws DataAccessException;
67     
68     /**
69      * Returns a list of entities.
70      */
71     public Collection JavaDoc list(Object JavaDoc parent, ListParams params) throws DataAccessException;
72     
73     /**
74      * Returns the total number of entities.
75      */
76     public int getListSize(Object JavaDoc parent, ListParams params) throws DataAccessException;
77
78 }
79
Popular Tags