com.sapportals.portal.prt.service.epcftoolbox

Interface IClientEventSender

All Superinterfaces:
IScriptGenerator

public interface IClientEventSender
extends IScriptGenerator

The interface that represents a sender object for working with the EPCF toolbox.

The sender object enables you to register multiple parameters for an outgoing client-side event and generate corresponding client script code.

See Also:
IClientEventReceiver

Method Summary
 void setParameter(String key, String value)
          Registers a key-value pair as an event parameter.
 void setRawParameter(String key, String variableName)
          Registers a variable, which contains a key-value pair.
 
Methods inherited from interface com.sapportals.portal.prt.service.epcftoolbox.IScriptGenerator
getScript, getWrappedScript
 

Method Detail

setParameter

void setParameter(String key,
                  String value)
Registers a key-value pair as an event parameter.

Parameters:
key - ID of the parameter in the event container. Only the characters from the following set are allowed: [A-Z0-9_-]
value - the value of the parameter. May not contain single or double quotes or escaped characters, empty string is allowed.

setRawParameter

void setRawParameter(String key,
                     String variableName)
Registers a variable, which contains a key-value pair.

Parameters:
key - ID of the parameter in the event container. Only the characters from the following set are allowed: [A-Z0-9_-]
variableName - any JavaScript / DOM reference (i.e., document.form.textfield.value). It may not be empty or contain escaped characters. When using single or double quotes (i.e., document.getElementById('theId').value), always make sure that they are used in pairs and do not collide with the surrounding characters of the whole generated script.
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