SAP ABAP Class CL_ATOM_BASE_PROV (Atom base entity provider)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RST (Application Component) REST-based Protocols
     ⤷ SATOM_CORE (Package) ATOM core

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_REST_ENTITY_PROVIDER	REST Entity Provider	20100810

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_APP_CATEGORIES_PROV	Atom feed	20100810
2	Inheritance (c INHERITING FROM c_ref)	CL_APP_SERVICE_PROV	Atom feed	20100810
3	Inheritance (c INHERITING FROM c_ref)	CL_ATOM_ENTRY_PROV	Atom entry	20100810
4	Inheritance (c INHERITING FROM c_ref)	CL_ATOM_ERROR_PROV	Atom ST error provider	20101007
5	Inheritance (c INHERITING FROM c_ref)	CL_ATOM_FEED_PROV	Atom feed	20100810
6	Inheritance (c INHERITING FROM c_ref)	CL_OPENSRCH_DESRC_PROV	Atom feed	20100810

Properties

Class	CL_ATOM_BASE_PROV
Short Description	Atom base entity provider
Super Class	CL_REST_ENTITY_PROVIDER	REST Entity Provider
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SATOM_CORE	ATOM core
Created	20100810	SAP
Last change	20130531	SAP
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	IF_ATOM_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ATOM_BASE_PROV has no interface implemented.

Friends

Class CL_ATOM_BASE_PROV has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ST_PARAMETER_NAMESPACE	Constant	Private	☐	Type reference (TYPE)	STRING	'IT_NAMESPACE_DECLARATION'	Transformation parameter namespace	20100813
2	GC_XML_HEADER_FULL	Constant	Public	☐	Type reference (TYPE)	STRING	'full'		20111005
3	GC_XML_HEADER_NO	Constant	Public	☐	Type reference (TYPE)	STRING	'no'		20111005
4	GC_XML_HEADER_WITHOUT_ENCODING	Constant	Public	☐	Type reference (TYPE)	STRING	'without_encoding'		20111005
5	MD_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Data reference	20100813
6	MO_PARAMETER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ATOM_ST_PARAMETER		ATOM ST parameter	20110201
7	MO_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SXML_READER		SXML Reader Interface	20100812
8	MT_NAMESPACE	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ATOM_TYPES=>NAMESPACE_T		Namespace predeclarations	20100810
9	MV_STRUCTURE_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of data structure	20100813
10	MV_XML_HEADER	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20111005

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BEFORE_RAISE_EXCEPTION	Instance method	Protected	Method	Method called before raise exception is called	20101007
2	CALL_TRANSFORMATION_READ	Instance method	Protected	Method	Read	20101006
3	CALL_TRANSFORMATION_WRITE	Instance method	Protected	Method	Write	20101006
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100810
5	CREATE_EXCEPTION	Instance method	Private	Method	Create a no check exception	20101006
6	DESERIALIZE	Instance method	Private	Method	Deserialize	20100810
7	GET_STRUCTURE	Instance method	Protected	Method	Get deep structure	20100815
8	GET_STRUCTURE_REFERENCE	Instance method	Public	Method	Get deep structure reference	20100815
9	PUT_NAMESPACE_DECLARATION	Instance method	Public	Method	Update/Add a namespace	20111007
10	SERIALIZE	Instance method	Private	Method	Serialize	20100810
11	SET_NAMESPACE_DECLARATIONS	Instance method	Public	Method	Set namespaces	20100810
12	SET_PARAMETER	Instance method	Protected	Method	Set ST parameter	20110201
13	SET_STRUCTURE	Instance method	Protected	Method	Set deep structure	20100815
14	SET_XML_HEADER	Instance method	Public	Method	Set Simple Transformations XML header	20111005
15	TO_XSTRING	Instance method	Public	Method	Searialize data structure to xml string	20100813

Events

Class CL_ATOM_BASE_PROV has no event.

Types

Class CL_ATOM_BASE_PROV has no local type.

Method Signatures

Method BEFORE_RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Value transfer	☐	Object reference (TYPE REF TO)	CX_REST_EXCEPTION		REST Exception	20101007

