alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 * Copyright (c) 2003, Rafael Steil
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, 
 * with or without modification, are permitted provided 
 * that the following conditions are met:
 * 
 * 1) Redistributions of source code must retain the above 
 * copyright notice, this list of conditions and the 
 * following  disclaimer.
 * 2)  Redistributions in binary form must reproduce the 
 * above copyright notice, this list of conditions and 
 * the following disclaimer in the documentation and/or 
 * other materials provided with the distribution.
 * 3) Neither the name of "Rafael Steil" nor 
 * the names of its contributors may be used to endorse 
 * or promote products derived from this software without 
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT 
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
 * IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
 * 
 * This file creating date: Feb 23, 2003 / 2:49:48 PM
 * The JForum Project
 * http://www.jforum.net
 */
package net.jforum.model;

import java.util.List;

import net.jforum.entities.Post;

/**
  * Model interface for {@link net.jforum.Post}.
 * This interface defines methods which are expected to be
 * implementd by a specific data access driver. The intention is
 * to provide all functionality needed to update, insert, delete and
 * select some specific data.
 * 
 * @author Rafael Steil
 * @version $Id: PostModel.java,v 1.4 2004/11/05 03:29:50 rafaelsteil Exp $
 */
public interface PostModel 
{
	/**
	 * Gets a specific <code>Post.
	 * 
	 * @param postId The Post ID to search
	 * @return <code>Postobject containing all the information
	 * @throws Exception
	 * @see #selectAll
	 */
	public Post selectById(int postId) throws Exception;
		
	/**
	 * Delete a Post.
	 * 
	 * @param Post The Post to delete
	 * @throws Exception
	 * @see #canDelete(int)
	 */
	public void delete(Post post) throws Exception;
	
	/**
	 * Updates a Post.
	 * 
	 * @param post Reference to a <code>Post object to update
	 * @throws Exception
	 * @see #update(int)
	 */
	public void update(Post post) throws Exception;
	
	/**
	 * Adds a new Post.
	 * 
	 * @param Post Reference to a valid and configured <code>Post object
	 * @return The new ID
	 * @throws Exception
	 */
	public int addNew(Post post) throws Exception;
	
	/**
	 * Sets the ID of the last post in the topic's table
	 * 
	 * @param postId Post ID
	 * @param topicId Topic ID
	 * @throws Exception
	 */
	public void setLastPostIdInTopic(int postId, int topicId) throws Exception;

	/**
	 * Sets the ID of the last post of the forum's table
	 * 
	 * @param postId Post ID
	 * @param forumId Forum ID
	 * @throws Exception
	 */
	public void setLastPostIdInForum(int postId, int forumId) throws Exception;
	
	/**
	 * Selects all messages relacted to a specific topic. 
	 * 
	 * @param topicId The topic ID 
	 * @param startFrom The count position to start fetching
	 * @param count The total number of records to retrieve
	 * @return <code>ArrayList containing all records found. Each entry of the ArrayList is a {@link net.jforum.Post} object
	 * @throws Exception
	 */
	public List selectAllByTopicByLimit(int topicId, int startFrom, int count) throws Exception;
	
	/**
	 * Selects all messages relacted to a specific topic. 
	 * 
	 * @param topicId The topic ID 
	 * @return <code>ArrayList containing all records found. Each entry of the ArrayList is a {@link net.jforum.Post} object
	 * @throws Exception
	 */	
	public List selectAllByTopic(int topicId) throws Exception;
	
	/**
	 * Delete all posts related to the given topic
	 * 
	 * @param topicId
	 * @throws Exception
	 */
	public void deleteByTopic(int topicId) throws Exception;
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.