com.sapportals.portal.appintegrator.parameter
Interface ICustomerParameterProvider

public interface ICustomerParameterProvider

Version:

$Revision: #2 $.

Method Summary

java.util.Enumeration	getAllParameterNames() Returns an Enumeration of all parameters that are known by this custom parameter provider
java.lang.String	getParameter(com.sapportals.portal.prt.component.IPortalComponentRequest request, java.lang.String id) Returns the value for the parameter defined by its id.
java.lang.String	getParameterDefault(com.sapportals.portal.prt.component.IPortalComponentRequest request, java.lang.String id) Returns the default value for the parameter defined by its id.
java.lang.String	getProviderName() Returns the custom parameter provider's name.

Method Detail

getParameter

public java.lang.String getParameter(com.sapportals.portal.prt.component.IPortalComponentRequest request,
                                     java.lang.String id)
                              throws java.lang.Throwable

Returns the value for the parameter defined by its id. If the custom parameter provider doesn't define the parameter it should return null. All java.lang.Throwable that this method throws are catched and logged; further the custom parameter provider is ignored for this parameter-id and treated as it had returned null.

Parameters:

request - the Portal component request

id - the id of the parameter

Returns:

the value for the parameter with id=id or null

See Also:

getParameterDefault(IPortalComponentRequest, String), getProviderName(), Throwable

getParameterDefault

public java.lang.String getParameterDefault(com.sapportals.portal.prt.component.IPortalComponentRequest request,
                                            java.lang.String id)
                                     throws java.lang.Throwable

Returns the default value for the parameter defined by its id. For details see getParameter(IPortalComponentRequest, String)

Parameters:

request - the Portal component request

id - the id of the parameter

Returns:

the default value for the parameter with id=id or null

See Also:

getParameter(IPortalComponentRequest, String)

getAllParameterNames

public java.util.Enumeration getAllParameterNames()

Returns an Enumeration of all parameters that are known by this custom parameter provider

Returns:

Enumeration of Strings of all known parameter ids

getProviderName

public java.lang.String getProviderName()

Returns the custom parameter provider's name. This method is called to produce more accurate log entries when an exception inside getParameter(IPortalComponentRequest, String) or getParameterDefault(IPortalComponentRequest, String) occured.

Returns:

the name of this custom parameter provider

See Also:

getParameter(IPortalComponentRequest, String), getParameterDefault(IPortalComponentRequest, String)