org.apache.jetspeed.util
Class PortletConfigState

java.lang.Object
  org.apache.jetspeed.util.PortletConfigState

public class PortletConfigState

extends java.lang.Object

Defines standard utility functions for config parameters

Version:

$Id: PortletConfigState.java,v 1.4 2004/02/23 03:23:42 jford Exp $

Author:

David Sean Taylor, Mark Orciuch, Scott T. Weaver

Constructor Summary

PortletConfigState()

Method Summary

static void	clearInstanceParameter(Portlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName)
static void	clearInstanceParameter(VelocityPortlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName)
static java.lang.String	getConfigParameter(Portlet portlet, java.lang.String attrName, java.lang.String attrDefaultValue) Returns the parameter for this name from the xreg
static java.lang.String	getConfigParameter(VelocityPortlet portlet, java.lang.String attrName, java.lang.String attrDefaultValue) Returns the parameter for this name from the xreg
static java.lang.String	getInstanceParameter(Portlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName) Returns the parameter for this name from the psml
static java.lang.String	getInstanceParameter(VelocityPortlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName) Returns the parameter for this name from the psml
static java.lang.String	getParameter(Portlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName, java.lang.String attrDefValue)
static java.lang.String	getParameter(VelocityPortlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName, java.lang.String attrDefValue)
static void	setInstanceParameter(Portlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName, java.lang.String attrValue) Sets the parameter in the psml
static void	setInstanceParameter(VelocityPortlet portlet, org.apache.turbine.util.RunData rundata, java.lang.String attrName, java.lang.String attrValue) Sets the parameter in the psml
static void	setPortletConfigParameter(Portlet portlet, java.lang.String name, java.lang.String value) Sets the registry (.xreg) value of this portlet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletConfigState

public PortletConfigState()

Method Detail

getConfigParameter

public static java.lang.String getConfigParameter(Portlet portlet,
                                                  java.lang.String attrName,
                                                  java.lang.String attrDefaultValue)

Returns the parameter for this name from the xreg

getInstanceParameter

public static java.lang.String getInstanceParameter(Portlet portlet,
                                                    org.apache.turbine.util.RunData rundata,
                                                    java.lang.String attrName)

Returns the parameter for this name from the psml

setInstanceParameter

public static void setInstanceParameter(Portlet portlet,
                                        org.apache.turbine.util.RunData rundata,
                                        java.lang.String attrName,
                                        java.lang.String attrValue)

Sets the parameter in the psml

clearInstanceParameter

public static void clearInstanceParameter(Portlet portlet,
                                          org.apache.turbine.util.RunData rundata,
                                          java.lang.String attrName)

getParameter

public static java.lang.String getParameter(Portlet portlet,
                                            org.apache.turbine.util.RunData rundata,
                                            java.lang.String attrName,
                                            java.lang.String attrDefValue)

getConfigParameter

public static java.lang.String getConfigParameter(VelocityPortlet portlet,
                                                  java.lang.String attrName,
                                                  java.lang.String attrDefaultValue)

Returns the parameter for this name from the xreg

getInstanceParameter

public static java.lang.String getInstanceParameter(VelocityPortlet portlet,
                                                    org.apache.turbine.util.RunData rundata,
                                                    java.lang.String attrName)

Returns the parameter for this name from the psml

setInstanceParameter

public static void setInstanceParameter(VelocityPortlet portlet,
                                        org.apache.turbine.util.RunData rundata,
                                        java.lang.String attrName,
                                        java.lang.String attrValue)

Sets the parameter in the psml

clearInstanceParameter

public static void clearInstanceParameter(VelocityPortlet portlet,
                                          org.apache.turbine.util.RunData rundata,
                                          java.lang.String attrName)

getParameter

public static java.lang.String getParameter(VelocityPortlet portlet,
                                            org.apache.turbine.util.RunData rundata,
                                            java.lang.String attrName,
                                            java.lang.String attrDefValue)

setPortletConfigParameter

public static void setPortletConfigParameter(Portlet portlet,
                                             java.lang.String name,
                                             java.lang.String value)

Sets the registry (.xreg) value of this portlet. Use this method because PortletConfig.setInitParameter() is all but useless in this case. The portlet config availble in the Portlet is never saved back to the registry.