Category


1   /**
2    * Copyright (c) 2003-2006, David A. Czarnecki
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are met:
7    *
8    * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9    *     following disclaimer.
10   * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11   *     following disclaimer in the documentation and/or other materials provided with the distribution.
12   * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13   *     endorse or promote products derived from this software without specific prior written permission.
14   * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15   *     without prior written permission of David A. Czarnecki.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20   * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21   * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26   * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package org.blojsom.blog;
32  
33  import java.util.Map  ;
34  
35  /**
36   * Category
37   *
38   * @author David Czarnecki
39   * @since blojsom 3.0
40   * @version $Id: Category.java,v 1.3 2006/09/26 02:55:21 czarneckid Exp $
41   */
42  public interface Category {
43  
44      /**
45       * Get the category ID
46       *
47       * @return Category ID
48       */
49      Integer   getId();
50  
51      /**
52       * Set the category ID
53       *
54       * @param id Category ID
55       */
56      void setId(Integer   id);
57  
58      /**
59       * Get the blog parent category ID
60       *
61       * @return Parent category ID
62       */
63      Integer   getParentCategoryId();
64  
65      /**
66       * Se the parent category ID
67       *
68       * @param parentCategoryId Parent category ID
69       */
70      void setParentCategoryId(Integer   id);
71  
72      /**
73       * Get the blog ID
74       *
75       * @return Blog ID
76       */
77      Integer   getBlogId();
78  
79      /**
80       * Set the blog ID
81       *
82       * @param blogId Blog ID
83       */
84      void setBlogId(Integer   blogId);
85  
86      /**
87       * Return the category name
88       *
89       * @return Category name
90       */
91      String   getName();
92  
93      /**
94       * Return the category name encoded for a link
95       *
96       * @return Category name encoded as UTF-8 with preserved "/" and "+" characters
97       */
98      String   getEncodedName();
99  
100     /**
101      * Set a new name for this category
102      *
103      * @param name Category name
104      */
105     void setName(String   name);
106 
107     /**
108      * Sets the description of this category
109      *
110      * @param desc The new description of the category
111      */
112     void setDescription(String   desc);
113 
114     /**
115      * Retrieves the description of this category
116      *
117      * @return The description of the category
118      */
119     String   getDescription();
120 
121     /**
122      * Set the meta-data associated with this category
123      *
124      * @param metadata The map to be associated with the category as meta-data
125      */
126     void setMetaData(Map   metadata);
127 
128     /**
129      * Retrieves the meta-data associated with this category
130      *
131      * @return The properties associated with the category as meta-data, or null if no metadata exists
132      */
133     Map   getMetaData();
134 
135     /**
136      * Returns the parent category of this category. Defaults to "/"
137      *
138      * @return {@link org.blojsom.blog.Category} containing the parent category
139      */
140     Category getParentCategory();
141 
142     /**
143      * Sets the parent category of this category
144      *
145      * @param cateogory {@link org.blojsom.blog.Category} that represents the parent category
146      */
147     void setParentCategory(Category category);
148 }
149
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags