SAP ABAP Class CL_W3_API_XML3 (ITS-API: XML Templates for Templates)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-WAB (Application Component) Web Application Builder
     ⤷ SW3_API (Package) ITS: API

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_W3_API_OBJECT	ITS API: General Functions	20130129

Properties

Class	CL_W3_API_XML3
Short Description	ITS-API: XML Templates for Templates
Super Class	CL_W3_API_OBJECT	ITS API: General Functions
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SW3_API	ITS: API
Created	20121214	SAP
Last change	20140121	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)

Interfaces

Class CL_W3_API_XML3 has no interface implemented.

Friends

Class CL_W3_API_XML3 has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ATTRIBUTES	Instance attribute	Protected	☐	Type reference (TYPE)	W3TEMPATTR		ITS: Attributes for Templates	20130129
2	ATTRIBUTES_SAVED	Instance attribute	Protected	☐	Type reference (TYPE)	W3TEMPATTR		ITS: Attributes for Templates	20130129
3	A_DATABASE_ACCESS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_IAC_XML		XML Templates for Templates	20130129
4	SOURCE_SAVED	Instance attribute	Protected	☐	Type reference (TYPE)	XSTRING			20130129
5	S_XML_DIR	Static Attribute	Protected	☐	Type reference (TYPE)	T_SW3_TYPE_XML_DIR			20130129
6	TEMP_XML_HIERARCHY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_IAC_XML_HIERARCHY3		XML Templates, Hierarchy	20130129
7	XML_HIERARCHY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_IAC_XML_HIERARCHY3		XML Templates, Hierarchy	20130129
8	XML_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	IACIKEYT		Structure of Internal Key Template (language-independent)	20130129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST	Instance method	Public	Method		20130129
2	CHECK_CHANGEABLE	Instance method	Protected	Method		20130129
3	CONSTRUCTOR	Instance method	Public	Constructor		20130129
4	CREATE_NEW	Static method	Public	Method		20130129
5	GET_ATTRIBUTES	Instance method	Public	Method		20130129
6	GET_HIERARCHY_READ	Instance method	Public	Method		20130129
7	GET_NAME	Instance method	Public	Method		20130129
8	GET_PROPERTY_SETTINGS_AS_JSON	Instance method	Public	Method		20130527
9	GET_SOURCE	Instance method	Public	Method		20130129
10	INIT_HIERARCHY	Instance method	Protected	Method		20130129
11	LOAD	Static method	Public	Method		20130129
12	PUBLISH	Static method	Public	Method		20130129
13	SCREEN_ELEMENT_PROP_CHANGED	Instance method	Public	Method		20130129
14	SET_ATTRIBUTES	Instance method	Public	Method		20130129
15	SET_GENERATE_ELEMENT	Instance method	Public	Method		20130129
16	SET_SOURCE	Instance method	Public	Method		20130129
17	S_CHECK_EXIST	Static method	Public	Method		20130129
18	S_GET_XML	Static method	Protected	Method		20130129

Events

Class CL_W3_API_XML3 has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_SW3_TYPE_XML_DIR	Protected	See coding			20130129	t_sw3_type_xml_dir TYPE HASHED TABLE OF t_sw3_type_xml_dir_line WITH UNIQUE KEY xml_name
2	T_SW3_TYPE_XML_DIR_LINE	Protected	See coding			20130129	BEGIN OF t_sw3_type_xml_dir_line, xml_name TYPE iacikeyt, xml TYPE REF TO cl_w3_api_xml3, END OF t_sw3_type_xml_dir_line

Method Signatures

Method ADJUST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_GENERATION_STYLE	Call by reference	☐	Type reference (TYPE)	W3STYLE			20130129
2	Importing	P_GENERATOR_CLASS	Call by reference	☐	Type reference (TYPE)	W3STYLECLASS			20130129

#	Exception	Resumable	Description	Created on
1	CX_IAC_XML	☐		20130129
2	CX_W3_API_XML	☐	Fehler bei XML-Vorlagen	20130129

Method CHECK_CHANGEABLE Signature

