SAP ABAP Interface /UI2/IF_EDM_DATA_PROVIDER (EDM Data Provider)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/BASIS_CORE_EDM (Package) UI BE: Entity Data Model Core logic (release independent)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/UI2/CL_EDM_DATA_PROVIDER	EDM Data Provider	20111025

Properties

Interface	/UI2/IF_EDM_DATA_PROVIDER
Short Description	EDM Data Provider

General Data

Package	/UI2/BASIS_CORE_EDM	UI BE: Entity Data Model Core logic (release independent)
Created	20110905	SAP
Last changed	20141121
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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/UI2/IF_CACHE_SUPPORT_2	☐	☐	Enable service to do its own cache handling	20130809

Friends

Interface /UI2/IF_EDM_DATA_PROVIDER has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	EDM_DATA_PROVIDER	Instance attribute	Public	☑	Type reference (TYPE)	TP_S_DATA_PROVIDER			20110913

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_DATA_ACCESSOR	Instance method	Public	Method		20111025
2	EXECUTE_ACTION	Instance method	Public	Method		20120510
3	GET_ANNOTATION	Instance method	Public	Method		20121212
4	GET_ENTITY_ANNOTATION	Instance method	Public	Method		20121212
5	GET_ENTITY_ANNOTATION_SUB	Instance method	Public	Method		20121212
6	GET_PROPERTY_ANNOTATION	Instance method	Public	Method		20121212
7	GET_PROPERTY_ANNOTATION_TAB	Instance method	Public	Method		20121212
8	GET_PROPERTY_WITH_ANNOTATION	Instance method	Public	Method		20121212
9	GET_TIMESTAMP_FOR_UPDATE	Instance method	Public	Method		20120124
10	SET_ENTITY_CACHEABLE	Instance method	Public	Method	'X' = entity is cacheable	20140304
11	SET_HTTP_RESPONSE_HEADER	Instance method	Public	Method	The Data Provider can set the HTTP response header	20140709
12	SET_MAX_AGE_ON_CLIENT_CACHE	Instance method	Public	Method	The Data Provider can set the max-cache-age (client caching)	20140801

Events

Interface /UI2/IF_EDM_DATA_PROVIDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_S_ANNOTATION	Public	See coding			20111118	BEGIN OF tp_s_annotation, name TYPE string, value TYPE string, annotation_sub_tab type tp_t_annotation_sub, END OF tp_s_annotation
2	TP_S_ANNOTATION_SUB	Public	See coding			20121024	begin of tp_s_annotation_sub, name type string, value type string, END OF tp_s_annotation_sub
3	TP_S_DATA_PROVIDER	Public	See coding			20110905	BEGIN OF tp_s_data_provider, entity_tab TYPE tp_t_entity, data_provider_annotation_tab type tp_t_annotation, END OF tp_s_data_provider
4	TP_S_ENTITY	Public	See coding			20110905	BEGIN OF tp_s_entity, name TYPE string, data_accessor_class_name TYPE string, property_tab TYPE tp_t_property, entity_annotation_tab TYPE tp_t_annotation, END OF tp_s_entity
5	TP_S_PROPERTY	Public	See coding			20111118	BEGIN OF tp_s_property, name TYPE string, property_annotation_tab TYPE tp_t_annotation, END OF tp_s_property
6	TP_S_PROPERTY_ANNOTATION	Public	See coding			20121212	BEGIN OF tp_s_property_annotation, property_name TYPE string, annotation_value TYPE string, END OF tp_s_property_annotation
7	TP_T_ANNOTATION	Public	See coding			20111118	tp_t_annotation TYPE HASHED TABLE OF tp_s_annotation WITH UNIQUE KEY name
8	TP_T_ANNOTATION_SUB	Public	See coding			20121024	tp_t_annotation_sub type hashed table of tp_s_annotation_sub with UNIQUE key name
9	TP_T_ENTITY	Public	See coding			20110905	tp_t_entity TYPE HASHED TABLE OF tp_s_entity WITH UNIQUE KEY name
10	TP_T_PROPERTY	Public	See coding			20111118	tp_t_property TYPE HASHED TABLE OF tp_s_property WITH UNIQUE KEY name
11	TP_T_PROPERTY_ANNOTATION	Public	See coding			20121212	tp_t_property_annotation TYPE HASHED TABLE OF tp_s_property_annotation WITH UNIQUE KEY property_name

Method Signatures

Method CREATE_DATA_ACCESSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DATA_ACCESSOR	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_EDM_DATA_ACCESSOR		EDM Data Accessor (Entity and Feed)	20111025
2	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20111025

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20111025

Method EXECUTE_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAMETER	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_NAME_VALUE_PAIR		table for name value pairs	20120510
2	Importing	IV_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120510
3	Returning	REF_TO_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20120510

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20120510

Method GET_ANNOTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20121212
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
3	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20121212

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20121212

Method GET_ENTITY_ANNOTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20121212
2	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
4	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20121212

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20121212

Method GET_ENTITY_ANNOTATION_SUB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ANNOTATION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
2	Importing	ANNOTATION_SUB_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
3	Importing	DEFAULT_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20121212
4	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
5	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20121212

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20121212

Method GET_PROPERTY_ANNOTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20121212
2	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
4	Importing	PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
5	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20121212

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20130102

Method GET_PROPERTY_ANNOTATION_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ANNOTATION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
2	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
3	Returning	PROPERTY_ANNOTATION_TAB	Value transfer	☐	Type reference (TYPE)	TP_T_PROPERTY_ANNOTATION			20121212

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20121212

Method GET_PROPERTY_WITH_ANNOTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ANNOTATION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
2	Importing	ANNOTATION_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20121212
3	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121212
4	Returning	PROPERTY_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20121212

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20121212

Method GET_TIMESTAMP_FOR_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TIMESTAMP_FOR_UPDATE	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20120124

Method GET_TIMESTAMP_FOR_UPDATE on Interface /UI2/IF_EDM_DATA_PROVIDER has no exception.

Method SET_ENTITY_CACHEABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Entity name	20140304
2	Importing	IS_CACHEABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		X= entity is cacheable	20140304

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20140304

Method SET_HTTP_RESPONSE_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_REQUEST_CTXT_ENTITY	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_MGW_REQ_ENTITY		Request details for entity	20140710
2	Importing	IO_REQUEST_CTXT_ENTITY_SET	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_MGW_REQ_ENTITYSET		Request details for entity set	20140710
3	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Entity name	20140709
4	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	TIHTTPNVP		HTTP response header	20140709

Method SET_HTTP_RESPONSE_HEADER on Interface /UI2/IF_EDM_DATA_PROVIDER has no exception.

Method SET_MAX_AGE_ON_CLIENT_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Entity name	20140801
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	IHTTPVAL		Time in seconds (no commata)	20140801

Method SET_MAX_AGE_ON_CLIENT_CACHE on Interface /UI2/IF_EDM_DATA_PROVIDER has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	120