com.sapportals.portal.prt.service.epcftoolbox
Interface IEpcfToolbox

All Superinterfaces:

com.sapportals.portal.prt.service.IService

public interface IEpcfToolbox

extends com.sapportals.portal.prt.service.IService

interface for EpcfToolbox service. The interface provides helper classes which allows you to generate the JavaScript code necessary for sharing data between the portal components using the Client Framework.

Field Summary

static java.lang.String

KEY the service key

Method Summary

IClientEventReceiver	getClientEventReceiver(com.sapportals.portal.prt.component.IPortalComponentRequest request, java.lang.String eventUrn, java.lang.String eventName) provides a receiver object instance for eventing pattern
IClientEventSender	getClientEventSender(com.sapportals.portal.prt.component.IPortalComponentRequest request, java.lang.String eventUrn, java.lang.String eventName) provides a sender object instance for eventing pattern

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

public static final java.lang.String KEY

the service key

Method Detail

getClientEventSender

public IClientEventSender getClientEventSender(com.sapportals.portal.prt.component.IPortalComponentRequest request,
                                               java.lang.String eventUrn,
                                               java.lang.String eventName)

provides a sender object instance for eventing pattern

Parameters:

request - portal component request

eventUrn - namespace of the event. The RFC2141 is not fully supported, no single or double quotes or escaped characters are allowed.

eventName - 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

public IClientEventReceiver getClientEventReceiver(com.sapportals.portal.prt.component.IPortalComponentRequest request,
                                                   java.lang.String eventUrn,
                                                   java.lang.String eventName)

provides a receiver object instance for eventing pattern

Parameters:

request - portal component request

eventUrn - namespace of the event. The RFC2141 is not fully supported, no single or double quotes or escaped characters are allowed.

eventName - 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