Method CHECK_CHANGEABLE on class CL_W3_API_XML3 has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_W3_API_XML	☐	Fehler bei XML-Vorlagen	20130129

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	W3TEMPATTR		ITS: Attribute für Templates	20130129
2	Importing	P_CREATE	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	allgemeines flag	20130129
3	Importing	P_DATABASE_ACCESS	Call by reference	☑	Object reference (TYPE REF TO)	CL_IAC_XML		XML-Vorlagen für Templates	20130129
4	Importing	P_IGNORE_DATA_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130129
5	Importing	P_SOURCE	Call by reference	☐	Type reference (TYPE)	XSTRING			20130129

#	Exception	Resumable	Description	Created on
1	DATA_CORRUPT	☐		20130129

Method CREATE_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ADJUST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Vorhandene Vorlage an Dynpro anpassen	20130719
2	Importing	P_DO_NOT_CHECK_NAME	Call by reference	☑	Type reference (TYPE)	FLAG		allgemeines flag	20130129
3	Importing	P_GENERATOR_CLASS	Call by reference	☐	Type reference (TYPE)	W3STYLECLASS		WAB: KLasse für Template-Generierung	20130129
4	Importing	P_OVERWRITE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Vorhandene Vorlage überschreiben	20130129
5	Importing	P_PROGRAM_NAME	Call by reference	☐	Type reference (TYPE)	IACKEYLONG		Langer Schlüssel für IAC-Objekte	20130129
6	Importing	P_SOURCE_STYLE_2006	Call by reference	☐	Type reference (TYPE)	W3STYLE		WAB: Stil für die Templategenerierung	20130129
7	Importing	P_SUPPRESS_LANGUAGE_CHECK	Call by reference	☑	Type reference (TYPE)	FLAG		allgemeines flag	20130129
8	Exporting	P_XML	Call by reference	☐	Object reference (TYPE REF TO)	CL_W3_API_XML3		ITS-API: Daten für XML-Vorlagen von Templates	20130129
9	Importing	P_XML_DATA	Call by reference	☐	Type reference (TYPE)	W3TEMPATTR		ITS: Attribute für Templates	20130129
10	Exporting	P_XML_NAME	Call by reference	☐	Type reference (TYPE)	IACIKEYT		Struktur interner Schlüssel Template (sprachunabhängig)	20130129

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐		20130129
2	ERROR_OCCURED	☐		20130129
3	NOT_AUTHORIZED	☐		20130129
4	OBJECT_ALREADY_EXISTING	☐		20130129
5	UNDEFINED_NAME	☐		20130129

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	W3TEMPATTR			20130129

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20130129
2	OBJECT_INVALID	☐		20130129
3	XML_DELETED	☐		20130129

Method GET_HIERARCHY_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HIERARCHY	Value transfer	☐	Object reference (TYPE REF TO)	IF_IAC_XML_HIERARCHY_READ3		XML-Vorlagen, Hierarchie, nicht änderbar	20130129

Method GET_HIERARCHY_READ on class CL_W3_API_XML3 has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_XML_NAME	Call by reference	☐	Type reference (TYPE)	IACIKEYT			20130129

Method GET_NAME on class CL_W3_API_XML3 has no exception.

Method GET_PROPERTY_SETTINGS_AS_JSON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_PROPERTIES_AS_JSON	Value transfer	☐	Object reference (TYPE REF TO)	IF_IAC_JSON		JSON-Objekt	20130527

Method GET_PROPERTY_SETTINGS_AS_JSON on class CL_W3_API_XML3 has no exception.

Method GET_SOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_SOURCE	Call by reference	☐	Type reference (TYPE)	XSTRING			20130129

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20130129
2	OBJECT_INVALID	☐		20130129
3	XML_DELETED	☐		20130129

Method INIT_HIERARCHY Signature

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

#	Exception	Resumable	Description	Created on
1	CX_IAC_XML	☐		20130129

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	W3TEMPATTR		ITS: Attribute für Templates	20130129
2	Importing	P_IGNORE_DATA_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130129
3	Exporting	P_SOURCE	Call by reference	☐	Type reference (TYPE)	XSTRING			20130129
4	Exporting	P_XML	Call by reference	☐	Object reference (TYPE REF TO)	CL_W3_API_XML3			20130129
5	Importing	P_XML_NAME	Call by reference	☐	Type reference (TYPE)	IACIKEYT			20130129

#	Exception	Resumable	Description	Created on
1	DATA_CORRUPT	☐		20130129
2	ERROR_OCCURED	☐		20130129
3	OBJECT_NOT_EXISTING	☐		20130129
4	PERMISSION_FAILURE	☐		20130129

