01: /* ***** BEGIN LICENSE BLOCK *****
02: * Version: MPL 1.1
03: * The contents of this file are subject to the Mozilla Public License Version
04: * 1.1 (the "License"); you may not use this file except in compliance with
05: * the License. You may obtain a copy of the License at
06: * http://www.mozilla.org/MPL/
07: *
08: * Software distributed under the License is distributed on an "AS IS" basis,
09: * 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;
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 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 getObjectId(Object entity);
47:
48: /**
49: * Returns the entity with the given id.
50: */
51: public Object load(String id) throws DataAccessException;
52:
53: /**
54: * Updates the given entity.
55: */
56: public void update(Object entity) throws DataAccessException;
57:
58: /**
59: * Saves the given entity.
60: */
61: public void save(Object entity, Object parent)
62: throws DataAccessException;
63:
64: /**
65: * Deletes the given entity.
66: */
67: public void delete(Object entity, Object parent)
68: throws DataAccessException;
69:
70: /**
71: * Returns a list of entities.
72: */
73: public Collection list(Object parent, ListParams params)
74: throws DataAccessException;
75:
76: /**
77: * Returns the total number of entities.
78: */
79: public int getListSize(Object parent, ListParams params)
80: throws DataAccessException;
81:
82: }
|