com.sapportals.portal.prt.service.hook

Interface IParameterMappingHook

All Superinterfaces:
IHook

public interface IParameterMappingHook
extends IHook

A hook that gives the possibility to affect parameter interpretation during the request cycle. The hook allows to return a value for a certain key that was not passed as a parameter in the request by mapping it to another parameter value.


Method Summary
 String getParameter(String key, IPortalComponentRequest request)
          Return a mapped parameter value for the given key.
 boolean isMappingNeeded(String key, IPortalComponentRequest request)
          Performs a fast check if the current key and request pair need mapping in the current hook implementation.
 
Methods inherited from interface com.sapportals.portal.prt.service.hook.IHook
getType
 

Method Detail

isMappingNeeded

boolean isMappingNeeded(String key,
                        IPortalComponentRequest request)
Performs a fast check if the current key and request pair need mapping in the current hook implementation.

Parameters:
key - Name of parameter that is requested.
request - The IPortalComponentRequest instance of the current request cycle.
Returns:
A Boolean value indicating if mapping is needed.

getParameter

String getParameter(String key,
                    IPortalComponentRequest request)
Return a mapped parameter value for the given key.

Parameters:
key - Name of parameter that is requested.
request - The IPortalComponentRequest instance of the current request cycle.
Returns:
The mapped value of the current parameter.
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-BASIS-API [sap.com] tc/epbc/prt/api api EP-PIN
[sap.com] EP-BASIS-API [sap.com] tc/epbc/prt/lib/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice