SAP ABAP Class /IWCOR/CL_DS_EP_HELPER (Reader and writer base class)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-FND-CCL (Application Component) IWF Consumer Connectivity Layer
     ⤷ /IWCOR/SODATA_EP (Package) Entity Provider (request / response)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/IWCOR/CL_DS_EP_READER_JSON	Reader for JSON format	20120110
2	Inheritance (c INHERITING FROM c_ref)	/IWCOR/CL_DS_EP_READER_XML	Reader for ATOM and XML format	20120110
3	Inheritance (c INHERITING FROM c_ref)	/IWCOR/CL_DS_EP_WRITER_JSON	Writer for JSON format	20120110
4	Inheritance (c INHERITING FROM c_ref)	/IWCOR/CL_DS_EP_WRITER_XML	Writer for ATOM and XML format	20120110

Properties

Class	/IWCOR/CL_DS_EP_HELPER
Short Description	Reader and writer base class
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	/IWCOR/SODATA_EP	Entity Provider (request / response)
Created	20110910	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWCOR/IF_DS_EP_CALLBACK	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /IWCOR/CL_DS_EP_HELPER has no interface implemented.

Friends

Class /IWCOR/CL_DS_EP_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MV_FORMAT	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Format	20120110
2	MV_READER	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Reader or writer	20120110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_ENTITY_INFO	Instance method	Protected	Method	Get all entity information	20110919
2	GET_ENTITY_PROPERTIES	Static method	Protected	Method	Get entity properties by name	20120110
3	GET_KEYS_OF_ENTITY_SET	Static method	Protected	Method	Get keys of an Entity Set	20110919
4	GET_NAVIGATION_PROPERTY_STUB	Static method	Public	Method	Get navigation property stub	20120305
5	GET_OPTION_VALUE	Static method	Protected	Method	Get option value	20120110
6	GET_PROPERTIES_OF_COMPLEX_TYPE	Static method	Protected	Method	Get all properties of a Complex Type	20110929
7	GET_PROPERTIES_OF_ENTITY_SET	Instance method	Protected	Method	Get all properties of an Entity Set	20110919
8	GET_VSI	Static method	Public	Method	Get virus scan interface	20120305
9	SKIP_NODE_INTO_READER	Static method	Protected	Method	Skip current node into new reader	20120305

Events

Class /IWCOR/CL_DS_EP_HELPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	CALLBACK_DATA_S	Protected	See coding			20120206	BEGIN OF callback_data_s, navigation_property TYPE REF TO navigation_property_info_s, uri TYPE string, reader TYPE REF TO if_sxml_reader, END OF callback_data_s
2	CALLBACK_DATA_T	Protected	See coding			20120206	callback_data_t TYPE STANDARD TABLE OF callback_data_s WITH DEFAULT KEY
3	COMPONENT_COMPLEX_S	Protected	See coding			20110919	BEGIN OF component_complex_s, name TYPE string, index TYPE i, descriptor TYPE REF TO cl_abap_structdescr, END OF component_complex_s
4	COMPONENT_SIMPLE_S	Protected	See coding			20110919	BEGIN OF component_simple_s, name TYPE string, index TYPE i, descriptor TYPE REF TO cl_abap_elemdescr, END OF component_simple_s
5	ENTITY_INFO_S	Protected	See coding			20110919	BEGIN OF entity_info_s, entity_set TYPE REF TO /IWCOR/if_DS_edm_entity_set, entity_set_callback TYPE REF TO /IWCOR/if_DS_ep_write_property, entity_set_name TYPE string, entity_set_uri_absolute TYPE string, entity_set_uri_relative TYPE string, entity_container_name TYPE string, entity_type TYPE REF TO /IWCOR/if_DS_edm_entity_type, entity_type_callback TYPE REF TO /IWCOR/if_DS_ep_read_entity, has_stream TYPE abap_bool, stream TYPE stream_s, entity_type_qualified_name TYPE string, entity_type_name TYPE string, entity_type_namespace TYPE string, link_rel TYPE string, timestamp TYPE p LENGTH 8 DECIMALS 0, structure_descriptor TYPE REF TO cl_abap_structdescr, properties TYPE entity_property_t, number_of_keys TYPE i, navigation_properties TYPE navigation_property_info_t, extension TYPE REF TO data, END OF entity_info_s
6	ENTITY_PROPERTY_S	Protected	See coding			20110919	BEGIN OF entity_property_s. INCLUDE TYPE property_s. TYPES: key TYPE abap_bool, concurrency_mode_fixed TYPE abap_bool, key_or_etag TYPE abap_bool, END OF entity_property_s
7	ENTITY_PROPERTY_T	Protected	See coding			20110919	entity_property_t TYPE STANDARD TABLE OF entity_property_s WITH KEY name
8	NAVIGATION_PROPERTY_INFO_S	Protected	See coding			20110919	BEGIN OF navigation_property_info_s, name TYPE string, type TYPE string, open type abap_bool, multiplicity TYPE /IWCOR/if_DS_edm=>edm_multiplicity, entity_set TYPE REF TO /IWCOR/if_DS_edm_entity_set, navigation_property TYPE REF TO /IWCOR/if_DS_edm_nav_property, expand_select TYPE REF TO /IWCOR/if_DS_uri_expand_select, callback TYPE REF TO /IWCOR/if_DS_ep_callback, callback_kind TYPE /IWCOR/if_DS_ep_callback=>callback_kind, END OF navigation_property_info_s
9	NAVIGATION_PROPERTY_INFO_T	Protected	See coding			20110919	navigation_property_info_t TYPE STANDARD TABLE OF navigation_property_info_s WITH KEY name
10	PROPERTY_S	Protected	See coding			20110919	BEGIN OF property_s, name TYPE string, name_uri_escaped TYPE string, simple TYPE REF TO type_simple_s, complex TYPE REF TO type_complex_s, visible TYPE abap_bool, property TYPE REF TO /IWCOR/if_DS_edm_property, END OF property_s
11	PROPERTY_T	Protected	See coding			20110919	property_t TYPE STANDARD TABLE OF property_s WITH KEY name
12	STREAM_S	Protected	See coding			20110919	BEGIN OF stream_s, media_read_only TYPE abap_bool, mime_type TYPE component_simple_s, media_src TYPE component_simple_s, END OF stream_s
13	TYPE_COMPLEX_S	Protected	See coding			20110919	BEGIN OF type_complex_s, qualified_name TYPE string, type TYPE REF TO /IWCOR/if_DS_edm_complex_type, component TYPE component_complex_s, properties TYPE REF TO data, END OF type_complex_s
14	TYPE_SIMPLE_S	Protected	See coding			20110919	BEGIN OF type_simple_s, qualified_name TYPE string, type TYPE REF TO /IWCOR/if_DS_edm_simple_type, component TYPE component_simple_s, mime_type_component TYPE component_simple_s, mime_type TYPE string, facets TYPE REF TO /IWCOR/if_DS_edm_element=>facets_s, customizable_feed_mappings TYPE REF TO /IWCOR/if_DS_edm_property=>customizable_feed_mappings_s, END OF type_simple_s

Method Signatures

Method GET_ENTITY_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ENTITY_INFO	Call by reference	☐	Type reference (TYPE)	ENTITY_INFO_S		EDM entity information	20110919
2	Importing	IO_ENTITY_SET	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_ENTITY_SET		EDM entity set	20110919
3	Importing	IO_EXPAND_SELECT	Call by reference	☑	Object reference (TYPE REF TO)	/IWCOR/IF_DS_URI_EXPAND_SELECT		Combined and normalized $expand and $select options	20120206
4	Importing	IO_STRUCTURE_DESCRIPTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Entry Data structure descriptor	20110919
5	Importing	IT_CALLBACK	Call by reference	☑	Type reference (TYPE)	/IWCOR/IF_DS_EP_CALLBACK=>CALLBACK_REGISTRATION_T		Callbacks	20120206
6	Importing	IT_OPTIONS	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		Options	20120110
7	Importing	IV_SERVICE_ROOT	Call by reference	☐	Type reference (TYPE)	STRING	``	Service Root	20110919

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐		20110919

