KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Yasna > forum > ForumGroup


1 /**
2  * Copyright (C) 2001 Yasna.com. All rights reserved.
3  *
4  * ===================================================================
5  * The Apache Software License, Version 1.1
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by
22  * Yasna.com (http://www.yasna.com)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Yazd" and "Yasna.com" must not be used to
27  * endorse or promote products derived from this software without
28  * prior written permission. For written permission, please
29  * contact yazd@yasna.com.
30  *
31  * 5. Products derived from this software may not be called "Yazd",
32  * nor may "Yazd" appear in their name, without prior written
33  * permission of Yasna.com.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL YASNA.COM OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of Yasna.com. For more information
51  * on Yasna.com, please see <http://www.yasna.com>.
52  */
53
54 package com.Yasna.forum;
55
56 import java.util.Iterator JavaDoc;
57 import java.util.Date JavaDoc;
58
59 public interface ForumGroup {
60
61   /**
62    * Returns the unique id of the ForumGroup.
63    *
64    * @return the unique id of the ForumGroup.
65    */
66   public int getID();
67
68   /**
69    * Returns the name of the ForumGroup.
70    *
71    * @return the name of the ForumGroup.
72    */
73   public String JavaDoc getName();
74
75   /**
76    * Sets the name of the ForumGroup.
77    *
78    * @param name the name of the ForumGroup.
79    * @throws UnauthorizedException if does not have ADMIN permissions.
80    */
81   public void setName(String JavaDoc name) throws UnauthorizedException;
82
83   /**
84    * Returns the description of the ForumGroup.
85    *
86    * @return the description of the ForumGroup.
87    */
88   public String JavaDoc getDescription();
89
90     /**
91      * This returns the order of the group. This number is used to order the groups by.
92      * @return order of the group
93      */
94   public int getOrder();
95
96     /**
97      * This method is used to set the order of the group. This number is used to order the groups by.
98      * @param param
99      */
100   public void setOrder(int param) throws UnauthorizedException;
101   /**
102    * Sets the description of the ForumGroup.
103    *
104    * @param description the description of the ForumGroup.
105    * @throws UnauthorizedException if does not have ADMIN permissions.
106    */
107   public void setDescription(String JavaDoc description) throws UnauthorizedException;
108
109   /**
110    * Returns the Date that the ForumGroup was created.
111    *
112    * @return the Date the ForumGroup was created.
113    */
114   public Date JavaDoc getCreationDate();
115
116   /**
117    * Sets the creation date of the ForumGroup.
118    *
119    * @param creationDate the date the ForumGroup was created.
120    * @throws UnauthorizedException if does not have ADMIN permissions.
121    */
122   public void setCreationDate(Date JavaDoc creationDate) throws UnauthorizedException;
123
124   /**
125    * Returns the Date that the ForumGroup was last modified.
126    *
127    * @return the Date the ForumGroup was last modified.
128    */
129   public Date JavaDoc getModifiedDate();
130
131   /**
132    * Sets the date the ForumGroup was last modified.
133    *
134    * @param modifiedDate the date the ForumGroup was modified.
135    * @throws UnauthorizedException if does not have ADMIN permissions.
136    */
137   public void setModifiedDate(Date JavaDoc modifiedDate) throws UnauthorizedException;
138
139   /**
140    * Returns an Iterator for the ForumGroup to move through the forums.
141    */
142   public Iterator JavaDoc forums();
143
144 }
145
Popular Tags