SAP ABAP Class CL_XMS_SYSTEM_ERROR (XMS: System Error)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-IEN (Application Component) Integration Engine
     ⤷ SXMSF (Package) XI: Integration Engine Runtime

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_XMS_MAIN_CONST	XMS: Constants	20010619
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_XMS_PROP	A Property Serializable in a String	20010606
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_XMS_SYSTEM_ERROR	XMS: System Error	20010606

Properties

Class	CL_XMS_SYSTEM_ERROR
Short Description	XMS: System Error
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SXMSF	XI: Integration Engine Runtime
Created	20010606	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_XMS_TRACE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_XMS_MAIN_CONST	☐	☐	XMS: Constants	20010619
2	IF_XMS_PROP	☐	☐	A Property Serializable in a String	20010606
3	IF_XMS_SYSTEM_ERROR	☐	☐	XMS: System Error	20010606

Friends

Class CL_XMS_SYSTEM_ERROR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CATEGORY	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSERRCAT		XMS: Error Category	20010619
2	CONTEXT	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Error Code Context	20010606
3	CO_CAT_APPLICATIONCALL	Constant	Public	☐	Type reference (TYPE)	SXMSERRCAT	'APPLICATIONCALL'	Integration Engine: Error Category	20011114
4	CO_CAT_PERSIST	Constant	Public	☐	Type reference (TYPE)	SXMSERRCAT	'PERSIST'	Category for Errors in Persistency Layer	20011113
5	CO_FALSE	Instance attribute	Private	☐	Attribute reference (LIKE)				20010619
6	CO_ID_APPLICATION_ERROR	Constant	Public	☐	Type reference (TYPE)	SXMSERRID	'APPLICATION_ERROR'	Integration Engine: Error ID	20011114
7	CO_SEPARATOR	Constant	Public	☐	Type reference (TYPE)	STRING	'.'	Separator	20010927
8	CO_TAG_ATTRIBUTE_LANGUAGE	Constant	Public	☐	Type reference (TYPE)	STRING	'language'	XML Attribute Name	20010619
9	CO_TAG_ATTRIBUTE_PARAM1	Instance attribute	Public	☐	Type reference (TYPE)	STRING	'p1'	XML Attribute Name	20010619
10	CO_TAG_ATTRIBUTE_PARAM2	Instance attribute	Public	☐	Type reference (TYPE)	STRING	'p2'	XML Attribute Name	20010619
11	CO_TAG_ATTRIBUTE_PARAM3	Instance attribute	Public	☐	Type reference (TYPE)	STRING	'p3'	XML Attribute Name	20010619
12	CO_TAG_ATTRIBUTE_PARAM4	Instance attribute	Public	☐	Type reference (TYPE)	STRING	'p4'	XML Attribute Name	20010619
13	CO_TAG_ERR_CODE	Constant	Public	☐	Type reference (TYPE)	STRING	'Code'	XML Tag Name	20010611
14	CO_TAG_ERR_CODE_CONTEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'Context'	XML Tag Name	20010611
15	CO_TAG_ERR_TEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'Text'	XML Tag Name	20010611
16	CO_TAG_PREFIX	Constant	Public	☐	Type reference (TYPE)	STRING	'SAP'	Tag Prefix	20010717
17	CO_TAG_RETRY	Constant	Public	☐	Type reference (TYPE)	STRING	'Retry'	XML Tag Name	20010619
18	CO_TRUE	Instance attribute	Private	☐	Attribute reference (LIKE)				20010619
19	ID	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSERRID		XMS: Error ID	20010619
20	LANGUAGE	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSSYERRT-LANGU		Error Text Language	20010611
21	LCNAME	Constant	Public	☐	Type reference (TYPE)	STRING	'ErrorHeader'	Property Tag Name	20010626
22	NSURI	Constant	Public	☐	Type reference (TYPE)	STRING	'http://sap.com/exchange/MessageFormat'	Name Space URI	20010626
23	PARAM1	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Parameter Value 1	20010619
24	PARAM2	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Parameter value 2	20010619
25	PARAM3	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Parameter value 3	20010619
26	PARAM4	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Parameter value 4	20010619
27	RETRY	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSFLAG		XMS: Flag (true/false)	20010619
28	TEXT	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSSYERRT-TXTCODE		Error Text	20010606

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONCATENATE_ERROR_CODE	Static method	Public	Method	Concatenate Error Code from Category and ID	20010927
2	DISPLAY_DOCU	Static method	Public	Method	Displays Long Text in Amodal Window	20020225
3	GET_DOCU	Static method	Public	Method	Gets Documentation for System Error in HTML Format	20020225
4	REPLACE	Static method	Public	Method	Replace Parameter with Value	20020225
5	SPLIT_ERROR_CODE	Static method	Public	Method	Split Up Error Code into Category and ID	20010927
6	TOSTRING	Static method	Public	Method	Converts to String	20010629

