KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > jforum > dao > BannerDAO


1 /*
2  * Copyright (c) 2003, Rafael Steil
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms,
6  * with or without modification, are permitted provided
7  * that the following conditions are met:
8  *
9  * 1) Redistributions of source code must retain the above
10  * copyright notice, this list of conditions and the
11  * following disclaimer.
12  * 2) Redistributions in binary form must reproduce the
13  * above copyright notice, this list of conditions and
14  * the following disclaimer in the documentation and/or
15  * other materials provided with the distribution.
16  * 3) Neither the name of "Rafael Steil" nor
17  * the names of its contributors may be used to endorse
18  * or promote products derived from this software without
19  * specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
22  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
24  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27  * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
32  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
34  * IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
36  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  *
39  * This file creation date: Feb 19, 2003 / 8:56:14 PM
40  * The JForum Project
41  * http://www.jforum.net
42  */

43 package net.jforum.dao;
44
45 import java.util.List JavaDoc;
46
47 import net.jforum.entities.Banner;
48
49 /**
50  * Model interface for {@link net.jforum.entity.Banner}.
51  * This interface defines methods which are expected to be
52  * implementd by a specific data access driver. The intention is
53  * to provide all functionality needed to update, insert, delete and
54  * select some specific data.
55  *
56  * @author Samuel Yung
57  * @version $Id: BannerDAO.java,v 1.4 2005/07/26 03:04:30 rafaelsteil Exp $
58  */

59 public interface BannerDAO
60 {
61     /**
62      * Gets a specific <code>Banner</code>.
63      *
64      * @param bannerId The Banner ID to search
65      * @return <code>Banner</code> object containing all the information
66      * @throws Exception
67      * @see #selectAll
68      */

69     public Banner selectById(int bannerId) throws Exception JavaDoc;
70
71     /**
72      * Selects all banners data from the database.
73      *
74      * @return List with the banners found
75      * @throws Exception
76      * @see #selectById
77      */

78     public List JavaDoc selectAll() throws Exception JavaDoc;
79
80     /**
81      * Adds a new banner.
82      *
83      * @param banner Reference to a valid and configured <code>Banner</code> object
84      * @throws Exception
85      */

86     public int addNew(Banner banner) throws Exception JavaDoc;
87
88     /**
89      * Updates a banner.
90      *
91      * @param banner Reference to a <code>Banner</code> object to update
92      * @throws Exception
93      */

94     public void update(Banner banner) throws Exception JavaDoc;
95
96     /**
97      * Checks if is possible to delete a specific banner.
98      *
99      * @param bannerId The banner ID to verify
100      * @return <code>true</code> if is possible to delete, <code>false</code> if not
101      * @see #delete(int)
102      * @throws Exception
103      */

104     public boolean canDelete(int bannerId) throws Exception JavaDoc;
105
106     /**
107      * Delete a banner.
108      *
109      * @param bannerId The banner ID to delete
110      * @throws Exception
111      */

112     public void delete(int bannerId) throws Exception JavaDoc;
113
114     /**
115      * Select a list of active banners by its placement.
116      *
117      * @param placement The placement number
118      * @throws Exception
119      */

120     public List JavaDoc selectActiveBannerByPlacement(int placement) throws
121         Exception JavaDoc;
122 }
123
Popular Tags