com.sapportals.portal.appintegrator.parameter

Interface ICustomerParameterProvider

public interface ICustomerParameterProvider

Method Summary

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

Method Detail

getParameter

String getParameter(IPortalComponentRequest request,
                    String id)
                    throws 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

Throws:

Throwable

See Also:

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

getParameterDefault

String getParameterDefault(IPortalComponentRequest request,
                           String id)
                           throws 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

Throws:

Throwable

See Also:

getParameter(IPortalComponentRequest, String)

getAllParameterNames

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

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)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/appintegration/api	api	EP-PIN