CategoryDAO


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 creation date: Feb 19, 2003 / 8:56:14 PM
40   * The JForum Project
41   * http://www.jforum.net 
42   */
43  package net.jforum.dao;
44  
45  import java.util.List  ;
46  
47  import net.jforum.entities.Category;
48  
49  /**
50   * Model interface for {@link net.jforum.Category}.
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: CategoryDAO.java,v 1.4 2005/07/26 03:04:31 rafaelsteil Exp $
58   */
59  public interface CategoryDAO 
60  {   
61      /**
62       * Gets a specific <code>Category</code>.
63       * 
64       * @param categoryId The Category ID to search
65       * @return <code>Category</code>object containing all the information
66       * @throws Exception
67       * @see #selectAll
68       */
69      public Category selectById(int categoryId) throws Exception  ;
70      
71      /**
72       * Selects all categories data from the database.
73       * 
74       * @return ArrayList with the categories found 
75       * @throws Exception
76       * @see #selectById
77       */
78      public List   selectAll() throws Exception  ;
79      
80      /**
81       * Checks if is possible to delete a specific category.
82       * 
83       * @param categoryId The category ID to verify
84       * @return <code>true</code> if is possible to delete, <code>false</code> if not
85       * @see #delete(int)
86       * @throws Exception
87       */
88      public boolean canDelete(int categoryId) throws Exception  ;
89      
90      /**
91       * Delete a category.
92       * 
93       * @param categoryId The category ID to delete
94       * @throws Exception
95       * @see #canDelete(int)
96       */
97      public void delete(int categoryId) throws Exception  ;
98      
99      /**
100      * Updates a category.
101      * 
102      * @param category Reference to a <code>Category</code> object to update
103      * @throws Exception
104      * @see #update(int)
105      */
106     public void update(Category category) throws Exception  ;
107     
108     /**
109      * Adds a new category.
110      * 
111      * @param category Reference to a valid and configured <code>Category</code> object
112      * @throws Exception
113      */
114     public int addNew(Category category) throws Exception  ;
115 
116     /**
117      * Changes the display order of some category.
118      *  
119      * @param category The <code>Category</code> instance to change its order
120      * @return An <code>int</code> containing the id of the category which 
121      * held the display order now represented by the category passed as
122      * argument to the method.
123      * 
124      * @throws Exception
125      * @see #setOrderDown(Category)
126      */
127     public void setOrderUp(Category category, Category otherCategory) throws Exception  ;
128     
129     /**
130      * Changes the display order of some category.
131      *  
132      * @param category The <code>Category</code> instance to change its order
133      * @return An <code>int</code> containing the id of the category which 
134      * held the display order now represented by the category passed as
135      * argument to the method.
136      * 
137      * @throws Exception
138      * @see #setOrderUp(Category)
139      */
140     public void setOrderDown(Category category, Category otherCategory) throws Exception  ;
141 }
142
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags