SAP ABAP Class CL_O2_API_XMLDESC ((!)WCF: XML Description)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-WAB (Application Component) Web Application Builder
     ⤷ SO2_TOOL (Package) mySAP Application Server Pages: Tool

Properties

Class	CL_O2_API_XMLDESC
Short Description	(!)WCF: XML Description
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SO2_TOOL	mySAP Application Server Pages: Tool
Created	20000811	SAP
Last change	20010330	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ABAP_CHAR_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SEOK	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_O2_API_XMLDESC has no interface implemented.

Friends

Class CL_O2_API_XMLDESC has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ATTR	Instance attribute	Private	☐	Type reference (TYPE)	O2XMLATTR		XML Attributes (Changed by....)	20000811
2	ATTR_SAVED	Instance attribute	Private	☐	Type reference (TYPE)	O2XMLATTR		XML Attributes (Changed by....)	20000811
3	CHANGEABLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20000811
4	C_STATE_DELETED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'D'	Stauts: DELETED	20000811
5	C_STATE_INITIAL	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Status: INITIAL	20000811
6	C_STATE_NEW	Constant	Public	☐	Type reference (TYPE)	CHAR1	'N'	Status: NEW	20000811
7	C_STATE_REMOVED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'R'	Status: REMOVED	20000811
8	C_STATE_SAVED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'S'	Status: SAVED	20000811
9	C_STATE_UNSAVED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'U'	Status: UNSAVED	20000811
10	C_TRANSPORT_TYPE	Constant	Public	☐	Type reference (TYPE)	TROBJTYPE	'WXML'	Object Type	20000815
11	SOURCE	Instance attribute	Private	☐	Type reference (TYPE)	O2PAGELINE_TABLE		Oxygen Page Table	20000811
12	SOURCE_SAVED	Instance attribute	Private	☐	Type reference (TYPE)	O2PAGELINE_TABLE		Oxygen Page Table	20000811
13	STATE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1	CL_O2_API_XMLDESC=>C_STATE_INITIAL	Status	20000811
14	XML_DESC	Instance attribute	Private	☐	Type reference (TYPE)	CXMLDESC		XML Description Key	20000811

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_ACCESS_PERMISSION	Static method	Private	Method	Lock and Access Authorization	20000814
2	CALL_CORR_INSERT	Static method	Private	Method	Insert Correction	20000814
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000811
4	COPY	Instance method	Public	Method	Copy Source	20000811
5	CREATE_NEW	Static method	Public	Method	Create New Entry in Storage System	20000811
6	CREATE_NEW_FROM_STRING	Static method	Public	Method	Create New Entry in Storage System From Source String	20000811
7	DELETE	Instance method	Public	Method	Delete Source	20000811
8	EXISTS	Static method	Public	Method	Check Existence	20000811
9	GET_ATTRIBUTES	Instance method	Public	Method	Returns the Attribute Structure	20000811
10	GET_CHANGEABLE	Instance method	Public	Method	Query: Is the Program in Change Mode?	20000811
11	GET_CHANGED	Instance method	Public	Method	Query: Has the Object Been Changed?	20000811
12	GET_LENGTH_IN_BYTES	Instance method	Private	Method	Get Size of Internal Table in Bytes	20001130
13	GET_NAME	Instance method	Public	Method	Name of XML Description Object (xml_desc)	20000811
14	GET_SOURCE	Instance method	Public	Method	Return Source	20000811
15	GET_STATE	Instance method	Public	Method	Returns Current Status	20000814
16	LOAD	Static method	Public	Method	Load Source from Storage System	20000811
17	RESET	Instance method	Private	Method	Restore Data	20000811
18	SAVE	Instance method	Public	Method	Save Source in Storage System	20000811
19	SET_ATTRIBUTES	Instance method	Public	Method	Set Attributes	20000811
20	SET_CHANGEABLE	Instance method	Public	Method	Set Mode	20000811
21	SET_SOURCE	Instance method	Public	Method	Set Source	20000811
22	STRING_TO_TABLE	Static method	Private	Method	Copy String To Table	20000811
23	UNDO_CHANGES	Instance method	Public	Method	Undo Changes	20000811

Events

Class CL_O2_API_XMLDESC has no event.

Types

Class CL_O2_API_XMLDESC has no local type.

Method Signatures

