SAP ABAP Class CL_XMS_PERSIST_HELPER (Persist Utilities)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-IEN (Application Component) Integration Engine
     ⤷ SSOAPERSIST (Package) SOA Persist Objects

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_XMS_PERSIST_CONST_BOOL	Boolean Constants	20061122

Properties

Class	CL_XMS_PERSIST_HELPER
Short Description	Persist Utilities
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SSOAPERSIST	SOA Persist Objects
Created	20061122	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XMS_PERSIST_HELPER has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_XMS_PERSIST_CONST_BOOL	☐	☐	Boolean Constants	20061122

Friends

Class CL_XMS_PERSIST_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_FALSE	Instance attribute	Private	☐	Attribute reference (LIKE)				20061122
2	CON_SPACE	Instance attribute	Private	☐	Attribute reference (LIKE)				20061122
3	CON_TRUE	Instance attribute	Private	☐	Attribute reference (LIKE)				20061122
4	CON_X	Instance attribute	Private	☐	Attribute reference (LIKE)				20061122

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_TABLE_ENTRY	Static method	Public	Method	Creates a Test Entry in the Database	20080310
2	DELETE_TABLE_ENTRY	Static method	Public	Method	Deletes a Test Entry in the Database	20080310
3	MAP_MESSAGE_ID_TO_PARENT_ID	Static method	Public	Method	Map MessageID to ParentID	20061122
4	MAP_PARENT_ID_TO_MESSAGE_ID	Static method	Public	Method	Map ParentID to MessageID	20061122
5	READ_DETAILS_VIA_MSGUID	Static method	Public	Method	Reads Status and Execution Timestamp of a List from MSGGUIDS	20070307
6	READ_DETAILS_VIA_MSGUIDS	Static method	Public	Method	Reads Status and Execution Timestamp of a List from MSGGUIDS	20070307
7	READ_MESSAGE_STATE	Static method	Public	Method	Set Message Status	20070202
8	READ_PID_AND_SEQ_VIA_PARENTMSG	Static method	Public	Method	Determines the Pipeline ID for a Specified Parent Message ID	20080410
9	READ_PID_VIA_MSGGUID	Static method	Public	Method	Determines the Pipeline ID for a Specified Message ID	20061122
10	READ_PID_VIA_PARENTMSG	Static method	Public	Method	Determines the Pipeline ID for a Specified Parent Message ID	20061214
11	READ_RESULT1_VIA_MSGGUID	Static method	Public	Method	Map Message IDs to (PipelineID, ParentID)	20061123
12	READ_RESULT2_VIA_MSGGUID	Static method	Public	Method	Map MessageIDs to (IIF, OIF)	20061126
13	SET_MANUALSTAT_FLAG	Static method	Public	Method	Set Manual Stat Flag	20090213
14	WRITE_MESSAGE_STATE	Static method	Public	Method	Set Message Status	20070202

Events

Class CL_XMS_PERSIST_HELPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_MSGGUID	Public	See coding		MessageID	20061123	BEGIN OF ty_msgguid, msgguid TYPE sxmsmguid, END OF ty_msgguid
2	TY_MSGGUIDS	Public	See coding		MessageIDs	20061123	ty_msgguids TYPE STANDARD TABLE OF ty_msgguid WITH DEFAULT KEY
3	TY_MSGGUID_PID_ITEM	Public	See coding			20061212	BEGIN OF ty_msgguid_pid_item, msgguid TYPE sxmsmguid, pid TYPE sxmspid, END OF ty_msgguid_pid_item
4	TY_MSGGUID_PID_ITEMS	Public	See coding			20061212	ty_msgguid_pid_items TYPE STANDARD TABLE OF ty_msgguid_pid_item WITH DEFAULT KEY
5	TY_MSGGUID_PID_QUEUEGUID_ITEM	Public	See coding			20080410	BEGIN OF ty_msgguid_pid_queueguid_item, msgguid TYPE sxmsmguid, pid TYPE sxmspid, queueguid TYPE sxmsqid, END OF ty_msgguid_pid_queueguid_item
6	TY_MSGGUID_PID_QUEUEGUID_ITEMS	Public	See coding			20080410	ty_msgguid_pid_queueguid_items TYPE STANDARD TABLE OF ty_msgguid_pid_queueguid_item WITH DEFAULT KEY
7	TY_RESULT1_ID	Public	See coding		(MsgID, Pipeline, ParentID, MsgStatus)	20061123	BEGIN OF ty_result1_id, msgguid TYPE sxmsmguid, pid TYPE sxmspid, parentmsg TYPE sxmsmguid, msgstate TYPE sxmspmstat, adminuser TYPE syuname, queueguid TYPE sxmsqid, END OF ty_result1_id
8	TY_RESULT1_IDS	Public	See coding		Table of (MsgID, Pipeline, ParentID, MsgStatus)	20061123	ty_result1_ids TYPE STANDARD TABLE OF ty_result1_id WITH NON-UNIQUE KEY msgguid
9	TY_RESULT2_ID	Public	See coding		(MsgID, IIF, OIF)	20061126	BEGIN OF ty_result2_id, msgguid TYPE sxmsmguid, pid TYPE sxmspid, ob_ns TYPE rm_oifns, ob_name TYPE rm_oifname, ib_ns TYPE rm_iifns, ib_name TYPE rm_iifname, parentmsg TYPE sxmsmguid, msgstate TYPE sxmspmstat, END OF ty_result2_id
10	TY_RESULT2_IDS	Public	See coding		Table of (MsgID,IIF, OIF)	20061126	ty_result2_ids TYPE STANDARD TABLE OF ty_result2_id WITH NON-UNIQUE KEY msgguid

