1/*2 * Copyright 2000-2001,2004 The Apache Software Foundation.3 * 4 * Licensed under the Apache License, Version 2.0 (the "License");5 * you may not use this file except in compliance with the License.6 * You may obtain a copy of the License at7 * 8 * http://www.apache.org/licenses/LICENSE-2.09 * 10 * Unless required by applicable law or agreed to in writing, software11 * distributed under the License is distributed on an "AS IS" BASIS,12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */1617packageorg.apache.jetspeed.om.registry;
1819import java.util.Iterator;
20import java.util.Map;
2122/***23 * The PortletInfoEntry defines all the common description properties24 * for all the portlet related entries.25 *26 * @author <a href="mailto:raphael@apache.org">Raphaël Luta</a>27 * @version $Id: PortletInfoEntry.java,v 1.4 2004/02/23 03:11:39 jford Exp $28 */29publicinterfacePortletInfoEntryextendsRegistryEntry30 {
3132/*** @return the classname associated to this entry */33public String getClassname();
3435/*** Sets the classname for this entry. This classname is used for36 * instanciating the associated element37 *38 * @param classname the classname used for instanciating the component39 * associated with this entry40 */41publicvoid setClassname( String classname );
4243/*** @return an enumeration of this entry parameter names */44public Iterator getParameterNames();
4546/*** Returns a map of parameter values keyed on the parameter names47 * @return the parameter values map48 */49public Map getParameterMap();
5051/*** Search for a named parameter and return the associated52 * parameter object. The search is case sensitive.53 *54 * @return the parameter object for a given parameter name55 * @param name the parameter name to look for56 */57publicParameter getParameter( String name );
5859/*** Adds a new parameter for this entry60 * @param name the new parameter name61 * @param value the new parameter value62 */63publicvoid addParameter( String name, String value );
6465/*** Adds a new parameter for this entry66 * @param parameter the new parameter to add67 */68publicvoid addParameter( Parameter parameter );
6970/*** Removes all parameter values associated with the71 * name72 *73 * @param name the parameter name to remove74 */75publicvoid removeParameter( String name );
7677/***78 * Returns a list of the supported media type names79 *80 * @return an iterator on the supported media type names81 */82public Iterator listMediaTypes();
8384/***85 * Test if a given media type is supported by this entry.86 *87 * @param name the media type name to test for.88 * @return true is the media type is supported, false otherwise89 */90publicboolean hasMediaType(String name);
9192/***93 * Add a new supported media type94 *95 * @param name the media type name to add.96 */97publicvoid addMediaType(String name);
9899/***100 * Remove support for a given media type101 *102 * @param name the media type name to remove.103 */104publicvoid removeMediaType(String name);
105106/*** @return an enumeration of this entry tool names */107public Iterator getToolNames();
108109/*** Returns a map of tool descriptors keyed on the tool names110 * @return the tool descriptor map111 */112public Map getToolMap();
113114/*** Search for a named tool and return the associated115 * ToolDescriptor. The search is case sensitive.116 *117 * @return the ToolDescriptor for a given name118 * @param name the tool name to look for119 */120publicToolDescriptor getTool( String name );
121122/*** Adds a new tool to this entry123 * @param tool the new tool to add124 */125publicvoid addTool( ToolDescriptor tool );
126127/*** Removes the tool associated with the128 * name129 *130 * @param name the name of the tool to remove131 */132publicvoid removeTool( String name );
133134 }