SAP ABAP Class CL_XMS_PACK_FILTER (Packaging Filter)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_XMS_EOIO_MSG_DEF		20041115

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_XMS_EOIO_PACK_FILTER		20061023

Properties

Class	CL_XMS_PACK_FILTER
Short Description	Packaging Filter
Super Class	CL_XMS_EOIO_MSG_DEF
Instantiability of a Class	2	Public
Final	☐

General Data

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

Forward declarations

Class CL_XMS_PACK_FILTER has no forward declaration.

Interfaces

Class CL_XMS_PACK_FILTER has no interface implemented.

Friends

Class CL_XMS_PACK_FILTER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	_MESSAGE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_MESSAGE_XMB		Higher Layer Integration Engine Message Object	20041115
2	_MIN_SIZE	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Natural Number	20041115
3	_MSGCOUNT	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Natural Number	20041115
4	_QUEUEING_SYSTEM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_QUEUEING_SYSTEM		Queueing System API	20091103
5	_RECEIVER_MSG	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSMREC		Receiver and Message GUID of a Split Message	20041115

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_QUEUE	Instance method	Public	Method		20041115
2	ADJUST_MSGCOUNT	Instance method	Public	Method		20041115
3	ADJUST_MSGCOUNT_INT	Instance method	Public	Method		20041115
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20041115
5	CREATE_PACKAGES	Instance method	Protected	Method	Returns message packages of appropriate size	20041115
6	DECREASE_COUNT_BY	Instance method	Public	Method		20041115
7	ENTER_STOPQUEUE	Instance method	Public	Method		20041116
8	GET_MAXPACKSIZE	Instance method	Public	Method		20041115
9	GET_MSGCOUNT	Instance method	Public	Method		20041115
10	GET_SND_RCV_FROM_REF	Instance method	Protected	Method		20041115
11	INCREASE_COUNT	Instance method	Public	Method		20041115
12	LIMIT_REACHED	Instance method	Public	Method		20041115
13	LOCK_FOR_PROCESSING	Instance method	Public	Method		20041115
14	SET_MESSAGE	Instance method	Protected	Method		20041115
15	START_NOW	Instance method	Public	Method		20041115
16	UNLOCK_PROCESSING	Instance method	Public	Method		20041115
17	UNPACK	Instance method	Public	Method		20041115
18	UPDATE_COUNT	Instance method	Protected	Method		20041115
19	WRITE_PMAST	Instance method	Protected	Method		20041115
20	WRITE_PMI	Instance method	Protected	Method		20041115

Events

Class CL_XMS_PACK_FILTER has no event.

Types

Class CL_XMS_PACK_FILTER has no local type.

Method Signatures

Method ADD_TO_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALL	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20041115
2	Importing	LOG	Value transfer	☑	Object reference (TYPE REF TO)	CL_XMS_LOG			20041115
3	Returning	REF_TAB	Value transfer	☐	Type reference (TYPE)	SXMS_MSGID_EOREF_TTYP			20060922

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

Method ADJUST_MSGCOUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COUNT	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20041115

Method ADJUST_MSGCOUNT on class CL_XMS_PACK_FILTER has no exception.

Method ADJUST_MSGCOUNT_INT Signature

Method ADJUST_MSGCOUNT_INT on class CL_XMS_PACK_FILTER has no parameter.
Method ADJUST_MSGCOUNT_INT on class CL_XMS_PACK_FILTER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGDEFS	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_FILTERS_JOB			20041115
2	Importing	MSGDEF_WA	Call by reference	☐	Type reference (TYPE)	SXMSMSGDEF			20041115

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

Method CREATE_PACKAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALL	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20041115
2	Importing	IN_PACK	Call by reference	☐	Type reference (TYPE)	SXMSMSGREF_TTYP		Message Referenzen für einen Job	20041115
3	Returning	PACK_LIST	Value transfer	☐	Type reference (TYPE)	SXMS_PACK_LIST		List of packages	20041115

Method CREATE_PACKAGES on class CL_XMS_PACK_FILTER has no exception.

Method DECREASE_COUNT_BY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DELTA	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20041115

Method DECREASE_COUNT_BY on class CL_XMS_PACK_FILTER has no exception.

Method ENTER_STOPQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20041116

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

Method GET_MAXPACKSIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SIZE	Value transfer	☐	Type reference (TYPE)	SXMSMAXPACKSIZE		Maximum size of the message package	20041115

Method GET_MAXPACKSIZE on class CL_XMS_PACK_FILTER has no exception.

Method GET_MSGCOUNT 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	20041115

Method GET_MSGCOUNT on class CL_XMS_PACK_FILTER has no exception.

Method GET_SND_RCV_FROM_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGREF	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REF			20041115
2	Exporting	RECEIVER	Call by reference	☐	Type reference (TYPE)	SXI_FROMORTO		XI: Adresse (Party/Service) & Interface	20041115
3	Exporting	SENDER	Call by reference	☐	Type reference (TYPE)	SXI_FROMORTO		XI: Adresse (Party/Service) & Interface	20041115

Method GET_SND_RCV_FROM_REF on class CL_XMS_PACK_FILTER has no exception.

Method INCREASE_COUNT Signature

Method INCREASE_COUNT on class CL_XMS_PACK_FILTER has no parameter.
Method INCREASE_COUNT on class CL_XMS_PACK_FILTER has no exception.

Method LIMIT_REACHED Signature

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

Method LIMIT_REACHED on class CL_XMS_PACK_FILTER has no exception.

Method LOCK_FOR_PROCESSING Signature

Method LOCK_FOR_PROCESSING on class CL_XMS_PACK_FILTER has no parameter.

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

Method SET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGREF_WA	Call by reference	☐	Type reference (TYPE)	SXMSMSGREF		Message Referenz Ablage	20041115
2	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20041115

Method SET_MESSAGE on class CL_XMS_PACK_FILTER has no exception.

Method START_NOW Signature

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

Method START_NOW on class CL_XMS_PACK_FILTER has no exception.

Method UNLOCK_PROCESSING Signature

Method UNLOCK_PROCESSING on class CL_XMS_PACK_FILTER has no parameter.
Method UNLOCK_PROCESSING on class CL_XMS_PACK_FILTER has no exception.

Method UNPACK Signature

Method UNPACK on class CL_XMS_PACK_FILTER has no parameter.

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

Method UPDATE_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COUNT	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20041115

Method UPDATE_COUNT on class CL_XMS_PACK_FILTER has no exception.

Method WRITE_PMAST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGREF	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REF			20041115
2	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20041115
3	Importing	TID	Call by reference	☐	Type reference (TYPE)	SXMSREFVAL		eindeutige Transaktions-Id (LUW->COMMIT WORK).	20041115

Method WRITE_PMAST on class CL_XMS_PACK_FILTER has no exception.

Method WRITE_PMI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGREF	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REF			20041115
2	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20041115
3	Importing	TID	Call by reference	☐	Type reference (TYPE)	SXMSREFVAL		eindeutige Transaktions-Id (LUW->COMMIT WORK).	20041115

Method WRITE_PMI on class CL_XMS_PACK_FILTER has no exception.

History

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