com.sapportals.portal.prt.service.epcftoolbox

Interface IEpcfToolbox

All Superinterfaces:
IService

public interface IEpcfToolbox
extends IService

The interface for the EPCF toolbox service, which provides helper classes that enable you to generate the JavaScript code necessary for sharing data between portal components using the client framework.


Field Summary
static String KEY
          The service key
 
Method Summary
 IClientEventReceiver getClientEventReceiver(IPortalComponentRequest request, String eventUrn, String eventName)
          Provides a receiver object instance for working with the EPCF toolbox.
 IClientEventSender getClientEventSender(IPortalComponentRequest request, String eventUrn, String eventName)
          Provides a sender object instance for working with the EPCF toolbox.
 
Methods inherited from interface com.sapportals.portal.prt.service.IService
afterInit, configure, destroy, getContext, getKey, init, release
 

Field Detail

KEY

static final String KEY
The service key

See Also:
Constant Field Values
Method Detail

getClientEventSender

IClientEventSender getClientEventSender(IPortalComponentRequest request,
                                        String eventUrn,
                                        String eventName)
Provides a sender object instance for working with the EPCF toolbox.

Parameters:
request - the portal component request
eventUrn - the namespace of the event. The RFC2141 is not fully supported, no single or double quotes or escaped characters are allowed.
eventName - the name of the event. May only contain the characters from the following set [A-Z0-9_-]. No single or double quotes or escaped characters are allowed.
Returns:
sender object instance

getClientEventReceiver

IClientEventReceiver getClientEventReceiver(IPortalComponentRequest request,
                                            String eventUrn,
                                            String eventName)
Provides a receiver object instance for working with the EPCF toolbox.

Parameters:
request - portal component request
eventUrn - the namespace of the event. The RFC2141 is not fully supported, no single or double quotes or escaped characters are allowed.
eventName - the name of the event, may only contain the characters from the following set [A-Z0-9_-]. No single or double quotes or escaped characters are allowed.
Returns:
receiver object instance
Access Rights

This class can be accessed from:


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


Copyright 2015 SAP AG Complete Copyright Notice