org.apache.jetspeed.util
Interface Config

All Known Subinterfaces:
PortletConfig, PortletControlConfig, PortletControllerConfig
All Known Implementing Classes:
BaseConfig, BasePortletConfig, BasePortletControlConfig, BasePortletControllerConfig

public interface Config

Defines a standard object configuration A Config provides the parameters passed in the current request as well as init parameters.

Version:
$Id: Config.java,v 1.11 2005/03/21 18:21:44 sgala Exp $
Author:
RaphaŽl Luta

Method Summary
 void addInitParameters(java.util.Map init_params)
          Used to override Portlet's parameters.
 java.lang.String getInitParameter(java.lang.String name)
          Returns a parameter (or null) that was given the controller.
 java.lang.String getInitParameter(java.lang.String name, java.lang.String defaultValue)
          Returns a parameter (or defaultValue) that was given the controller.
 java.util.Iterator getInitParameterNames()
          Returns the parameter names of this Config.
 java.util.Map getInitParameters()
          Retrieves the PortletController parameters
 java.lang.String getName()
          Returns the name for this configuration
 void setInitParameter(java.lang.String name, java.lang.Object value)
          Used to define a PortletController's parameter.if value is null, removes the key from the stored properties
 void setInitParameters(java.util.Map init_params)
          Used to define a Portlet's parameters.
 void setName(java.lang.String name)
          Sets the name of this configuration
 

Method Detail

getName

public java.lang.String getName()
Returns the name for this configuration


setName

public void setName(java.lang.String name)
Sets the name of this configuration


setInitParameters

public void setInitParameters(java.util.Map init_params)
Used to define a Portlet's parameters.


addInitParameters

public void addInitParameters(java.util.Map init_params)
Used to override Portlet's parameters.


getInitParameters

public java.util.Map getInitParameters()
Retrieves the PortletController parameters


setInitParameter

public void setInitParameter(java.lang.String name,
                             java.lang.Object value)
Used to define a PortletController's parameter.if value is null, removes the key from the stored properties


getInitParameter

public java.lang.String getInitParameter(java.lang.String name)
Returns a parameter (or null) that was given the controller.


getInitParameter

public java.lang.String getInitParameter(java.lang.String name,
                                         java.lang.String defaultValue)
Returns a parameter (or defaultValue) that was given the controller.


getInitParameterNames

public java.util.Iterator getInitParameterNames()
Returns the parameter names of this Config.



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