001: /*
002: * Copyright (c) JForum Team
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms,
006: * with or without modification, are permitted provided
007: * that the following conditions are met:
008: *
009: * 1) Redistributions of source code must retain the above
010: * copyright notice, this list of conditions and the
011: * following disclaimer.
012: * 2) Redistributions in binary form must reproduce the
013: * above copyright notice, this list of conditions and
014: * the following disclaimer in the documentation and/or
015: * other materials provided with the distribution.
016: * 3) Neither the name of "Rafael Steil" nor
017: * the names of its contributors may be used to endorse
018: * or promote products derived from this software without
019: * specific prior written permission.
020: *
021: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
022: * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
023: * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
024: * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
025: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
026: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
027: * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
028: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
029: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
030: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
031: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
032: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
033: * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
034: * IN CONTRACT, STRICT LIABILITY, OR TORT
035: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
036: * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
037: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
038: *
039: * This file creating date: Feb 19, 2003 / 8:56:28 PM
040: * The JForum Project
041: * http://www.jforum.net
042: */
043: package net.jforum.dao;
044:
045: import java.util.List;
046:
047: import net.jforum.entities.Group;
048:
049: /**
050: * Model interface for {@link net.jforum.entities.Group}.
051: * This interface defines methods which are expected to be
052: * implementd by a specific data access driver. The intention is
053: * to provide all functionality needed to update, insert, delete and
054: * select some specific data.
055: *
056: * @author Rafael Steil
057: * @version $Id: GroupDAO.java,v 1.6 2006/08/23 02:13:34 rafaelsteil Exp $
058: */
059: public interface GroupDAO {
060: /**
061: * Gets a specific <code>Group</code>.
062: *
063: * @param groupId The Group ID to search
064: * @return <code>Group</code>object containing all the information
065: * @see #selectAll
066: */
067: public Group selectById(int groupId);
068:
069: /**
070: * Get all groups
071: *
072: * @return <code>ArrayList</code> containing the groups. Each entry
073: * is an <code>Group</code> object.
074: */
075: public List selectAll();
076:
077: /**
078: * Checks if is possible to delete a specific group.
079: *
080: * @param groupId The group ID to verify
081: * @return <code>true</code> if is possible to delete, <code>false</code> if not
082: * @see #delete(int)
083: */
084: public boolean canDelete(int groupId);
085:
086: /**
087: * Deletes a group.
088: *
089: * @param groupId The group ID to delete
090: * @see #canDelete(int)
091: */
092: public void delete(int groupId);
093:
094: /**
095: * Updates a group.
096: *
097: * @param group Reference to a <code>Group</code> object to update
098: */
099: public void update(Group group);
100:
101: /**
102: * Adds a new group.
103: *
104: * @param group Reference to a valid and configured <code>Group</code> object
105: */
106: public void addNew(Group group);
107:
108: /**
109: * Select the users associated to some group;
110: *
111: * @return <code>ArrayList</code> with the user ids
112: * @param groupId int
113: */
114: public List selectUsersIds(int groupId);
115: }
|