Method PUBLISH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_INVALIDATE_PPTS	Call by reference	☐	Type reference (TYPE)	FLAG	'X'		20130129
2	Importing	P_LONG_NAME	Call by reference	☐	Type reference (TYPE)	IACKEYLONG			20130129
3	Exporting	P_MESSAGES	Call by reference	☐	Type reference (TYPE)	W3_ERROR_MESSAGES			20130129
4	Importing	P_XML_NAME	Call by reference	☐	Type reference (TYPE)	IACIKEYT			20130129

#	Exception	Resumable	Description	Created on
1	DATA_INVALID	☐		20130129
2	ERROR_OCCURED	☐		20130129
3	NO_DESTINATION	☐		20130129
4	OBJECT_NOT_EXISTING	☐		20130129
5	PERMISSION_FAILURE	☐		20130129
6	PUBLISHING_ERROR	☐		20130129

Method SCREEN_ELEMENT_PROP_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	SCRFNAME			20130129
2	Importing	P_ELEMENT_PART	Call by reference	☐	Type reference (TYPE)	IACXMLELEMENTPART			20130129
3	Importing	P_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	SCRNTYPE			20130129
4	Importing	P_FIRST_OF_MULTIPLE_CHANGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Erste Änderung von mehreren	20130129
5	Importing	P_LAST_OF_MULTIPLE_CHANGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Letzte Änderung einer Eigenschaft (abschließen)	20130129
6	Importing	P_MULTIPLE_CHANGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Eine von vielen Änderungen	20130129
7	Importing	P_PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	IACXMLPROPERTY			20130129
8	Importing	P_PROPERTY_USE	Call by reference	☐	Type reference (TYPE)	IACXMLPROPERTYUSE			20130129
9	Importing	P_PROPERTY_VALUE	Call by reference	☑	Type reference (TYPE)	ANY			20130129
10	Importing	P_STATUS	Call by reference	☑	Type reference (TYPE)	STRING			20130129
11	Importing	P_USE_DEFAULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130129

#	Exception	Resumable	Description	Created on
1	CX_IAC_XML	☐		20130129
2	CX_W3_API_XML	☐	Fehler bei XML-Vorlagen	20130129

Method SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	W3TEMPATTR			20130129

#	Exception	Resumable	Description	Created on
1	AUTHORIZE_FAILURE	☐		20130129
2	AUTHOR_NOT_EXISTING	☐		20130129
3	ERROR_OCCURED	☐		20130129
4	OBJECT_DELETED	☐		20130129
5	OBJECT_INVALID	☐		20130129
6	OBJECT_NOT_CHANGEABLE	☐		20130129

Method SET_GENERATE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	SCRFNAME			20130129
2	Importing	P_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	SCRNTYPE			20130129
3	Importing	P_GENERATE_ELEMENT	Call by reference	☐	Type reference (TYPE)	IACXMLGENERATEELEMENT			20130129

#	Exception	Resumable	Description	Created on
1	CX_W3_API_XML	☐	Fehler bei XML-Vorlagen	20130129

Method SET_SOURCE Signature

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

#	Exception	Resumable	Description	Created on
1	AUTHORIZE_FAILURE	☐		20130129
2	ERROR_OCCURED	☐		20130129
3	INVALID_PARAMETER	☐		20130129
4	OBJECT_DELETED	☐		20130129
5	OBJECT_INVALID	☐		20130129
6	OBJECT_NOT_CHANGEABLE	☐		20130129

Method S_CHECK_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_EXISTS	Call by reference	☐	Type reference (TYPE)	FLAG		allgemeines flag	20130129
2	Importing	P_XML_NAME	Call by reference	☐	Type reference (TYPE)	IACIKEYT		Struktur interner Schlüssel Template (sprachunabhängig)	20130129

Method S_CHECK_EXIST on class CL_W3_API_XML3 has no exception.

Method S_GET_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_XML	Call by reference	☐	Object reference (TYPE REF TO)	CL_W3_API_XML3		ITS-API: XML-Vorlagen für Templates	20130129
2	Importing	P_XML_NAME	Call by reference	☐	Type reference (TYPE)	IACIKEYT			20130129

Method S_GET_XML on class CL_W3_API_XML3 has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740