SAP ABAP Class CL_DATAPROVIDER (Data Provider Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-GUI (Application Component) Graphical User Interface
     ⤷ SCET (Package) Control Enabling Technology / Control Framework

Properties

Class	CL_DATAPROVIDER
Short Description	Data Provider Control
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SCET	Control Enabling Technology / Control Framework
Created	19990812	SAP
Last change	20000531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CNDP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CNTL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_DATAPROVIDER has no interface implemented.

Friends

Class CL_DATAPROVIDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DATAOBJXX	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_DATAPROVIDER_DATAOBJECT		Data Object	19991118
2	DP_LIFETIME_CACHEXX	Constant	Public	☐	Type reference (TYPE)	CHAR01	'P'	Store in Cache	19991118
3	DP_LIFETIME_VOLATILEXX	Constant	Public	☐	Type reference (TYPE)	CHAR01	'V'	Delete after End of Transaction	19991118
4	GUI_SUPPORTS_CACHE	Static Attribute	Private	☐	Type reference (TYPE)	CHAR01		Cache Support by GUI	19991118
5	H_DP	Static Attribute	Private	☐	Type reference (TYPE)	CNTL_HANDLE		Queue Data	19991022
6	KEYXX	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		Key	19991118
7	NAMESPACEXX	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		Namespace	19991118
8	RESULT_TAB	Static Attribute	Private	☐	Type reference (TYPE)	MYRESULTTAB		AutoQ Table	19991109
9	URLSET	Static Attribute	Private	☐	See coding			URLs Managed	19990820

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DATAREQUEST	Static method	Public	Method	Request Data if not in Cache	19990812
2	GENERATEURL	Static method	Public	Method	Determine URL	19991122
3	HAS_CACHE	Static method	Public	Method	Does Data Provider have Cache Support	19991109
4	NAMESPACEREQUEST	Static method	Public	Method	Request Data for Namespace	19991122
5	NOCACHE_SYNC	Static method	Public	Method	Put into Frontend Memory and Send Request to Data Source	19991109
6	NOTIFY_DATAP_ERROR	Static method	Private	Method	Communicate Errors to Data Provider on Frontend	19991109
7	QUERYURL	Static method	Public	Method	Read URL	19990820
8	RAISE_REQUESTDATA	Static method	Public	Method	Trigger Event	19990823
9	SINGLE_SYNC	Static method	Private	Method	Synchronize Entry	19991109
10	SYNC	Static method	Public	Method	Synchronize all Managed Entries	19991013

Events

#	Event	Type	Visibility	Description	Created on
1	REQUESTDATA	Static Event (1)	Public (2)	Requested Data not Found in Cache	19990812
2	REQUESTNAMESPACE	Static Event (1)	Public (2)	Request Data for Namespace	19991123

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	CACHE_SUPPORTED	Private	See coding		CACHE_SUPPORTED	19991109
2	DP_LIFETIME	Private	See coding		DP_LIFETIME	19991109
3	MYRESULTTAB	Private	See coding		MYRESULTTAB	19991109
4	MYTABRECORD	Private	See coding		MYTABRECORD	19991109
5	TMYURLSET	Private	See coding		TMYURLSET	19991109

Method Signatures

Method DATAREQUEST Signature

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

#	Exception	Resumable	Description	Created on
1	ERROR_REQUESTING_DATA	☐	Fehler beim Datenrequest	19991109

Method GENERATEURL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_KEY		Schlüssel	19991122
2	Importing	NAMESPACE	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_NAME		Namensraum	19991122
3	Importing	TAIL	Call by reference	☑	Type reference (TYPE)	C		Anmhängsel	19991123
4	Exporting	URL	Call by reference	☐	Type reference (TYPE)	C		URL	19991122

Method GENERATEURL on class CL_DATAPROVIDER has no exception.

Method HAS_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	HAS_CACHE	Value transfer	☐	Type reference (TYPE)	C		Cacheunterstützung	19991109

Method HAS_CACHE on class CL_DATAPROVIDER has no exception.

Method NAMESPACEREQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Call by reference	☐	Type reference (TYPE)	STRING		Übergebener Schlüssel	19991122
2	Importing	NAMESPACE	Call by reference	☐	Type reference (TYPE)	STRING		Übergebener Namensraum	19991122

#	Exception	Resumable	Description	Created on
1	ERROR_REQUESTING_DATA	☐	Fehler beim Datenrequest	19991122

Method NOCACHE_SYNC Signature

Method NOCACHE_SYNC on class CL_DATAPROVIDER has no parameter.

#	Exception	Resumable	Description	Created on
1	DATA_SOURCE_ERROR	☐	Keine Daten verfügbar	19991109
2	DP_SEND_DATA_ERROR	☐	Fehler beim Senden der Daten	19991109
3	GENERAL_ERROR	☐	Allgemeiner Fehler	19991109

Method NOTIFY_DATAP_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	URL	Call by reference	☐	Type reference (TYPE)	C		Fehlerhafte Url	19991109

Method NOTIFY_DATAP_ERROR on class CL_DATAPROVIDER has no exception.

Method QUERYURL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_KEY		Schlüssel	19990820
2	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	C		Lebensdauer	19991108
3	Importing	NAMESPACE	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_NAME		Namensraum	19990820
4	Changing	URL	Call by reference	☐	Type reference (TYPE)	C		URL	19990820

#	Exception	Resumable	Description	Created on
1	ALREADY_PUBLISHED	☐	URL wurde bereits publiziert	19991109
2	INVALID_NAMESPACE	☐	Der Namespace enthält ungültige Zeichen	19991123

Method RAISE_REQUESTDATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATAOBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_DATAPROVIDER_DATAOBJECT		Datenobjekt	19990823
2	Importing	KEY	Call by reference	☐	Type reference (TYPE)	CNDP_ASYNC_KEY		Schlüssel	19990823
3	Importing	LIFETIME	Call by reference	☑	Type reference (TYPE)	C		Lebensdauer	19991108
4	Importing	NAMESPACE	Call by reference	☐	Type reference (TYPE)	CNDP_ASYNC_NAME		Namensraum	19990823

Method RAISE_REQUESTDATA on class CL_DATAPROVIDER has no exception.

Method SINGLE_SYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	NOTIFY_DP	Call by reference	☐	Type reference (TYPE)	AS4FLAG		Soll datap gerufen werden wenn Fehler auftritt	19991109
2	Importing	URLSET	Call by reference	☐	Type reference (TYPE)	TMYURLSET		Url des Objects	19991109
3	Importing	USE_CACHE	Call by reference	☐	Type reference (TYPE)	AS4FLAG		Soll gecacht werden	19991109

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control Error	19991115
2	CNTL_SYSTEM_ERROR	☐	Control System Error	19991115
3	DATA_SEND_ERROR	☐	Fehler beim Senden der Daten	19991109
4	DATA_SOURCE_ERROR	☐	Fehler beim Erzeugen der daten im DataSource	19991109

Method SYNC Signature

Method SYNC on class CL_DATAPROVIDER has no parameter.

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control Error	19991109
2	CNTL_SYSTEM_ERROR	☐	Control systemn Error	19991109
3	DATA_SOURCE_ERROR	☐	Keine Daten verfügbar	19991109
4	DP_CREATE_ERROR	☐	Fehler beim Erzeugen des DataProvider	19991109
5	DP_SEND_DATA_ERROR	☐	Fehler beim Senden der Daten	19991109
6	GENERAL_ERROR	☐	Allgemeiner Fehler	19991109

Event Signatures

Event REQUESTDATA Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DATAOBJ	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DATAPROVIDER_DATAOBJECT		Daten	19990812
2	KEY	Exporting	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_KEY		Schlüssel	19990812
3	LIFETIME	Exporting	Value transfer	☑	Type reference (TYPE)	C		Lebensdauer	19991108
4	NAMESPACE	Exporting	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_NAME		Namensraum	19990812

Event REQUESTNAMESPACE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	KEY	Exporting	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_KEY		Schlüssel	19991123
2	NAMESPACE	Exporting	Value transfer	☐	Type reference (TYPE)	CNDP_ASYNC_NAME		Namensraum	19991123

History

Last changed by/on	SAP	20000531
SAP Release Created in