Method BEFORE_RAISE_EXCEPTION on class CL_ATOM_BASE_PROV has no exception.

Method CALL_TRANSFORMATION_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLBACK	Call by reference	☑	Object reference (TYPE REF TO)	IF_ATOM_ST_CALLBACK		Callback	20101006
2	Importing	IO_READER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_READER		SXML Reader	20101006
3	Importing	IT_RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_TRANS_RESBIND_TAB		Result	20101006
4	Importing	IV_ST_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Transformation Name	20101006

#	Exception	Resumable	Description	Created on
1	CX_SXML_ERROR	☐	SXML Root Exception	20120801
2	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20101006

Method CALL_TRANSFORMATION_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLBACK	Call by reference	☑	Object reference (TYPE REF TO)	IF_ATOM_ST_CALLBACK		Callback	20101006
2	Importing	IO_WRITER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_WRITER		SXML Writer	20101006
3	Importing	IT_SOURCE	Call by reference	☐	Type reference (TYPE)	ABAP_TRANS_SRCBIND_TAB		Source	20101006
4	Importing	IV_ST_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Transformation Name	20101006

#	Exception	Resumable	Description	Created on
1	CX_SXML_ERROR	☐	SXML Root Exception	20120801
2	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20101006

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY	Call by reference	☑	Object reference (TYPE REF TO)	IF_REST_ENTITY			20110201
2	Importing	IO_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SXML_READER		Reader	20100813
3	Importing	IT_NAMESPACE_PREDECLARATION	Call by reference	☑	Type reference (TYPE)	IF_ATOM_TYPES=>NAMESPACE_T		Namespace predeclarations	20100813
4	Importing	IV_STRUCTURE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Data structure name	20100813

Method CONSTRUCTOR on class CL_ATOM_BASE_PROV has no exception.

Method CREATE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_DYNAMIC_CHECK		Dynamic Error	20120801
2	Returning	RO_EXCEPTION	Value transfer	☐	Object reference (TYPE REF TO)	CX_REST_EXCEPTION		REST Exception	20101006

Method CREATE_EXCEPTION on class CL_ATOM_BASE_PROV has no exception.

Method DESERIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Data reference	20100813
2	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ATOM_ST_PARAMETER			20110201

Method DESERIALIZE on class CL_ATOM_BASE_PROV has no exception.

Method GET_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DATA	Call by reference	☐	Type reference (TYPE)	DATA		Structure data	20100815

Method GET_STRUCTURE on class CL_ATOM_BASE_PROV has no exception.

Method GET_STRUCTURE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RD_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20100815

Method GET_STRUCTURE_REFERENCE on class CL_ATOM_BASE_PROV has no exception.

Method PUT_NAMESPACE_DECLARATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NAMESPACE	Call by reference	☐	Type reference (TYPE)	IF_ATOM_TYPES=>NAMESPACE_S		Namespace structure according to spec	20111007

Method PUT_NAMESPACE_DECLARATION on class CL_ATOM_BASE_PROV has no exception.

Method SERIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ATOM_ST_PARAMETER			20110201
2	Importing	IO_WRITER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_WRITER		SXML Writer	20100813

Method SERIALIZE on class CL_ATOM_BASE_PROV has no exception.

Method SET_NAMESPACE_DECLARATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_NAMESPACE	Call by reference	☐	Type reference (TYPE)	IF_ATOM_TYPES=>NAMESPACE_T		Namespace structure according to spec	20100810

Method SET_NAMESPACE_DECLARATIONS on class CL_ATOM_BASE_PROV has no exception.

Method SET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ATOM_ST_PARAMETER		ATOM ST parameter	20110201

Method SET_PARAMETER on class CL_ATOM_BASE_PROV has no exception.

Method SET_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	DATA		Structure data	20100815

Method SET_STRUCTURE on class CL_ATOM_BASE_PROV has no exception.

Method SET_XML_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XML_HEADER	Call by reference	☐	Type reference (TYPE)	STRING		ST parameter to set XML header	20111005

Method SET_XML_HEADER on class CL_ATOM_BASE_PROV has no exception.

Method TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING		Binary data	20100813

Method TO_XSTRING on class CL_ATOM_BASE_PROV has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	800