Method CALL_ACCESS_PERMISSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_DEVCLASS	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Paket	20000814
2	Exporting	P_MASTERLANG	Call by reference	☐	Type reference (TYPE)	SYLANGU		aktuelle Sprache	20000814
3	Importing	P_MODE	Call by reference	☐	Type reference (TYPE)	SEOK_ACCESS_MODE			20000814
4	Exporting	P_MODIFYLANG	Call by reference	☐	Type reference (TYPE)	SYLANGU		aktuelle Sprache	20000814
5	Importing	P_OBJECTKEY	Call by reference	☐	Type reference (TYPE)	CXMLDESC		WB Request: Schlüssel eines Objekts in der EU	20000814
6	Exporting	P_TRANSPORT_KEY	Call by reference	☐	Type reference (TYPE)	TRKEY		Vollstaendiger Key eines Transportobjektes	20000814

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐		20000814
2	ENQUEUED_BY_USER	☐		20000814
3	ERROR_OCCURED	☐		20000814
4	LOCKED_BY_AUTHOR	☐		20000814
5	PERMISSION_FAILURE	☐		20000814

Method CALL_CORR_INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	P_CORRNUM	Call by reference	☐	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20000814
2	Importing	P_DEVCLASS	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Paket	20000814
3	Importing	P_MODE	Call by reference	☐	Type reference (TYPE)	CHAR6		Characterfeld der Länge 6	20000814
4	Importing	P_OBJECTKEY	Call by reference	☐	Type reference (TYPE)	CXMLDESC		WB Request: Schlüssel eines Objekts in der EU	20000814

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐		20000814
2	ERROR_OCCURED	☐		20000814
3	PERMISSION_FAILURE	☐		20000814

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ATTR	Call by reference	☐	Type reference (TYPE)	O2XMLATTR		XML-Beschreibungsdaten (Änderer, ...)	20000811
2	Importing	P_CREATE	Value transfer	☐	Type reference (TYPE)	CHAR1	SPACE	'X': neu angelegt	20000811
3	Importing	P_SOURCE	Call by reference	☐	Type reference (TYPE)	O2PAGELINE_TABLE		O2: Tabelle für OXygen-Page	20000811

Method CONSTRUCTOR on class CL_O2_API_XMLDESC has no exception.

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_O2_API_XMLDESC		API: XML-Beschreibung	20000811
2	Importing	P_TARGET_DEV_CLASS	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Paket	20000814
3	Importing	P_TARGET_XML_DESC	Call by reference	☐	Type reference (TYPE)	CXMLDESC		Characterfeld der Länge 70	20000811

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20000811
2	OBJECT_ALREADY_EXISTING	☐		20000811
3	OBJECT_CHANGED	☐		20000811
4	OBJECT_INVALID	☐		20000811
5	UNDEFINED_NAME	☐		20000822

Method CREATE_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ATTR	Call by reference	☐	Type reference (TYPE)	O2XMLATTR		Characterfeld der Länge 70	20000814
2	Exporting	P_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_O2_API_XMLDESC		API: XML-Beschreibung	20000811
3	Importing	P_SOURCE	Call by reference	☐	Type reference (TYPE)	O2PAGELINE_TABLE		O2: Tabelle für OXygen-Page	20000811

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

Method CREATE_NEW_FROM_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ATTR	Call by reference	☐	Type reference (TYPE)	O2XMLATTR		Characterfeld der Länge 70	20000814
2	Exporting	P_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_O2_API_XMLDESC		API: XML-Beschreibung	20000811
3	Importing	P_SOURCE	Value transfer	☐	Type reference (TYPE)	STRING			20000811

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐		20000814
2	ERROR_OCCURED	☐		20000814
3	NOT_AUTHORIZED	☐		20000814
4	OBJECT_ALREADY_EXISTING	☐		20000811

Method DELETE Signature

Method DELETE on class CL_O2_API_XMLDESC has no parameter.

#	Exception	Resumable	Description	Created on
1	OBJECT_INVALID	☐		20000811
2	OBJECT_NOT_CHANGEABLE	☐		20000811

Method EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_EXISTS	Value transfer	☐	Type reference (TYPE)	CHAR1		'1': existiert bereits, sonst '0'	20000811
2	Importing	P_XML_DESC	Call by reference	☐	Type reference (TYPE)	CXMLDESC		Characterfeld der Länge 70	20000811