Method Signatures

Method CREATE_TABLE_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PID	Call by reference	☐	Type reference (TYPE)	SXMSPID	'WS_TEST'	Integration Engine: Pipeline-ID	20080310
2	Returning	RE_MSG	Value transfer	☐	Type reference (TYPE)	SXMSGUID_S		logische persistierte Message	20080310

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20080310

Method DELETE_TABLE_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSG	Value transfer	☐	Type reference (TYPE)	SXMSGUID_S		logische persistierte Message	20080311

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20080310

Method MAP_MESSAGE_ID_TO_PARENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20061122
2	Importing	IM_PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20061122
3	Returning	RE_PARENT_ID	Value transfer	☐	Type reference (TYPE)	SXMSPARENTMSG_T		XI: Message-Id	20061122

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20061122

Method MAP_PARENT_ID_TO_MESSAGE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PARENT_ID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20061122
2	Importing	IM_PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20061122
3	Returning	RE_MSGGUID	Value transfer	☐	Type reference (TYPE)	SXMSMSG_T		XI: Message-Id	20061122

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20061122

Method READ_DETAILS_VIA_MSGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		Message Key per Parent Msg	20070307
2	Importing	IM_PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20070307
3	Returning	RE_DETAILS	Value transfer	☐	Type reference (TYPE)	SXMSPMAST		XML Message Broker: Message-Queue (Master)	20070307

Method READ_DETAILS_VIA_MSGUID on class CL_XMS_PERSIST_HELPER has no exception.

Method READ_DETAILS_VIA_MSGUIDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID_TAB	Call by reference	☐	Type reference (TYPE)	SXMS_MSG_PARENT_KEY_T		Message Key per Parent Msg	20070307
2	Returning	RE_DETAILS	Value transfer	☐	Type reference (TYPE)	SXMSPMAST_TAB		XML Message Broker: Message-Queue (Master)	20070307

Method READ_DETAILS_VIA_MSGUIDS on class CL_XMS_PERSIST_HELPER has no exception.

Method READ_MESSAGE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_MSGGUID_STATE_TAB	Call by reference	☐	Type reference (TYPE)	SXMS_MSG_KEY_AND_STATE_T		Integration Engine: Status einer Message	20070202
2	Importing	IM_MSGGUID_TAB	Call by reference	☐	Type reference (TYPE)	SXMSGUID_T		Message Key	20070202

Method READ_MESSAGE_STATE on class CL_XMS_PERSIST_HELPER has no exception.

Method READ_PID_AND_SEQ_VIA_PARENTMSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PARENTMSG	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20080410
2	Returning	RE_TAB	Value transfer	☐	Type reference (TYPE)	TY_MSGGUID_PID_QUEUEGUID_ITEMS			20080410

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20080410

Method READ_PID_VIA_MSGGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20061122
2	Returning	RE_PID_TAB	Value transfer	☐	Type reference (TYPE)	SXMSPID_T		Tabellen zur Pipeline-ID	20061122

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20061122

Method READ_PID_VIA_PARENTMSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PARENTMSG	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20061214
2	Returning	RE_PID_TAB	Value transfer	☐	Type reference (TYPE)	TY_MSGGUID_PID_ITEMS			20061214

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20061214

Method READ_RESULT1_VIA_MSGGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUIDS	Call by reference	☐	Type reference (TYPE)	TY_MSGGUIDS		XI: Message-Id	20061123
2	Returning	RE_RESULT	Value transfer	☐	Type reference (TYPE)	TY_RESULT1_IDS			20061123

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20061123

Method READ_RESULT2_VIA_MSGGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUIDS	Call by reference	☐	Type reference (TYPE)	TY_MSGGUIDS		XI: Message-Id	20061126
2	Returning	RE_RESULT	Value transfer	☐	Type reference (TYPE)	TY_RESULT2_IDS		Tabelle von (MsgID,IIF, OIF)	20061126

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20061126

Method SET_MANUALSTAT_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		GUID für Objekte der Integration Engine	20090213
2	Importing	IM_PID	Call by reference	☑	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20090213

Method SET_MANUALSTAT_FLAG on class CL_XMS_PERSIST_HELPER has no exception.

Method WRITE_MESSAGE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID_TAB	Call by reference	☐	Type reference (TYPE)	SXMSGUID_T		Message Key	20070202
2	Importing	IM_STATE	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Integration Engine: Status einer Message	20070202

#	Exception	Resumable	Description	Created on
1	CX_XMS_PERSIST	☐	XI: Systemfehler der Persist	20070202

History

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