com.sapportals.wcm.repository.service.layout.customizing

Interface ILayoutSet

All Superinterfaces:

Cloneable

public interface ILayoutSet
extends Cloneable

The Parameters is a set of parameters used within the com.sapportals.rendering package. It provides a Properties like access to values with a default mechanism. A default Parameters object can be provided which is used, when a value is not found in the current object and in the getParameter methods a default value can be provided. Null key's or values are not permitted. All values are stored as String and can be retrieved as int or boolean as well. A special paramter with the key IParameterName.PARAMETERSET can be used to include other paramters sets within this paramter set. All included paramters sets are used to search for a key, if this key is not found in the main set.

Method Summary

IParameterMap[]	getAllParameters()
List	getMultiValueParameter(IFlavor context, IParameterName key) Searches for the parameter with the specified key.
String	getParameter(IFlavor context, IParameterName key) Searches for the parameter with the specified key.
boolean	getParameter(IFlavor context, IParameterName key, boolean defaultValue) Searches for the parameter with the specified key.
int	getParameter(IFlavor context, IParameterName key, int defaultValue) Searches for the parameter with the specified key.
String	getParameter(IFlavor context, IParameterName key, String defaultValue)
IParameterMap	getParameters(IFlavor context, IParameterName[] keys)
void	removeParameter(IFlavor context, IParameterName key)
IParameterMap	setCollectionRendererSet(IFlavor context, IParameterMap impParameters)
Object	setParameter(IFlavor context, IParameterName key, Object value)
IParameterMap	setResourceRendererSet(IFlavor context, IParameterMap impParameters)

Method Detail

getMultiValueParameter

List getMultiValueParameter(IFlavor context,
                            IParameterName key)

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns null if the parameter is not found. The parameter is returned as java.util.List , even if it is a single Value Parameter. The class of the returned objects in the list can be asked via key.getMetaDate().getParameterClass()

Parameters:

key - the parameters key.

Returns:

the value in this parameter set with the specified key value.

getParameter

String getParameter(IFlavor context,
                    IParameterName key)

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns null if the parameter is not found.

Parameters:

key - the parameters key.

Returns:

the value in this parameter set with the specified key value.

getParameter

String getParameter(IFlavor context,
                    IParameterName key,
                    String defaultValue)

getParameter

int getParameter(IFlavor context,
                 IParameterName key,
                 int defaultValue)

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as int if possible.

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getParameter

boolean getParameter(IFlavor context,
                     IParameterName key,
                     boolean defaultValue)

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as boolean . The boolean returned represents the value true if the parameters value is equal, ignoring case, to the string "true" .

Example: Boolean.valueOf("True") returns true .
Example: Boolean.valueOf("yes") returns false .

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getParameters

IParameterMap getParameters(IFlavor context,
                            IParameterName[] keys)

getAllParameters

IParameterMap[] getAllParameters()

setParameter

Object setParameter(IFlavor context,
                    IParameterName key,
                    Object value)
                    throws LayoutServiceConfigLoadException

Throws:

LayoutServiceConfigLoadException

removeParameter

void removeParameter(IFlavor context,
                     IParameterName key)

setCollectionRendererSet

IParameterMap setCollectionRendererSet(IFlavor context,
                                       IParameterMap impParameters)
                                       throws LayoutServiceConfigLoadException

Throws:

LayoutServiceConfigLoadException

setResourceRendererSet

IParameterMap setResourceRendererSet(IFlavor context,
                                     IParameterMap impParameters)
                                     throws LayoutServiceConfigLoadException

Throws:

LayoutServiceConfigLoadException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM