org.pentaho.platform.web.portal
Class PortletSessionParameterProvider

java.lang.Object
  org.pentaho.platform.engine.core.solution.BaseParameterProvider
      org.pentaho.platform.web.portal.PortletSessionParameterProvider

All Implemented Interfaces:

IParameterProvider, IParameterSetter

public class PortletSessionParameterProvider
extends BaseParameterProvider
implements IParameterSetter

Field Summary

Fields inherited from interface org.pentaho.platform.api.engine.IParameterProvider

SCOPE_REQUEST, SCOPE_SESSION

Constructor Summary

PortletSessionParameterProvider(IPentahoSession session)

Method Summary

java.lang.Object	getParameter(java.lang.String name) Gets the named parameter from the provider as it's native type
java.util.Iterator	getParameterNames() Return list of all avialable parameter names in this provider
java.lang.String	getStringParameter(java.lang.String name, java.lang.String defaultValue) Retrieve the requested parameter as type java.lang.String
void	setParameter(java.lang.String name, java.util.Date value) Sets a named parameter to a Date value
void	setParameter(java.lang.String name, long value) Sets a named parameter to a long value
void	setParameter(java.lang.String name, java.lang.Object value) Sets a named parameter to a Object value
void	setParameter(java.lang.String name, java.lang.String value) Sets a named parameter to a String value

Methods inherited from class org.pentaho.platform.engine.core.solution.BaseParameterProvider

getArrayParameter, getDateParameter, getDecimalParameter, getListParameter, getLongParameter, getStringArrayParameter, hasParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.platform.api.engine.IParameterProvider

getArrayParameter, getDateParameter, getDecimalParameter, getLongParameter, getStringArrayParameter, hasParameter

Constructor Detail

PortletSessionParameterProvider

public PortletSessionParameterProvider(IPentahoSession session)

Method Detail

getParameter

public java.lang.Object getParameter(java.lang.String name)

Description copied from interface: IParameterProvider

Gets the named parameter from the provider as it's native type

Specified by:

getParameter in interface IParameterProvider

Specified by:

getParameter in class BaseParameterProvider

Parameters:

name - The name of the parameter to retrieve

Returns:

The native object

getStringParameter

public java.lang.String getStringParameter(java.lang.String name,
                                           java.lang.String defaultValue)

Description copied from interface: IParameterProvider

Retrieve the requested parameter as type java.lang.String

Specified by:

getStringParameter in interface IParameterProvider

Overrides:

getStringParameter in class BaseParameterProvider

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter, or the defaultValue if not found

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

Description copied from interface: IParameterSetter

Sets a named parameter to a String value

Specified by:

setParameter in interface IParameterSetter

Parameters:

name - name of the parameter to set

value - The String value to set

setParameter

public void setParameter(java.lang.String name,
                         long value)

Description copied from interface: IParameterSetter

Sets a named parameter to a long value

Specified by:

setParameter in interface IParameterSetter

Parameters:

name - name of the parameter to set

value - The long value to set

setParameter

public void setParameter(java.lang.String name,
                         java.util.Date value)

Description copied from interface: IParameterSetter

Sets a named parameter to a Date value

Specified by:

setParameter in interface IParameterSetter

Parameters:

name - name of the parameter to set

value - The Date value to set

setParameter

public void setParameter(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: IParameterSetter

Sets a named parameter to a Object value

Specified by:

setParameter in interface IParameterSetter

Parameters:

name - name of the parameter to set

value - The Object value to set

getParameterNames

public java.util.Iterator getParameterNames()

Description copied from interface: IParameterProvider

Return list of all avialable parameter names in this provider

Specified by:

getParameterNames in interface IParameterProvider

Returns:

Set of parameter names