KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > blandware > atleap > persistence > core > ActionPageDAO


1 /*
2  * Copyright 2004 Blandware (http://www.blandware.com)
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.blandware.atleap.persistence.core;
17
18 import com.blandware.atleap.common.util.PartialCollection;
19 import com.blandware.atleap.common.util.QueryInfo;
20 import com.blandware.atleap.model.core.ActionPage;
21 import com.blandware.atleap.persistence.exception.DeleteException;
22
23 /**
24  * <p>DAO for action page (AP)</p>
25  * <p><a HREF="ActionPageDAO.java.htm"><i>View Source</i></a></p>
26  *
27  * @author Sergey Zubtcovskii <a HREF="mailto:sergey.zubtcovskii@blandware.com">&lt;sergey.zubtcovskii@blandware.com&gt;</a>
28  * @version $Revision: 1.6 $ $Date: 2005/07/29 14:12:16 $
29  */
30 public interface ActionPageDAO extends PageDAO {
31
32     // ~ CRUD Methods ================================================================
33
34     /**
35      * Creates new action page
36      *
37      * @param actionPage Value object that represents what page must be created
38      * @return ID of created action page
39      */
40     public Long JavaDoc createActionPage(ActionPage actionPage);
41
42     /**
43      * Retrieves action page with specified ID
44      *
45      * @param actionPageId ID to search by
46      * @return Action page with specified ID or null if no page with specified ID exists in database
47      */
48     public ActionPage retrieveActionPage(Long JavaDoc actionPageId);
49
50     /**
51      * Updates action page
52      *
53      * @param actionPage Action page to update
54      */
55     public void updateActionPage(ActionPage actionPage);
56
57     /**
58      * Deletes action page
59      *
60      * @param actionPage Page to delete
61      * @throws DeleteException if action page cannot be deleted
62      */
63     public void deleteActionPage(ActionPage actionPage) throws DeleteException;
64
65     // ~ Additional methods ================================================================
66
67     /**
68      * Retrieves filtered/sorted collection of action pages.
69      *
70      * @param queryInfo Object that contains information about how to filter and sort data
71      * @return Collection of pages
72      */
73     public PartialCollection listActionPages(QueryInfo queryInfo);
74
75     // ~ Finders ================================================================
76
77     /**
78      * Finds action page by URI
79      *
80      * @param actionPageUri URI of action page to search by
81      * @return Action page or null if nothing was found
82      */
83     public ActionPage findActionPageByUri(String JavaDoc actionPageUri);
84
85
86 }
87
Popular Tags