SAP ABAP Class CL_WDR_NOTIFICATION (Web Dynpro Notification)
Hierarchy
☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA (Application Component) Web Dynpro ABAP
     ⤷ SWDP_RUNTIME_SERVICES (Package) Web Dynpro: Additional Services of Web Dynpro Runtime
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_HTTP_EXTENSION HTTP Framework (iHTTP) HTTP Request Handler 20081217
Properties
Class CL_WDR_NOTIFICATION  
Short Description Web Dynpro Notification    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SWDP_RUNTIME_SERVICES   Web Dynpro: Additional Services of Web Dynpro Runtime 
Created 20081217   SAP 
Last change 20141120    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 CL_WDR_NOTIFY_SHM_ROOT Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_WDR_CLIENT_COMMAND Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_HTTP_EXTENSION HTTP Framework (iHTTP) HTTP Request Handler 20081217
Friends
Class CL_WDR_NOTIFICATION has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_EVENT_PARAM_SHM_ID Constant Public Type reference (TYPE) STRING 'FullEventIdShm' Parameter Name of ID of Event in the Shared Memory 20081217
2 C_PARAMETER_RECEIVER Constant Public Type reference (TYPE) STRING 'receiver' URL Parameter for Event Receiver 20081217
3 C_POLLING_BASE_URL Constant Public Type reference (TYPE) STRING '/sap/public/bc/webdynpro/Polling' Base URL for Polling 20081217
4 MT_REGISTERED_EVENTS Static Attribute Private Type reference (TYPE) TT_REGISTERED_EVENTS Table of Registered Events 20081217
5 M_CLOSE_MENUS Static Attribute Public Type reference (TYPE) ABAP_BOOL Initiates closing of all open popup menus 20110817
6 M_RECEIVER Static Attribute Private Type reference (TYPE) STRING Unique ID of Web Dynpro Session 20081217
7 M_SHM_HANDLER Static Attribute Private Object reference (TYPE REF TO) CL_WDR_NOTIFY_SHM Handler for Shared Objects 20090120
Methods
# Method Level Visibility Method type Description Created on
1 ATTACH_FOR_READ Static method Private Method Open Shared Object to Read 20090120
2 ATTACH_FOR_UPDATE Static method Private Method Attach Shared Object for Update 20090120
3 BUILD_RESPONSE Instance method Private Method Creates the Response 20081217
4 DETACH Static method Private Method Detach for Shared Object 20090120
5 DETACH_COMMIT Static method Private Method Detach and commit from Shared Object 20090120
6 FILL_POLLING_RESPONSE Static method Private Method Fills the polling response 20081217
7 GET_ALL_REGISTRATIONS Static method Public Method Returns all registered events of this application server 20081217
8 GET_EVENT_BY_FULL_ID Static method Public Method Returns the description of an event using the full ID 20081217
9 GET_HOST_ID Static method Private Method Returns the host ID 20081217
10 GET_POLLING_URL Static method Public Method Creates the URL for the polling 20081217
11 GET_RECEIVER Static method Public Method Returns the ID currently valid for the recipient 20081217
12 GET_REGISTRATIONS_BY_ID Static method Public Method Returns registered events for a shared memory instance 20081217
13 HAS_NEW_EVENT Static method Public Method Checks events with status 'done' (returns first one) 20081217
14 HAS_NEW_EVENTS Static method Public Method Checks events with status 'done' (returns all) 20090212
15 INVALIDATE_ALL Static method Public Method Invalidates all shared objects of the notification service 20081217
16 IS_ACTIVE Static method Public Method Returns "true" if notification service is active 20090107
17 REGISTER_EVENT Static method Public Method Registration of Event 20081217
18 REMOVE_REGISTRATIONS_BY_ID Static method Public Method Deletes the registration of event 20090212
19 REMOVE_REGISTRATION_BY_FULL_ID Static method Public Method Deletes the registration of event 20081217
20 UPDATE_EVENT_STATUS Static method Public Method Status Change of Registered Event 20081217
Events
Class CL_WDR_NOTIFICATION has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TT_REGISTERED_EVENTS Public See coding 20081217 tt_registered_events type sorted table of t_registered_event with non-unique key window
2 T_EVENT Public Type reference (TYPE) STRING 20081217
3 T_HOST_ID Public Type reference (TYPE) MSNAME2 Application Server Name 20081217
4 T_REGISTERED_EVENT Public See coding 20081217 begin of t_registered_event. types window type ref to if_wd_window. types view type ref to if_wd_view_controller. types event_id type string. types active type abap_bool. types action type string. types end of t_registered_event
Method Signatures

Method ATTACH_FOR_READ Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SHM_OBJECT Value transfer Object reference (TYPE REF TO) CL_WDR_NOTIFY_SHM_ROOT Root Klasse für Shared Objects (Notifications) 20090120

Method ATTACH_FOR_READ on class CL_WDR_NOTIFICATION has no exception.

Method ATTACH_FOR_UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SHM_OBJECT Value transfer Object reference (TYPE REF TO) CL_WDR_NOTIFY_SHM_ROOT Shared object 20090120

Method ATTACH_FOR_UPDATE on class CL_WDR_NOTIFICATION has no exception.

Method BUILD_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HAS_EVENT Call by reference Type reference (TYPE) ABAP_BOOL 20081217
2 Returning RESPONSE Value transfer Type reference (TYPE) STRING 20081217

Method BUILD_RESPONSE on class CL_WDR_NOTIFICATION has no exception.

Method DETACH Signature

Method DETACH on class CL_WDR_NOTIFICATION has no parameter.
Method DETACH on class CL_WDR_NOTIFICATION has no exception.

