KickJava   Java API By Example, From Geeks To Geeks.

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


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 creating date: Feb 19, 2003 / 8:56:28 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.Group;
48
49 /**
50  * Model interface for {@link net.jforum.Group}.
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 Rafael Steil
57  * @version $Id: GroupDAO.java,v 1.4 2005/07/26 03:04:31 rafaelsteil Exp $
58  */

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

69     public Group selectById(int groupId) throws Exception JavaDoc;
70     
71     /**
72      * Get all groups
73      *
74      * @return <code>ArrayList</code> containing the groups. Each entry
75      * is an <code>Group</code> object.
76      * @throws Exception
77      */

78     public List JavaDoc selectAll() throws Exception JavaDoc;
79     
80     /**
81      * Checks if is possible to delete a specific group.
82      *
83      * @param groupId The group ID to verify
84      * @return <code>true</code> if is possible to delete, <code>false</code> if not
85      * @see #delete(int)
86      */

87     public boolean canDelete(int groupId) throws Exception JavaDoc;
88     
89     /**
90      * Deletes a group.
91      *
92      * @param groupId The group ID to delete
93      * @throws Exception
94      * @see #canDelete(int)
95      */

96     public void delete(int groupId) throws Exception JavaDoc;
97     
98     
99     /**
100      * Updates a group.
101      *
102      * @param group Reference to a <code>Group</code> object to update
103      * @throws Exception
104      * @see #update(int)
105      */

106     public void update(Group group) throws Exception JavaDoc;
107     
108     /**
109      * Adds a new group.
110      *
111      * @param group Reference to a valid and configured <code>Group</code> object
112      * @throws Exception
113      */

114     public void addNew(Group group) throws Exception JavaDoc;
115
116     /**
117      * Select the users associated to some group;
118      *
119      * @return <code>ArrayList</code> with the user ids
120      * @throws Exception
121      */

122     public List JavaDoc selectUsersIds(int groupId) throws Exception JavaDoc;
123 }
124
Popular Tags