SAP ABAP Class CL_XMS_MSG_REFS (CL_XMS_MSG_REFS)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-IEN (Application Component) Integration Engine
     ⤷ SXMSJOB (Package) XI: Time-Driven Message Processing

Properties

Class	CL_XMS_MSG_REFS
Short Description
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SXMSJOB	XI: Time-Driven Message Processing
Created	20030422	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XMS_MSG_REFS has no forward declaration.

Interfaces

Class CL_XMS_MSG_REFS has no interface implemented.

Friends

Class CL_XMS_MSG_REFS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	_INSTANCE	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REFS			20030422
2	_PMI_ON	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20040601
3	_QUEUEING_SYSTEM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_QUEUEING_SYSTEM		Queueing System API	20091030

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_EO_QUEUE	Instance method	Public	Method	EO Message to Queue	20040817
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20040601
3	CREATE_MSGREF	Instance method	Public	Method	Generate Message Reference	20030422
4	DELETE_MSGREF	Instance method	Public	Method	Logical Deletion of Reference	20030512
5	DELETE_MSGREFS	Instance method	Public	Method	Logical Deletion of Reference	20041115
6	GET_DEL_PACK_MSGREF_FOR_PROC	Instance method	Public	Method	Returns the packaged message IDs	20050210
7	GET_EO_MSGREF	Instance method	Public	Method	All EO Message References for Job	20041115
8	GET_FOR_MSG_IDS	Instance method	Public	Method	All Data for Message ID List	20030722
9	GET_INSTANCE	Static method	Public	Method	Return Single Instance	20030422
10	GET_MSGREF	Instance method	Public	Method	Message References for Job ID	20030422
11	GET_MSGREF_FOR_MSGID	Instance method	Public	Method		20041115
12	GET_MSGREF_RANGES	Instance method	Public	Method		20041115
13	GET_MSG_COUNT_FOR_JOB	Instance method	Public	Method	Number of EO Message References for Job ID	20050308
14	GET_PACK_COUNT_FOR_FILTER	Instance method	Public	Method		20050308
15	GET_PACK_MSGREF_FOR_FILTER	Instance method	Public	Method	Returns the packaged message IDs	20041115
16	GET_PACK_MSGREF_FOR_PROCESS	Instance method	Public	Method	Returns the packaged message IDs	20041115
17	GET_PREP_FOR_PACK_MSG_COUNT	Instance method	Public	Method		20041116
18	GET_PROCESS_IDS_FOR_FILTER	Instance method	Public	Method		20041115
19	LOCK_PACKAGE	Instance method	Public	Method		20041115
20	SET_UNPACKED_MSGREF_TO_DELETED	Instance method	Public	Method	Logical Deletion of All EOIO Message References for Job ID	20050307
21	UNLOCK_PACKAGE	Instance method	Public	Method		20041115
22	UNPACK_BY_TIME	Instance method	Public	Method	Removes messages exceeding the time limit	20041115
23	UNPACK_FOR_FILTER	Instance method	Public	Method	Removes the packages for a filter	20041115
24	UNPACK_FOR_JOB	Instance method	Public	Method		20041115
25	UNPACK_FOR_MSGIDS	Instance method	Public	Method		20041115
26	UNPACK_PACKAGE	Instance method	Public	Method		20041115
27	VARIABLE_PHYS_DELETE	Instance method	Public	Method	Physical Deletion of Message References	20030722

Events

Class CL_XMS_MSG_REFS has no event.

Types

Class CL_XMS_MSG_REFS has no local type.

Method Signatures

Method ADD_EO_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGFIL	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_DEF			20040817
2	Importing	MSG_ID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		GUID für Objekte der Integration Engine	20040817
3	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20040818

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20040817

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_XMS_MSG_REFS has no parameter.
Method CONSTRUCTOR on class CL_XMS_MSG_REFS has no exception.

Method CREATE_MSGREF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE_REF	Call by reference	☐	Type reference (TYPE)	SXMSMSGREF			20030514
2	Returning	MSGREF	Value transfer	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REF			20030422

Method CREATE_MSGREF on class CL_XMS_MSG_REFS has no exception.

Method DELETE_MSGREF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID			20030512

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030512

Method DELETE_MSGREFS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGREF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_TTYP		XML Message Broker: Tabellentyp zur MessageGUID	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20041115

Method GET_DEL_PACK_MSGREF_FOR_PROC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROCESSID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		GUID für Objekte der Integration Engine	20050210
2	Returning	REF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_TTYP		TTYP for SXMS_MSGREF	20050210

Method GET_DEL_PACK_MSGREF_FOR_PROC on class CL_XMS_MSG_REFS has no exception.

Method GET_EO_MSGREF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMSJOB		Job-ID	20041115
2	Returning	MSGREF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_TTYP		Message Referenzen für einen Job	20041115

Method GET_EO_MSGREF on class CL_XMS_MSG_REFS has no exception.

Method GET_FOR_MSG_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MSGREF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_T			20030722
2	Importing	MSG_TAB	Call by reference	☐	Type reference (TYPE)	SXMSMSGTAB			20030722

Method GET_FOR_MSG_IDS on class CL_XMS_MSG_REFS has no exception.

