001: /**
002: * Copyright (C) 2001 Yasna.com. All rights reserved.
003: *
004: * ===================================================================
005: * The Apache Software License, Version 1.1
006: *
007: * Redistribution and use in source and binary forms, with or without
008: * modification, are permitted provided that the following conditions
009: * are met:
010: *
011: * 1. Redistributions of source code must retain the above copyright
012: * notice, this list of conditions and the following disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The end-user documentation included with the redistribution,
020: * if any, must include the following acknowledgment:
021: * "This product includes software developed by
022: * Yasna.com (http://www.yasna.com)."
023: * Alternately, this acknowledgment may appear in the software itself,
024: * if and wherever such third-party acknowledgments normally appear.
025: *
026: * 4. The names "Yazd" and "Yasna.com" must not be used to
027: * endorse or promote products derived from this software without
028: * prior written permission. For written permission, please
029: * contact yazd@yasna.com.
030: *
031: * 5. Products derived from this software may not be called "Yazd",
032: * nor may "Yazd" appear in their name, without prior written
033: * permission of Yasna.com.
034: *
035: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL YASNA.COM OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: *
049: * This software consists of voluntary contributions made by many
050: * individuals on behalf of Yasna.com. For more information
051: * on Yasna.com, please see <http://www.yasna.com>.
052: */package com.Yasna.forum;
053:
054: import java.util.Iterator;
055: import java.util.Date;
056:
057: public interface ForumGroup {
058:
059: /**
060: * Returns the unique id of the ForumGroup.
061: *
062: * @return the unique id of the ForumGroup.
063: */
064: public int getID();
065:
066: /**
067: * Returns the name of the ForumGroup.
068: *
069: * @return the name of the ForumGroup.
070: */
071: public String getName();
072:
073: /**
074: * Sets the name of the ForumGroup.
075: *
076: * @param name the name of the ForumGroup.
077: * @throws UnauthorizedException if does not have ADMIN permissions.
078: */
079: public void setName(String name) throws UnauthorizedException;
080:
081: /**
082: * Returns the description of the ForumGroup.
083: *
084: * @return the description of the ForumGroup.
085: */
086: public String getDescription();
087:
088: /**
089: * This returns the order of the group. This number is used to order the groups by.
090: * @return order of the group
091: */
092: public int getOrder();
093:
094: /**
095: * This method is used to set the order of the group. This number is used to order the groups by.
096: * @param param
097: */
098: public void setOrder(int param) throws UnauthorizedException;
099:
100: /**
101: * Sets the description of the ForumGroup.
102: *
103: * @param description the description of the ForumGroup.
104: * @throws UnauthorizedException if does not have ADMIN permissions.
105: */
106: public void setDescription(String description)
107: 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 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 creationDate)
123: throws UnauthorizedException;
124:
125: /**
126: * Returns the Date that the ForumGroup was last modified.
127: *
128: * @return the Date the ForumGroup was last modified.
129: */
130: public Date getModifiedDate();
131:
132: /**
133: * Sets the date the ForumGroup was last modified.
134: *
135: * @param modifiedDate the date the ForumGroup was modified.
136: * @throws UnauthorizedException if does not have ADMIN permissions.
137: */
138: public void setModifiedDate(Date modifiedDate)
139: throws UnauthorizedException;
140:
141: /**
142: * Returns an Iterator for the ForumGroup to move through the forums.
143: */
144: public Iterator forums();
145:
146: }
|