01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.core.model.content;
23:
24: import org.jboss.portal.common.i18n.LocalizedString;
25:
26: import java.util.Iterator;
27:
28: /**
29: * Defines the base interface for content.
30: *
31: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
32: * @version $Revision: 8786 $
33: */
34: public interface Content {
35: /**
36: * Return a localized display name of the content.
37: *
38: * @return the content display name
39: */
40: LocalizedString getDisplayName();
41:
42: /**
43: * Returns true if the content state can be changed.
44: *
45: * @return true if the content state can be changed
46: */
47: boolean isMutable();
48:
49: /**
50: * Returns the content URI.
51: *
52: * @return the content URI
53: */
54: String getURI();
55:
56: /**
57: * Updates the content URI.
58: *
59: * @param uri the new content URI value
60: * @throws IllegalStateException if the content cannot be changed for some reason
61: */
62: void setURI(String uri) throws IllegalStateException;
63:
64: Iterator getParameterNames();
65:
66: void setParameter(String name, String value)
67: throws IllegalArgumentException;
68:
69: String getParameter(String name) throws IllegalArgumentException;
70:
71: void clearParameters();
72: }
|