Method DETACH_COMMIT Signature

Method DETACH_COMMIT on class CL_WDR_NOTIFICATION has no parameter.
Method DETACH_COMMIT on class CL_WDR_NOTIFICATION has no exception.

Method FILL_POLLING_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing RECEIVER_ID Call by reference Type reference (TYPE) STRING 20081217
2 Importing RESPONSE Call by reference Object reference (TYPE REF TO) IF_HTTP_RESPONSE HTTP Framework (iHTTP) HTTP Response 20081217
3 Importing RESPONSE_STR Call by reference Type reference (TYPE) STRING 20081217

Method FILL_POLLING_RESPONSE on class CL_WDR_NOTIFICATION has no exception.

Method GET_ALL_REGISTRATIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EVENTS Value transfer Type reference (TYPE) CL_WDR_NOTIFY_SHM_ROOT=>TT_ALL_REGISTERED_EVENTS 20081217

Method GET_ALL_REGISTRATIONS on class CL_WDR_NOTIFICATION has no exception.

Method GET_EVENT_BY_FULL_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EVENT Value transfer Type reference (TYPE) CL_WDR_NOTIFY_SHM_ROOT=>T_EVENT 20081217
2 Importing ID Call by reference Type reference (TYPE) STRING 20081217

Method GET_EVENT_BY_FULL_ID on class CL_WDR_NOTIFICATION has no exception.

Method GET_HOST_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning HOST_ID Value transfer Type reference (TYPE) T_HOST_ID Name des Applikationsservers 20081217

Method GET_HOST_ID on class CL_WDR_NOTIFICATION has no exception.

Method GET_POLLING_URL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning URL Value transfer Type reference (TYPE) STRING 20081217

Method GET_POLLING_URL on class CL_WDR_NOTIFICATION has no exception.

Method GET_RECEIVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RECEIVER Value transfer Type reference (TYPE) STRING 20081217

Method GET_RECEIVER on class CL_WDR_NOTIFICATION has no exception.

Method GET_REGISTRATIONS_BY_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EVENTS Value transfer Type reference (TYPE) CL_WDR_NOTIFY_SHM_ROOT=>TT_EVENTS 20081217
2 Importing ID Call by reference Type reference (TYPE) SHM_INST_NAME Name einer Shared Object Instanz eines Areas 20081217

Method GET_REGISTRATIONS_BY_ID on class CL_WDR_NOTIFICATION has no exception.

Method HAS_NEW_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ID Call by reference Type reference (TYPE) STRING Die Id des ersten gefundenen Ereignisses mit Status "fertig" 20081217
2 Importing RECEIVER Call by reference Type reference (TYPE) STRING 20090120
3 Exporting RESULT Value transfer Type reference (TYPE) ABAP_BOOL "Fertiges" Ereigniss vorhanden? 20081217
4 Exporting RETURN_CODE Call by reference Type reference (TYPE) I 0 für erfolgreich 20120622

Method HAS_NEW_EVENT on class CL_WDR_NOTIFICATION has no exception.

Method HAS_NEW_EVENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EVENTS Call by reference Type reference (TYPE) CL_WDR_NOTIFY_SHM_ROOT=>TT_EVENTS Liste von gefundenen Ereignisses mit Status "fertig" 20090212
2 Exporting NOTIFICATION_ID_PREFIX Call by reference Type reference (TYPE) WDR_NOTIFICATION_ID Eindeutige Id der Registrierung 20121016
3 Importing RECEIVER Call by reference Type reference (TYPE) STRING 20090212
4 Exporting RESULT Value transfer Type reference (TYPE) ABAP_BOOL "Fertiges" Ereigniss vorhanden? 20090212

Method HAS_NEW_EVENTS on class CL_WDR_NOTIFICATION has no exception.

Method INVALIDATE_ALL Signature

Method INVALIDATE_ALL on class CL_WDR_NOTIFICATION has no parameter.
Method INVALIDATE_ALL on class CL_WDR_NOTIFICATION has no exception.

Method IS_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning IS_ACTIVE Value transfer Type reference (TYPE) ABAP_BOOL 20090107

Method IS_ACTIVE on class CL_WDR_NOTIFICATION has no exception.

Method REGISTER_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ACTION Call by reference Type reference (TYPE) STRING Name der Aktion 20081217
2 Returning EVENT_ID Value transfer Type reference (TYPE) STRING Generierte Id der Registrierung 20081217
3 Importing VIEW Call by reference Object reference (TYPE REF TO) CL_WDR_VIEW Die View der Aktion 20090213
# Exception Resumable Description Created on
1 CX_SHM_ATTACH_ERROR Ausnahme bei Attach 20130208

Method REMOVE_REGISTRATIONS_BY_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EVENTS Call by reference Type reference (TYPE) CL_WDR_NOTIFY_SHM_ROOT=>TT_EVENTS 20090212

Method REMOVE_REGISTRATIONS_BY_ID on class CL_WDR_NOTIFICATION has no exception.

Method REMOVE_REGISTRATION_BY_FULL_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID Call by reference Type reference (TYPE) STRING 20081217

Method REMOVE_REGISTRATION_BY_FULL_ID on class CL_WDR_NOTIFICATION has no exception.

Method UPDATE_EVENT_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EVENT_ID Call by reference Type reference (TYPE) STRING 20081217
2 Importing STATUS Call by reference Type reference (TYPE) CL_WD_NOTIFICATION_SERVICE=>T_EVENT_STATUS 20081217

Method UPDATE_EVENT_STATUS on class CL_WDR_NOTIFICATION has no exception.
History
Last changed by/on SAP  20141120 
SAP Release Created in 720