SAP ABAP Class IF_WDR_CLIENT (Describes the client-dependent parts of a WD client)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_WDR_CLIENT_ABSTRACT_HTTP	Web Dynpro HTTP Client Info Object Handler	20021122

Properties

Class	IF_WDR_CLIENT
Short Description	Describes the client-dependent parts of a WD client
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package
Created	20020925	SAP
Last change	20141121
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_CLIENT_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_HTTP_ENTITY	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class IF_WDR_CLIENT has no interface implemented.

Friends

Class IF_WDR_CLIENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APPLICATION_NAME	Instance attribute	Public	☑	Type reference (TYPE)	STRING			20040518
2	C_SEND_PAGE_SKIPPED	Constant	Public	☐	Type reference (TYPE)	INT1	1	Return Status	20120626
3	DESCRIPTION	Instance attribute	Public	☑	Type reference (TYPE)	STRING			20040518
4	NAME	Instance attribute	Public	☑	Type reference (TYPE)	STRING			20040518
5	UPDATE_CLIENT_PEER	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_WDR_UPDATE_CLIENT_PEER		Client Update Peer	20040518

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AFTER_CLIENT_UPDATES	Instance method	Public	Method		20040517
2	ATTACH_FILE_TO_RESPONSE	Instance method	Public	Method	Adds File to Current Response	20050406
3	CREATE_APPLICATION_URL	Instance method	Public	Method	Creates an appropriate URL for the application	20080211
4	CREATE_RESOURCE_URL	Static method	Public	Method		20060801
5	DELETE_CACHE	Instance method	Public	Method		20121025
6	FULFILLS	Instance method	Public	Method	Are request instances valid for this client associated	20040518
7	GET_CACHE	Instance method	Public	Method		20060801
8	GET_CLIENT_UPDATES	Instance method	Public	Method		20040517
9	GET_RESOURCE	Instance method	Public	Method	Return Data Resource	20041214
10	GET_SECURITY_TOKEN	Static method	Public	Method	Provides a Security Token	20100209
11	IS_FIRST_REQUEST	Instance method	Public	Method	Returns true if the client requests the first request	20020925
12	ON_CLIENT_UPDATES	Instance method	Public	Method	Time After Data Was Transferred to the Data Container	20120330
13	REGISTER_PLUGIN	Instance method	Public	Method	Registers the Client Plug-In	20140514
14	RESET_CHANGE_FLAG	Instance method	Public	Method	Resets the Change Flag	20030521
15	RESET_PENDING_UPDATES	Instance method	Public	Method	Resets Accumulated Changes	20040427
16	SEND_CLOSE_WINDOW	Instance method	Public	Method	Close Application Window (exit plug)	20070918
17	SEND_REDIRECT	Instance method	Public	Method	Sends redirect response to client using the specified URL	20021118
18	SEND_RESPONSE	Instance method	Public	Method	Render Response & Flush	20020925
19	SEND_SUSPEND	Instance method	Public	Method	Handle suspense of the application	20050413
20	SET_CACHE	Instance method	Public	Method		20060801

Events

Class IF_WDR_CLIENT has no event.

Types

Class IF_WDR_CLIENT has no local type.

Method Signatures

Method AFTER_CLIENT_UPDATES Signature

Method AFTER_CLIENT_UPDATES on class IF_WDR_CLIENT has no parameter.
Method AFTER_CLIENT_UPDATES on class IF_WDR_CLIENT has no exception.

Method ATTACH_FILE_TO_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMPRESSION	Value transfer	☐	Type reference (TYPE)	I	IF_HTTP_ENTITY=>CO_COMPRESS_BASED_ON_MIME_TYPE		20050406
2	Importing	I_CONTENT	Value transfer	☐	Type reference (TYPE)	XSTRING			20050406
3	Importing	I_FILENAME	Value transfer	☐	Type reference (TYPE)	STRING			20050406
4	Importing	I_INPLACE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050415
5	Importing	I_IN_NEW_WINDOW	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050415
6	Importing	I_MIME_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20050406

Method ATTACH_FILE_TO_RESPONSE on class IF_WDR_CLIENT has no exception.

Method CREATE_APPLICATION_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PATH_EXTENTION	Call by reference	☑	Type reference (TYPE)	STRING		i.e. ~ucfPOPUP_PAGE	20080211
2	Importing	QUERYSTRING	Call by reference	☑	Type reference (TYPE)	STRING		i.e. ?something=value	20080211
3	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20080211
4	Importing	URL_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		i.e. ABSOLUTE/RELATIVE depends on the client	20080211
5	Importing	USE_CONTEXTID	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED		20080410

Method CREATE_APPLICATION_URL on class IF_WDR_CLIENT has no exception.

Method CREATE_RESOURCE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADD_FOREIGN_SESSION_ACCESS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20100216
2	Importing	CREATE_ABSOLUTE_URL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060801
3	Importing	CREATE_UPLOAD_URL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060801
4	Importing	FILE_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20060801
5	Importing	GUID	Call by reference	☑	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20060801
6	Importing	RESOURCE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20060801
7	Importing	SECURITY_TOKEN	Call by reference	☑	Type reference (TYPE)	CHAR32		Characterfeld der Länge 32	20100209
8	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20060801

Method CREATE_RESOURCE_URL on class IF_WDR_CLIENT has no exception.

Method DELETE_CACHE Signature

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

Method DELETE_CACHE on class IF_WDR_CLIENT has no exception.

Method FULFILLS Signature

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

Method FULFILLS on class IF_WDR_CLIENT has no exception.

