com.sapportals.portal.prt.event

Interface IPortalRequestEvent

All Superinterfaces:
IEvent, IPOMConstants

public interface IPortalRequestEvent
extends IEvent

The IPortalRequestEvent is an extension of IEvent for the special purpose of representing events coming in through a request by a url specifically generated for that reason.
An event has a name. In addition it may tranport data to the target component. Event Data is a set of possibly multi-valued attributes. This can provided as request parameters (all parameters that are not interpreted by the engine - attention to name spacing is required here- or by event url mechanisms.

See Also:
IPortalRequestEventData

Field Summary
 
Fields inherited from interface com.sapportals.portal.prt.pom.IPOMConstants
ABOUT_MODE, ABOUT_REQUEST_EVENT, ACTION_EVENT, AFTER_CONTENT_EVENT, BEFORE_CONTENT_EVENT, COMPONENT_EVENT, COMPONENT_NODE, DEFAULT_MODE, EDIT_ACKNOWLEDGE_EVENT, EDIT_MODE, EDIT_REQUEST_EVENT, HELP_MODE, HELP_REQUEST_EVENT, LOGON_EVENT, LOGON_MODE, LOGOUT_EVENT, ON_NODE_READY_EVENT, ON_NODE_REMOVE_EVENT, ON_POM_READY_EVENT, PORTAL_NODE, PREVIEW_MODE, PREVIEW_REQUEST_EVENT, REFRESH_MODE, REFRESH_REQUEST_EVENT, REQUEST_EVENT, TEST_MODE
 
Method Summary
 IPortalRequestEventData getData()
          Gets the Event data attached to this event.
 String getName()
          Gets the name of this event.
 
Methods inherited from interface com.sapportals.portal.prt.pom.IEvent
getBubbles, getCancelable, getCurrentTarget, getTarget, getType, setCurrentTarget, setTarget, stopPropagation
 

Method Detail

getName

String getName()
Gets the name of this event.

Returns:
The name of the event

getData

IPortalRequestEventData getData()
Gets the Event data attached to this event.

Returns:
The data attached to the event.
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
[sap.com] EP-BASIS-API [sap.com] epbc.prtapi._apideprecated default EP-PIN-PRT


Copyright 2011 SAP AG Complete Copyright Notice