Method EXISTS on class CL_O2_API_XMLDESC has no exception.

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	O2XMLATTR		XML-Beschreibungsdaten (Änderer, ...)	20000811

#	Exception	Resumable	Description	Created on
1	OBJECT_INVALID	☐		20000811
2	XMLDESC_DELETED	☐		20000811

Method GET_CHANGEABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_CHANGEABLE	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20000811

#	Exception	Resumable	Description	Created on
1	OBJECT_INVALID	☐		20000811

Method GET_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_CHANGED	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20000811

#	Exception	Resumable	Description	Created on
1	OBJECT_INVALID	☐		20000811

Method GET_LENGTH_IN_BYTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_BYTES	Value transfer	☐	Type reference (TYPE)	I		Größe in Byte	20001130

Method GET_LENGTH_IN_BYTES on class CL_O2_API_XMLDESC has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_NAME	Value transfer	☐	Type reference (TYPE)	CXMLDESC		Characterfeld der Länge 70	20000811

Method GET_NAME on class CL_O2_API_XMLDESC has no exception.

Method GET_SOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_SOURCE	Value transfer	☐	Type reference (TYPE)	O2PAGELINE_TABLE		O2: Tabelle für OXygen-Page	20000811

#	Exception	Resumable	Description	Created on
1	OBJECT_DELETED	☐		20000811
2	OBJECT_INVALID	☐		20000811

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_STATE	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20000814

Method GET_STATE on class CL_O2_API_XMLDESC has no exception.

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_BYTES	Call by reference	☐	Type reference (TYPE)	I		Größe in Byte	20001204
2	Exporting	P_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_O2_API_XMLDESC		XML-Beschreibung	20000811
3	Importing	P_XML_DESC	Call by reference	☐	Type reference (TYPE)	CXMLDESC		Name der XML-Beschreibung	20000811

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Fehöer aufgetreten	20000814
2	NOT_EXISTING	☐	Objekt existiert nicht	20000811
3	PERMISSION_FAILURE	☐	Keine passende Berechtigung	20000814

Method RESET Signature

Method RESET on class CL_O2_API_XMLDESC has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20000811
2	OBJECT_INVALID	☐		20000811

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	P_TRANSPORT_REQUEST	Call by reference	☑	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20000814

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐		20000814
2	ERROR_OCCURED	☐		20000811
3	OBJECT_INVALID	☐		20000811
4	OBJECT_NOT_CHANGEABLE	☐		20000811
5	PERMISSION_FAILURE	☐		20000814

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)	O2XMLATTR		XML-Beschreibungsdaten (Änderer, ...)	20000811

#	Exception	Resumable	Description	Created on
1	OBJECT_DELETED	☐		20000811
2	OBJECT_INVALID	☐		20000811
3	OBJECT_NOT_CHANGEABLE	☐		20000811

Method SET_CHANGEABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_CHANGEABLE	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20000811

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐		20000814
2	ERROR_OCCURED	☐		20000814
3	OBJECT_ALREADY_CHANGEABLE	☐		20000811
4	OBJECT_ALREADY_UNLOCKED	☐		20000811
5	OBJECT_INVALID	☐		20000811
6	OBJECT_JUST_CREATED	☐		20000811
7	OBJECT_LOCKED_BY_OTHER_USER	☐		20000814
8	OBJECT_MODIFIED	☐		20000811
9	PERMISSION_FAILURE	☐		20000814

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)	O2PAGELINE_TABLE		O2: Tabelle für OXygen-Page	20000811

#	Exception	Resumable	Description	Created on
1	OBJECT_DELETED	☐		20000811
2	OBJECT_INVALID	☐		20000811
3	OBJECT_NOT_CHANGEABLE	☐		20000811

Method STRING_TO_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_SOURCE_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20000811
2	Exporting	P_TAB	Call by reference	☐	Type reference (TYPE)	O2PAGELINE_TABLE		O2: Tabelle für OXygen-Page	20000811

Method STRING_TO_TABLE on class CL_O2_API_XMLDESC has no exception.

Method UNDO_CHANGES Signature

Method UNDO_CHANGES on class CL_O2_API_XMLDESC has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20000811
2	OBJECT_INVALID	☐		20000811
3	OBJECT_IS_NEW	☐		20000811
4	OBJECT_NOT_CHANGEABLE	☐		20000811

History

Last changed by/on	SAP	20010330
SAP Release Created in	50A