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 creation date: 20/05/2004 - 15:37:25
 * The JForum Project
 * http://www.jforum.net
 */
package net.jforum.model;

import java.util.List;

import net.jforum.entities.PrivateMessage;
import net.jforum.entities.User;

/**
 * @author Rafael Steil
 * @version $Id: PrivateMessageModel.java,v 1.3 2005/01/17 12:22:30 rafaelsteil Exp $
 */
public interface PrivateMessageModel
{
	/**
	 * Send a new <code>PrivateMessage
	 * 
	 * @param pm The pm to add
	 * @throws Exception
	 */
	public void send(PrivateMessage pm) throws Exception;
	
	/**
	 * Deletes a collection of private messages.
	 * Each instance should at least have the private message
	 * id and the owner user id.
	 * 
	 * @param pm
	 * @throws Exception
	 */
	public void delete(PrivateMessage[] pm) throws Exception;
	
	/**
	 * Update the type of some private message.
	 * You should pass as argument a <code>PrivateMessage instance
	 * with the pm's id and the new message status. There is no need to
	 * fill the other members.
	 * 
	 * @param pm The instance to update 
	 * @throws Exception
	 */
	public void updateType(PrivateMessage pm) throws Exception;
	
	/**
	 * Selects all messages from the user's inbox. 
	 * 
	 * @param user The user to fetch the messages
	 * @return A <code>List with all messages found. Each 
	 * entry is a <code>PrivateMessage entry.
	 * @throws Exception
	 */
	public List selectFromInbox(User user) throws Exception;
	
	/**
	 * Selects all messages from the user's sent box. 
	 * 
	 * @param user The user to fetch the messages
	 * @return A <code>List with all messages found. Each 
	 * entry is a <code>PrivateMessage entry.
	 * @throws Exception
	 */
	public List selectFromSent(User user) throws Exception;
	
	/**
	 * Gets a <code>PrivateMessage by its id.
	 * 
	 * @param pm A <code>PrivateMessage instance containing the pm's id
	 * to retrieve
	 * @return The pm contents
	 * @throws Exception
	 */
	public PrivateMessage selectById(PrivateMessage pm) throws Exception;
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2024 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.