SAP ABAP Interface IF_SXML_WRITER (XML Writer of the sXML Library)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-XML (Application Component) ABAP XML Processing
     ⤷ SXML (Package) Streamed XML Reader/Writer

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SXML_WRITER	XML Writer of the sXML Library	20041216

Properties

Interface	IF_SXML_WRITER
Short Description	XML Writer of the sXML Library

General Data

Package	SXML	Streamed XML Reader/Writer
Created	20041209	SAP
Last changed	20130531	SAP
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_SXML_NAMED	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SXML	☐	☐	Supported Formats of sXML Library	20041215
2	IF_SXML_NSURI_HELPER	☐	☐	Service Methods for Readers and Writers of sXML Library	20041215

Friends

Interface IF_SXML_WRITER has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_OPT_IGNORE_CONV_ERRROS	Constant	Public	☐	Type reference (TYPE)	I	3	Option: No termination if there is a conversion error	20081030
2	CO_OPT_INDENT	Constant	Public	☐	Type reference (TYPE)	I	5	Option: Indents for Pretty Print	20111102
3	CO_OPT_LINEBREAKS	Constant	Public	☐	Type reference (TYPE)	I	4	Option: Line Breaks for Pretty Print	20111102
4	CO_OPT_NORMALIZING	Constant	Public	☐	Type reference (TYPE)	I	1	Option: Line Breaks in Accordance with XML Specifications	20081013
5	CO_OPT_NO_EMPTY	Constant	Public	☐	Type reference (TYPE)	I	2	Option: No Short Write Form for Empty Elements	20081013
6	XML_TYPE	Instance attribute	Public	☐	Attribute reference (LIKE)				20041215

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE_ELEMENT	Instance method	Public	Method	Writes a Closing Element (token-based rendering)	20041210
2	GET_NSBINDINGS	Instance method	Public	Method	Write Value (Type RAW)	20041215
3	GET_NSURI_BY_PREFIX	Instance method	Public	Method	Write Value (Type RAW)	20041215
4	GET_OPTION	Instance method	Public	Method	Indicates whether an option is set	20111108
5	GET_PATH	Instance method	Public	Method	Write Value (Type RAW)	20041215
6	GET_PREFIX_BY_NSURI	Instance method	Public	Method	Write Value (Type RAW)	20041215
7	GET_VSI	Instance method	Public	Method	Return the Set Virus Scanner	20110928
8	NEW_CLOSE_ELEMENT	Static method	Public	Method	Factory to Create an Element Closing Object (OO)	20041210
9	NEW_OPEN_ELEMENT	Static method	Public	Method	Factory to Create an Element Opening Object (OO)	20041210
10	NEW_VALUE	Static method	Public	Method	Factory method, creates a value object (OO)	20041210
11	OPEN_ELEMENT	Instance method	Public	Method	Writes an opening element (token-based rendering)	20041210
12	SET_OPTION	Instance method	Public	Method	Sets option to control the writer, see long text	20081013
13	SET_VSI	Instance method	Public	Method	Sets a Virus Scanner	20110928
14	WRITE_ATTRIBUTE	Instance method	Public	Method	Writes an attribute (token-based rendering)	20041210
15	WRITE_ATTRIBUTE_RAW	Instance method	Public	Method	Writes an attribute with raw data (token-based rendering)	20041210
16	WRITE_NAMESPACE_DECLARATION	Instance method	Public	Method	Writes a namespace declaration (token-based rendering)	20050104
17	WRITE_NODE	Instance method	Public	Method	Writes a node object (object-oriented rendering)	20041210
18	WRITE_VALUE	Instance method	Public	Method	Writes a value (token-based rendering)	20041210
19	WRITE_VALUE_RAW	Instance method	Public	Method	Writes a value with raw data (token-based rendering)	20041210

Events

Interface IF_SXML_WRITER has no event.

Types

Interface IF_SXML_WRITER has no local type.

Method Signatures

Method CLOSE_ELEMENT Signature

Method CLOSE_ELEMENT on Interface IF_SXML_WRITER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

Method GET_NSBINDINGS Signature

Method GET_NSBINDINGS on Interface IF_SXML_WRITER has no parameter.
Method GET_NSBINDINGS on Interface IF_SXML_WRITER has no exception.

Method GET_NSURI_BY_PREFIX Signature

Method GET_NSURI_BY_PREFIX on Interface IF_SXML_WRITER has no parameter.
Method GET_NSURI_BY_PREFIX on Interface IF_SXML_WRITER has no exception.

