Package org.opencms.jsp.util

Class CmsDynamicFunctionFormatWrapper

java.lang.Object

org.opencms.jsp.util.CmsDynamicFunctionFormatWrapper

public class CmsDynamicFunctionFormatWrapper
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	getExists()	Check if this format is actually valid, i.e.
String	getJsp()	Gets the jsp site path for this dynamic function format.
Map<String,String>	getParam()	Gets the parameters for this dynamic function format.
Map<String,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 Details

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 Details

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 String getJsp()

Gets the jsp site path for this dynamic function format.

Returns:

the jsp site path for this dynamic function format

getParam

public Map<String,String> getParam()

Gets the parameters for this dynamic function format.

Returns:

the map of parameters for the dynamic function

getParameters

public Map<String,String> getParameters()

Gets the parameters for this dynamic function format.

Returns:

the map of parameters for the dynamic function