Method GET_INSTANCE Signature

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

Method GET_INSTANCE on class CL_XMS_MSG_REFS has no exception.

Method GET_MSGREF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMSJOB			20030422
2	Returning	MSGREF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_TTYP			20030422

Method GET_MSGREF on class CL_XMS_MSG_REFS has no exception.

Method GET_MSGREF_FOR_MSGID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		GUID für Objekte der Integration Engine	20041115
2	Returning	MSGREF	Value transfer	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REF			20041115

Method GET_MSGREF_FOR_MSGID on class CL_XMS_MSG_REFS has no exception.

Method GET_MSGREF_RANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	JOBID_SEL	Call by reference	☐	Type reference (TYPE)	SXMS_JOBID_SEL_T		Select options Message ID	20041115
2	Importing	MSGID_SEL	Call by reference	☐	Type reference (TYPE)	SXMS_MSGID_SEL_T		Select options Message ID	20041115
3	Returning	MSGREF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_T		TTYP for SXMSMSGREF	20041115
4	Importing	PROCESSID_SEL	Call by reference	☐	Type reference (TYPE)	SXMS_PROCESSID_SEL_T		Select options Message ID	20041115
5	Importing	STATUS	Call by reference	☐	Type reference (TYPE)	SXMSMSGREFSTATUS		Status der Job-Verarbeitung	20041115

Method GET_MSGREF_RANGES on class CL_XMS_MSG_REFS has no exception.

Method GET_MSG_COUNT_FOR_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	SXMSNO_OF_MSGS			20050308
2	Importing	JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMSJOB			20050308

Method GET_MSG_COUNT_FOR_JOB on class CL_XMS_MSG_REFS has no exception.

Method GET_PACK_COUNT_FOR_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20050308
2	Importing	FILTER_ID	Call by reference	☐	Type reference (TYPE)	SXMSFILTERGUID		Filter-ID	20050308

Method GET_PACK_COUNT_FOR_FILTER on class CL_XMS_MSG_REFS has no exception.

Method GET_PACK_MSGREF_FOR_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILTER	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_PACK_FILTER		Filter-ID	20041115
2	Returning	REF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_TTYP		TTYP for SXMS_MSGREF	20041115

Method GET_PACK_MSGREF_FOR_FILTER on class CL_XMS_MSG_REFS has no exception.

Method GET_PACK_MSGREF_FOR_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROCESSID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		GUID für Objekte der Integration Engine	20041115
2	Returning	REF_TAB	Value transfer	☐	Type reference (TYPE)	SXMSMSGREF_TTYP		TTYP for SXMS_MSGREF	20041115

Method GET_PACK_MSGREF_FOR_PROCESS on class CL_XMS_MSG_REFS has no exception.

Method GET_PREP_FOR_PACK_MSG_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20041116
2	Importing	JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMSJOB		Job-ID	20041116

Method GET_PREP_FOR_PACK_MSG_COUNT on class CL_XMS_MSG_REFS has no exception.

Method GET_PROCESS_IDS_FOR_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILTER_ID	Call by reference	☐	Type reference (TYPE)	SXMSFILTERGUID		Filter-ID	20041115
2	Returning	PROCESSID_TAB	Value transfer	☐	Type reference (TYPE)	SXMS_PROCESS_ID_TTYP		TTYP for SXMSPROCESSID	20041115

Method GET_PROCESS_IDS_FOR_FILTER on class CL_XMS_MSG_REFS has no exception.

Method LOCK_PACKAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROCESSID	Call by reference	☐	Type reference (TYPE)	SXMSPROCESSID		Process ID for package processing	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20041115

Method SET_UNPACKED_MSGREF_TO_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILTERGUID	Call by reference	☐	Type reference (TYPE)	SXMSFILTERGUID		Filter-ID	20050307

Method SET_UNPACKED_MSGREF_TO_DELETED on class CL_XMS_MSG_REFS has no exception.

Method UNLOCK_PACKAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROCESSID	Call by reference	☐	Type reference (TYPE)	SXMSPROCESSID		Process ID for package processing	20041115

Method UNLOCK_PACKAGE on class CL_XMS_MSG_REFS has no exception.

Method UNPACK_BY_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOG	Value transfer	☑	Object reference (TYPE REF TO)	CL_XMS_LOG			20041115
2	Importing	MINUTES	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20041115
3	Importing	NOT_ASSIGNED	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20041115

Method UNPACK_FOR_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILTER	Call by reference	☐	Type reference (TYPE)	SXMSFILTERGUID		Filter-ID	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20041115

Method UNPACK_FOR_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMSJOB		Job-ID	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20041115

Method UNPACK_FOR_MSGIDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID_TAB	Call by reference	☐	Type reference (TYPE)	SXMSMGUIDT		XML Message Broker: Tabellentyp zur MessageGUID	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20041115

Method UNPACK_PACKAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROCESSID	Call by reference	☐	Type reference (TYPE)	SXMSPROCESSID		Process ID for package processing	20041115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20041115

Method VARIABLE_PHYS_DELETE Signature

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

Method VARIABLE_PHYS_DELETE on class CL_XMS_MSG_REFS has no exception.

History

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