001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.blog;
031:
032: import java.util.Map;
033:
034: /**
035: * Category
036: *
037: * @author David Czarnecki
038: * @since blojsom 3.0
039: * @version $Id: Category.java,v 1.4 2007/01/17 02:35:16 czarneckid Exp $
040: */
041: public interface Category {
042:
043: /**
044: * Get the category ID
045: *
046: * @return Category ID
047: */
048: Integer getId();
049:
050: /**
051: * Set the category ID
052: *
053: * @param id Category ID
054: */
055: void setId(Integer id);
056:
057: /**
058: * Get the blog parent category ID
059: *
060: * @return Parent category ID
061: */
062: Integer getParentCategoryId();
063:
064: /**
065: * Se the parent category ID
066: *
067: * @param parentCategoryId Parent category ID
068: */
069: void setParentCategoryId(Integer id);
070:
071: /**
072: * Get the blog ID
073: *
074: * @return Blog ID
075: */
076: Integer getBlogId();
077:
078: /**
079: * Set the blog ID
080: *
081: * @param blogId Blog ID
082: */
083: void setBlogId(Integer blogId);
084:
085: /**
086: * Return the category name
087: *
088: * @return Category name
089: */
090: String getName();
091:
092: /**
093: * Return the category name encoded for a link
094: *
095: * @return Category name encoded as UTF-8 with preserved "/" and "+" characters
096: */
097: String getEncodedName();
098:
099: /**
100: * Set a new name for this category
101: *
102: * @param name Category name
103: */
104: void setName(String name);
105:
106: /**
107: * Sets the description of this category
108: *
109: * @param desc The new description of the category
110: */
111: void setDescription(String desc);
112:
113: /**
114: * Retrieves the description of this category
115: *
116: * @return The description of the category
117: */
118: String getDescription();
119:
120: /**
121: * Set the meta-data associated with this category
122: *
123: * @param metadata The map to be associated with the category as meta-data
124: */
125: void setMetaData(Map metadata);
126:
127: /**
128: * Retrieves the meta-data associated with this category
129: *
130: * @return The properties associated with the category as meta-data, or null if no metadata exists
131: */
132: Map getMetaData();
133:
134: /**
135: * Returns the parent category of this category. Defaults to "/"
136: *
137: * @return {@link org.blojsom.blog.Category} containing the parent category
138: */
139: Category getParentCategory();
140:
141: /**
142: * Sets the parent category of this category
143: *
144: * @param cateogory {@link org.blojsom.blog.Category} that represents the parent category
145: */
146: void setParentCategory(Category category);
147: }
|