Method GET_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DATA	Call by reference	☑	Type reference (TYPE)	STRING			20060801
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20060801
3	Changing	OBJECT	Call by reference	☑	Type reference (TYPE)	XSTRING			20060801

Method GET_CACHE on class IF_WDR_CLIENT has no exception.

Method GET_CLIENT_UPDATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT_APPLICATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_UPDATE_SERVER_PEER_DATA		Schnittstelle des Applicationsproxies	20040517
2	Importing	EVENT_QUEUE	Call by reference	☐	Object reference (TYPE REF TO)	CL_WDR_EVENT_QUEUE		EventQueue/IEventQueue	20040517
3	Exporting	WINDOWS_TO_CLOSE	Call by reference	☐	Type reference (TYPE)	WDR_WINDOW_LIST		List of Windows	20041203

Method GET_CLIENT_UPDATES on class IF_WDR_CLIENT has no exception.

Method GET_RESOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	AS_ATTACHMENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20061023
2	Exporting	COMPRESSION	Call by reference	☐	Type reference (TYPE)	I			20050425
3	Exporting	CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20050418
4	Exporting	FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20050418
5	Exporting	MIMETYPE	Call by reference	☐	Type reference (TYPE)	STRING			20050425
6	Importing	RESOURCE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20041214
7	Exporting	RESOURCE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20120515
8	Importing	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP Framework (iHTTP) HTTP Response	20041214

Method GET_RESOURCE on class IF_WDR_CLIENT has no exception.

Method GET_SECURITY_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SECURITY_TOKEN	Value transfer	☐	Type reference (TYPE)	CHAR32		Characterfeld der Länge 32	20100209

Method GET_SECURITY_TOKEN on class IF_WDR_CLIENT has no exception.

Method IS_FIRST_REQUEST Signature

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

Method IS_FIRST_REQUEST on class IF_WDR_CLIENT has no exception.

Method ON_CLIENT_UPDATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	STRING			20120330
2	Importing	CONTEXT_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Schnittstelle für ein Knotenelement	20120330
3	Importing	UPDATE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_UPDATE_SERVER_PEER_DATA		to get updates into a DataContainer	20120330

Method ON_CLIENT_UPDATES on class IF_WDR_CLIENT has no exception.

Method REGISTER_PLUGIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PLUGIN	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_CLIENT_PLUGIN		Extends the functionality of Web Dynpro Client	20140514

Method REGISTER_PLUGIN on class IF_WDR_CLIENT has no exception.

Method RESET_CHANGE_FLAG Signature

Method RESET_CHANGE_FLAG on class IF_WDR_CLIENT has no parameter.
Method RESET_CHANGE_FLAG on class IF_WDR_CLIENT has no exception.

Method RESET_PENDING_UPDATES Signature

Method RESET_PENDING_UPDATES on class IF_WDR_CLIENT has no parameter.
Method RESET_PENDING_UPDATES on class IF_WDR_CLIENT has no exception.

Method SEND_CLOSE_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOGOFF	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090320

Method SEND_CLOSE_WINDOW on class IF_WDR_CLIENT has no exception.

Method SEND_REDIRECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOGOFF	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090318
2	Importing	PARAMETER_TAB	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Tabelle Name/Wert-Paare	20060516
3	Importing	POST_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20071130
4	Importing	REDIRECT_URL	Call by reference	☐	Type reference (TYPE)	STRING			20021118
5	Importing	SKIP_SEND_PAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	"SEND_PAGE" wird nicht ausgeführt	20120626
6	Returning	STATE	Value transfer	☐	Type reference (TYPE)	INT1			20120626

Method SEND_REDIRECT on class IF_WDR_CLIENT has no exception.

Method SEND_RESPONSE Signature

Method SEND_RESPONSE on class IF_WDR_CLIENT has no parameter.
Method SEND_RESPONSE on class IF_WDR_CLIENT has no exception.

Method SEND_SUSPEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARAMETER_TAB	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Tabelle Name/Wert-Paare	20060516
2	Importing	I_POST_PARAMETERS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20080305
3	Importing	I_RESUME_URL_ID	Call by reference	☑	Type reference (TYPE)	STRING			20090825
4	Importing	I_TARGET_URL	Value transfer	☐	Type reference (TYPE)	STRING			20050413

Method SEND_SUSPEND on class IF_WDR_CLIENT has no exception.

Method SET_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPRESSION	Call by reference	☐	Type reference (TYPE)	I	IF_HTTP_ENTITY=>CO_COMPRESS_BASED_ON_MIME_TYPE		20060801
2	Importing	DATA	Call by reference	☑	Type reference (TYPE)	STRING			20060801
3	Importing	FILENAME	Call by reference	☑	Type reference (TYPE)	STRING			20120417
4	Importing	INPLACE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060801
5	Importing	MIMETYPE	Call by reference	☑	Type reference (TYPE)	STRING			20060801
6	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20060801
7	Importing	OBJECT	Call by reference	☑	Type reference (TYPE)	XSTRING			20060801
8	Importing	RESOURCE_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20120515
9	Importing	SECURITY_TOKEN	Call by reference	☑	Type reference (TYPE)	CHAR32		Characterfeld der Länge 32	20100209
10	Importing	VIRUS_SCAN_ALWAYS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120810
11	Importing	VIRUS_SCAN_PROFILE	Call by reference	☑	Type reference (TYPE)	VSCAN_PROFILE		Viren-Scan-Profil	20120810

Method SET_CACHE on class IF_WDR_CLIENT has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in