org.opencms.jsp.util
Class CmsDynamicFunctionFormatWrapper

java.lang.Object
  org.opencms.jsp.util.CmsDynamicFunctionFormatWrapper

public class CmsDynamicFunctionFormatWrapper
extends java.lang.Object

Wrapper class for dynamic function formats which can be used from JSP EL.

Constructor Summary

CmsDynamicFunctionFormatWrapper(CmsObject cms, CmsDynamicFunctionBean.Format format)
Creates a new wrapper instance for a given format.

Method Summary

boolean	getExists() Check if this format is actually valid, i.e. was not created with a null format argument.
java.lang.String	getJsp() Gets the jsp site path for this dynamic function format.
java.util.Map<java.lang.String,java.lang.String>	getParam() Gets the parameters for this dynamic function format.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Gets the parameters for this dynamic function format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDynamicFunctionFormatWrapper

public CmsDynamicFunctionFormatWrapper(CmsObject cms,
                                       CmsDynamicFunctionBean.Format format)

Creates a new wrapper instance for a given format.

The format parameter may be null.

Parameters:

cms - the current CMS context

format - the dynamic function format

Method Detail

getExists

public boolean getExists()

Check if this format is actually valid, i.e. was not created with a null format argument.

Returns:

true if this format is valid

getJsp

public java.lang.String getJsp()

Gets the jsp site path for this dynamic function format.

Returns:

the jsp site path for this dynamic function format

getParam

public java.util.Map<java.lang.String,java.lang.String> getParam()

Gets the parameters for this dynamic function format.

Returns:

the map of parameters for the dynamic function

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Gets the parameters for this dynamic function format.

Returns:

the map of parameters for the dynamic function