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 23, 2003 / 2:49:48 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.Post;
048:
049: /**
050: * Model interface for {@link net.jforum.entities.Post}.
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: PostDAO.java,v 1.12 2007/08/20 19:35:52 rafaelsteil Exp $
058: */
059: public interface PostDAO {
060: /**
061: * Gets a specific <code>Post</code>.
062: *
063: * @param postId The Post ID to search
064: * @return <code>Post</code>object containing all the information
065: */
066: public Post selectById(int postId);
067:
068: /**
069: * Delete a Post.
070: *
071: * @param post Post The Post to delete
072: */
073: public void delete(Post post);
074:
075: /**
076: * Updates a Post.
077: *
078: * @param post Reference to a <code>Post</code> object to update
079: */
080: public void update(Post post);
081:
082: /**
083: * Adds a new Post.
084: *
085: * @param post Post Reference to a valid and configured <code>Post</code> object
086: * @return The new ID
087: */
088: public int addNew(Post post);
089:
090: /**
091: * Selects all messages relacted to a specific topic.
092: *
093: * @param topicId The topic ID
094: * @param startFrom The count position to start fetching
095: * @param count The total number of records to retrieve
096: * @return <code>ArrayList</code> containing all records found. Each entry of the <code>ArrayList</code> is a {@link net.jforum.entities.Post} object
097: */
098: public List selectAllByTopicByLimit(int topicId, int startFrom,
099: int count);
100:
101: /**
102: * Selects all posts associated to a specific user and belonging to
103: * given forums
104: * @param userId int User ID.
105: * @param startFrom int
106: * @param count int
107: * @return List
108: */
109: public List selectByUserByLimit(int userId, int startFrom, int count);
110:
111: /**
112: * Count user posts.
113: * @param userId int
114: * @return int
115: */
116: public int countUserPosts(int userId);
117:
118: /**
119: * Selects all messages relacted to a specific topic.
120: *
121: * @param topicId The topic ID
122: * @return <code>ArrayList</code> containing all records found. Each entry of the <code>ArrayList</code> is a {@link net.jforum.entities.Post} object
123: */
124: public List selectAllByTopic(int topicId);
125:
126: /**
127: * Delete all posts related to the given topic
128: *
129: * @param topicId int
130: */
131: public void deleteByTopic(int topicId);
132:
133: /**
134: * Count how many previous posts there are before the given post id
135: * @param postId int
136: * @return int
137: */
138: public int countPreviousPosts(int postId);
139:
140: public List selectLatestByForumForRSS(int forumId, int limit);
141:
142: public List selectHotForRSS(int limit);
143: }
|