Method GET_OPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPTION	Call by reference	☐	Type reference (TYPE)	I		Von SET_OPTION setzbare Option	20111108
2	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		abap_true falls gesetzt , abap false falls nicht gesetzt	20111108

Method GET_OPTION on Interface IF_SXML_WRITER has no exception.

Method GET_PATH Signature

Method GET_PATH on Interface IF_SXML_WRITER has no parameter.
Method GET_PATH on Interface IF_SXML_WRITER has no exception.

Method GET_PREFIX_BY_NSURI Signature

Method GET_PREFIX_BY_NSURI on Interface IF_SXML_WRITER has no parameter.
Method GET_PREFIX_BY_NSURI on Interface IF_SXML_WRITER has no exception.

Method GET_VSI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VSI	Value transfer	☐	Object reference (TYPE REF TO)	CL_VSI_KERNEL		Referenz auf Viren-Scanner	20110928

Method GET_VSI on Interface IF_SXML_WRITER has no exception.

Method NEW_CLOSE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SXML_CLOSE_ELEMENT		Referenz auf Elementabschlussobjekt	20041210

Method NEW_CLOSE_ELEMENT on Interface IF_SXML_WRITER has no exception.

Method NEW_OPEN_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SXML_OPEN_ELEMENT		Referenz auf Elementöffnungsobjekt	20041210
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Elementname	20041210
3	Importing	NSURI	Call by reference	☑	Type reference (TYPE)	STRING		Namensraum-URI	20041210
4	Importing	PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Namensraumpräfix	20041210

#	Exception	Resumable	Description	Created on
1	CX_SXML_NAME_ERROR	☐	SXML Named error	20050118

Method NEW_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VALUE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SXML_VALUE_NODE		Referenz auf Werteobjekt	20041210

Method NEW_VALUE on Interface IF_SXML_WRITER has no exception.

Method OPEN_ELEMENT 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		Elementname	20041210
2	Importing	NSURI	Call by reference	☑	Type reference (TYPE)	STRING		Namensraum-URI	20041210
3	Importing	PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Namensraumpräfix	20041210

#	Exception	Resumable	Description	Created on
1	CX_SXML_NAME_ERROR	☐	SXML Name Error	20050119
2	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

Method SET_OPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPTION	Call by reference	☐	Type reference (TYPE)	I		Zu setzende Option, siehe Langtext	20081013
2	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	abap_true setzt Option, abap false hebt gesetzte Option auf	20081013

Method SET_OPTION on Interface IF_SXML_WRITER has no exception.

Method SET_VSI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	VSI	Value transfer	☐	Object reference (TYPE REF TO)	CL_VSI_KERNEL		Referenz auf Viren-Scanner	20110928

Method SET_VSI on Interface IF_SXML_WRITER has no exception.

Method WRITE_ATTRIBUTE 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		Attributname	20041210
2	Importing	NSURI	Call by reference	☑	Type reference (TYPE)	STRING		Namensraum-URI	20041210
3	Importing	PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Namensraumpräfix	20041210
4	Importing	VALUE	Call by reference	☑	Type reference (TYPE)	STRING		Zeichenartiger Wert	20041210

#	Exception	Resumable	Description	Created on
1	CX_SXML_NAME_ERROR	☐	SXML Name Error	20050119
2	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

Method WRITE_ATTRIBUTE_RAW 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		Attributname	20041210
2	Importing	NSURI	Call by reference	☑	Type reference (TYPE)	STRING		Namensraum-URI	20041210
3	Importing	PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Namensraumpräfix	20041210
4	Importing	VALUE	Call by reference	☑	Type reference (TYPE)	XSTRING		Byteartiger Wert	20041210

#	Exception	Resumable	Description	Created on
1	CX_SXML_NAME_ERROR	☐	SXML Name Error	20050119
2	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

Method WRITE_NAMESPACE_DECLARATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NSURI	Call by reference	☐	Type reference (TYPE)	STRING		Namensraum-URI	20050104
2	Importing	PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Namensraumpräfix	20050104

#	Exception	Resumable	Description	Created on
1	CX_SXML_NAME_ERROR	☐	SXML Name Error	20050119

Method WRITE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_NODE		Referenz auf Knotenobjekt	20041210

#	Exception	Resumable	Description	Created on
1	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

Method WRITE_VALUE Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

Method WRITE_VALUE_RAW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	XSTRING		Byteartiger Wert	20041210

#	Exception	Resumable	Description	Created on
1	CX_SXML_STATE_ERROR	☐	SXML State error	20041215

History

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