com.sapportals.portal.appintegrator

Interface ILayerProcessor


public interface ILayerProcessor

Description


Method Summary
 void clear()
          clears this and all depended objects
 Set getAllParameterNames()
          Returns a set of the mandatory and optional parameter names of the whole layer stack.
 Object getParameter(String id)
          Returns the value of the parameter given by its id.
 void processActionPass()
          Processes pass 1 (action pass) of the layer stack
 void processContentPass(IPortalComponentResponse response)
          processes pass2 (content pass) of the layer stack
 

Method Detail

getParameter

Object getParameter(String id)
Returns the value of the parameter given by its id. At first the request is checked for the parameter. On failure the node is checked and finally the profile.

Parameters:
id - the parameter id
Returns:
the parameter value as defined by the request, the node or the profile

getAllParameterNames

Set getAllParameterNames()
Returns a set of the mandatory and optional parameter names of the whole layer stack. Since the returned value is a set it will not contain duplicated entries.

Returns:
a set containing the mandatory and optional parameter names of the whole layer stack.

processActionPass

void processActionPass()
                       throws ApplicationIntegratorException
Processes pass 1 (action pass) of the layer stack

Throws:
ApplicationIntegratorException
See Also:
processContentPass(IPortalComponentResponse), IPortalComponentResponse

processContentPass

void processContentPass(IPortalComponentResponse response)
                        throws ApplicationIntegratorException
processes pass2 (content pass) of the layer stack

Parameters:
response - the Portal Component Response
Throws:
ApplicationIntegratorException
See Also:
processActionPass(), IPortalComponentResponse

clear

void clear()
clears this and all depended objects

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


Copyright 2011 SAP AG Complete Copyright Notice