Events

Class CL_XMS_SYSTEM_ERROR has no event.

Types

Class CL_XMS_SYSTEM_ERROR has no local type.

Method Signatures

Method CONCATENATE_ERROR_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CATEGORY	Call by reference	☐	Type reference (TYPE)	SXMSERRCAT		XMS: Fehlerkategorie	20010927
2	Importing	IM_ID	Call by reference	☐	Type reference (TYPE)	SXMSERRID		XMS: Fehler-ID	20010927
3	Returning	RE_CODE	Value transfer	☐	Type reference (TYPE)	STRING		XMS: Fehler-Code	20010927

Method CONCATENATE_ERROR_CODE on class CL_XMS_SYSTEM_ERROR has no exception.

Method DISPLAY_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CODE	Call by reference	☐	Type reference (TYPE)	STRING		Fehlercode	20020225
2	Importing	IM_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SPRAS		Sprachenschlüssel	20020225
3	Importing	IM_VALUE1	Call by reference	☐	Type reference (TYPE)	STRING		1. Paramterwert	20020225
4	Importing	IM_VALUE2	Call by reference	☐	Type reference (TYPE)	STRING		2. Paramterwert	20020225
5	Importing	IM_VALUE3	Call by reference	☐	Type reference (TYPE)	STRING		3. Paramterwert	20020225
6	Importing	IM_VALUE4	Call by reference	☐	Type reference (TYPE)	STRING		4. Paramterwert	20020225

Method DISPLAY_DOCU on class CL_XMS_SYSTEM_ERROR has no exception.

Method GET_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_DOCU_OBJECT	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT		Dokumentations-Objekt	20020225
2	Exporting	EX_TEXT_LONG	Call by reference	☐	Type reference (TYPE)	TLINETAB		Fehlertext lang	20020225
3	Exporting	EX_TEXT_LONG_HTML	Call by reference	☐	Type reference (TYPE)	HTMLTABLE		Fehlertext lang HTML	20020225
4	Exporting	EX_TEXT_SHORT	Call by reference	☐	Type reference (TYPE)	STRING		Fehlertext kurz	20020225
5	Importing	IM_CODE	Call by reference	☐	Type reference (TYPE)	STRING		Error-Code	20020225
6	Importing	IM_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SPRAS		Sprache	20020225
7	Importing	IM_VALUE1	Call by reference	☐	Type reference (TYPE)	STRING		1. Parameter	20020225
8	Importing	IM_VALUE2	Call by reference	☐	Type reference (TYPE)	STRING		2. Parameter	20020225
9	Importing	IM_VALUE3	Call by reference	☐	Type reference (TYPE)	STRING		3. Parameter	20020225
10	Importing	IM_VALUE4	Call by reference	☐	Type reference (TYPE)	STRING		4. Parameter	20020225

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Langtext nicht gefunden	20020225

Method REPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TEXT	Call by reference	☐	Type reference (TYPE)	TLINETAB		Tabelle von Textzeilen	20020225
2	Importing	IM_PATTERN	Call by reference	☐	Type reference (TYPE)	STRING			20020225
3	Importing	IM_REPLACE_WITH	Call by reference	☐	Type reference (TYPE)	STRING			20020225
4	Importing	IM_TEXT	Call by reference	☐	Type reference (TYPE)	TLINE		Textzeile	20020225

Method REPLACE on class CL_XMS_SYSTEM_ERROR has no exception.

Method SPLIT_ERROR_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CATEGORY	Call by reference	☐	Type reference (TYPE)	SXMSERRCAT		XMS: Fehlerkategorie	20010927
2	Exporting	EX_ID	Call by reference	☐	Type reference (TYPE)	SXMSERRID		XMS: Fehler-ID	20010927
3	Importing	IM_CODE	Call by reference	☐	Type reference (TYPE)	STRING		XMS: Fehlercode	20010927

Method SPLIT_ERROR_CODE on class CL_XMS_SYSTEM_ERROR has no exception.

Method TOSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		In String konvertierbarer Wert	20010629
2	Exporting	RE_STRING	Call by reference	☐	Type reference (TYPE)	STRING		String	20010629

Method TOSTRING on class CL_XMS_SYSTEM_ERROR has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	620