org.apache.jetspeed.om.registry
Interface PortletInfoEntry

All Superinterfaces:
RegistryEntry
All Known Subinterfaces:
PortletControlEntry, PortletControllerEntry, PortletEntry
All Known Implementing Classes:
BasePortletControlEntry, BasePortletControllerEntry, BasePortletEntry

public interface PortletInfoEntry
extends RegistryEntry

The PortletInfoEntry defines all the common description properties for all the portlet related entries.

Version:
$Id: PortletInfoEntry.java,v 1.5 2005/03/21 18:21:37 sgala Exp $
Author:
RaphaŽl Luta

Method Summary
 void addMediaType(java.lang.String name)
          Add a new supported media type
 void addParameter(Parameter parameter)
          Adds a new parameter for this entry
 void addParameter(java.lang.String name, java.lang.String value)
          Adds a new parameter for this entry
 void addTool(ToolDescriptor tool)
          Adds a new tool to this entry
 java.lang.String getClassname()
           
 Parameter getParameter(java.lang.String name)
          Search for a named parameter and return the associated parameter object.
 java.util.Map getParameterMap()
          Returns a map of parameter values keyed on the parameter names
 java.util.Iterator getParameterNames()
           
 ToolDescriptor getTool(java.lang.String name)
          Search for a named tool and return the associated ToolDescriptor.
 java.util.Map getToolMap()
          Returns a map of tool descriptors keyed on the tool names
 java.util.Iterator getToolNames()
           
 boolean hasMediaType(java.lang.String name)
          Test if a given media type is supported by this entry.
 java.util.Iterator listMediaTypes()
          Returns a list of the supported media type names
 void removeMediaType(java.lang.String name)
          Remove support for a given media type
 void removeParameter(java.lang.String name)
          Removes all parameter values associated with the name
 void removeTool(java.lang.String name)
          Removes the tool associated with the name
 void setClassname(java.lang.String classname)
          Sets the classname for this entry.
 
Methods inherited from interface org.apache.jetspeed.om.registry.RegistryEntry
getDescription, getId, getMetaInfo, getName, getSecurity, getSecurityRef, getTitle, isHidden, setDescription, setHidden, setMetaInfo, setName, setSecurity, setSecurityRef, setTitle
 

Method Detail

getClassname

public java.lang.String getClassname()
Returns:
the classname associated to this entry

setClassname

public void setClassname(java.lang.String classname)
Sets the classname for this entry. This classname is used for instanciating the associated element

Parameters:
classname - the classname used for instanciating the component associated with this entry

getParameterNames

public java.util.Iterator getParameterNames()
Returns:
an enumeration of this entry parameter names

getParameterMap

public java.util.Map getParameterMap()
Returns a map of parameter values keyed on the parameter names

Returns:
the parameter values map

getParameter

public Parameter getParameter(java.lang.String name)
Search for a named parameter and return the associated parameter object. The search is case sensitive.

Parameters:
name - the parameter name to look for
Returns:
the parameter object for a given parameter name

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)
Adds a new parameter for this entry

Parameters:
name - the new parameter name
value - the new parameter value

addParameter

public void addParameter(Parameter parameter)
Adds a new parameter for this entry

Parameters:
parameter - the new parameter to add

removeParameter

public void removeParameter(java.lang.String name)
Removes all parameter values associated with the name

Parameters:
name - the parameter name to remove

listMediaTypes

public java.util.Iterator listMediaTypes()
Returns a list of the supported media type names

Returns:
an iterator on the supported media type names

hasMediaType

public boolean hasMediaType(java.lang.String name)
Test if a given media type is supported by this entry.

Parameters:
name - the media type name to test for.
Returns:
true is the media type is supported, false otherwise

addMediaType

public void addMediaType(java.lang.String name)
Add a new supported media type

Parameters:
name - the media type name to add.

removeMediaType

public void removeMediaType(java.lang.String name)
Remove support for a given media type

Parameters:
name - the media type name to remove.

getToolNames

public java.util.Iterator getToolNames()
Returns:
an enumeration of this entry tool names

getToolMap

public java.util.Map getToolMap()
Returns a map of tool descriptors keyed on the tool names

Returns:
the tool descriptor map

getTool

public ToolDescriptor getTool(java.lang.String name)
Search for a named tool and return the associated ToolDescriptor. The search is case sensitive.

Parameters:
name - the tool name to look for
Returns:
the ToolDescriptor for a given name

addTool

public void addTool(ToolDescriptor tool)
Adds a new tool to this entry

Parameters:
tool - the new tool to add

removeTool

public void removeTool(java.lang.String name)
Removes the tool associated with the name

Parameters:
name - the name of the tool to remove


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.