Method GET_ENTITY_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROPERTY	Call by reference	☐	Type reference (TYPE)	ENTITY_PROPERTY_T		List of key properties	20120110
2	Importing	IO_ENTITY_SET	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_ENTITY_SET		EDM entity set	20120110
3	Importing	IO_STRUCTURE_DESCRIPTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Entry data structure descriptor	20120110
4	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	I	1	Mode	20120110

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐		20120110

Method GET_KEYS_OF_ENTITY_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROPERTY	Call by reference	☐	Type reference (TYPE)	ENTITY_PROPERTY_T		List of key properties	20110919
2	Importing	IO_ENTITY_SET	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_ENTITY_SET		EDM entity set	20110919
3	Importing	IO_STRUCTURE_DESCRIPTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Entry data structure descriptor	20110919

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐		20110919

Method GET_NAVIGATION_PROPERTY_STUB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RELATED_ENTITY_SET	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_ENTITY_SET			20120305
2	Importing	IV_MULTIPLICITY	Call by reference	☐	Type reference (TYPE)	/IWCOR/IF_DS_EDM=>EDM_MULTIPLICITY			20120305
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120305
4	Returning	RO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_NAV_PROPERTY			20120305

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐	OData error	20120305

Method GET_OPTION_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	DATA		Value	20120110
2	Importing	IT_OPTION	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Table name / value pairs	20120110
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name	20120110

Method GET_OPTION_VALUE on class /IWCOR/CL_DS_EP_HELPER has no exception.

Method GET_PROPERTIES_OF_COMPLEX_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROPERTY	Call by reference	☐	Type reference (TYPE)	PROPERTY_T		List of EDM complex type properties	20110929
2	Importing	IO_COMPLEX_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_COMPLEX_TYPE		EDM complex type	20110929
3	Importing	IO_STRUCTURE_DESCRIPTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Complex Data structure descriptor	20110929

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐		20110929

Method GET_PROPERTIES_OF_ENTITY_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NAVIGATION_PROPERTY	Call by reference	☐	Type reference (TYPE)	NAVIGATION_PROPERTY_INFO_T		List of EDM entity navigation properties	20110919
2	Exporting	ET_PROPERTY	Call by reference	☐	Type reference (TYPE)	ENTITY_PROPERTY_T		List of EDM entity properties	20110919
3	Exporting	EV_NUMBER_OF_KEYS	Call by reference	☐	Type reference (TYPE)	I		Number of keys	20120110
4	Importing	IO_ENTITY_SET	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_ENTITY_SET		EDM entity set	20110919
5	Importing	IO_EXPAND_SELECT	Call by reference	☑	Object reference (TYPE REF TO)	/IWCOR/IF_DS_URI_EXPAND_SELECT		Combined and normalized $expand and $select options	20120206
6	Importing	IT_CALLBACK	Call by reference	☑	Type reference (TYPE)	/IWCOR/IF_DS_EP_CALLBACK=>CALLBACK_REGISTRATION_T			20120206
7	Importing	IT_COMPONENT	Call by reference	☐	Type reference (TYPE)	/IWCOR/CL_DS_ABAP_HELPER=>COMPONENT_SIMPLEDESCR_T		Components	20110919

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐		20110919

Method GET_VSI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ACCESSOR	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_EDM_NAMED		VSI accessor	20120305
2	Returning	RO_VSI	Value transfer	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_VSI		OData virus scanner interface wrapper	20120305

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐	OData error	20120305

Method SKIP_NODE_INTO_READER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_READER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_READER		SXML Reader Interface	20120305
2	Returning	RO_READER	Value transfer	☐	Object reference (TYPE REF TO)	IF_SXML_READER		SXML Reader Interface	20120305

#	Exception	Resumable	Description	Created on
1	CX_SXML_PARSE_ERROR	☐		20140129

History

Last changed by/on	SAP	20131127
SAP Release Created in	200