SAP ABAP Class CL_XMS_HOP (XMS: Message Hop List)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-XI-IS-IEN (Application Component) Integration Engine
     SXMSF (Package) XI: Integration Engine Runtime
Properties
Class CL_XMS_HOP  
Short Description XMS: Message Hop List    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SXMSF   XI: Integration Engine Runtime 
Created 20020821   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_XMS_HOP has no forward declaration.
Interfaces
Class CL_XMS_HOP has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_XMS_HOPLIST 20020821 XMS: Message Hop List
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ADAPTER_REFID_IN Instance attribute Public Type reference (TYPE) SXMSADPCTX Integration Engine: Reference Value 20020823
2 ADAPTER_REFID_OUT Instance attribute Public Type reference (TYPE) SXMSADPCTX Integration Engine: Reference Value 20020823
3 ADAPTER_TYPE_IN Instance attribute Public Type reference (TYPE) SXMSPSTYPE Pipeline Service Type 20020823
4 ADAPTER_TYPE_OUT Instance attribute Public Type reference (TYPE) SXMSPSTYPE Pipeline Service Type 20020823
5 BRANCH_LIST Instance attribute Private Type reference (TYPE) SXMSBRANCT Table of Branches from Message Split 20020823
6 CO_ATT_AD_TYPE Constant Public Type reference (TYPE) STRING 'Type' Attribute Name 20020821
7 CO_ATT_BRANCH_ID Constant Public Type reference (TYPE) STRING 'MessageId' Attribute Name 20020821
8 CO_ATT_BRANCH_NUM Constant Public Type reference (TYPE) STRING 'Number' Attribute Name 20020823
9 CO_ATT_BRANCH_QOS Constant Public Type reference (TYPE) STRING 'QualityOfService' Attribute Name 20020821
10 CO_ATT_BRANCH_RECVBS Constant Public Type reference (TYPE) STRING 'RecvBusinessSystem' 20031202
11 CO_ATT_HOPNUMBER Constant Public Type reference (TYPE) STRING 'HopNumber' Attribute Name 20020821
12 CO_ATT_SYSTEMNAME Constant Public Type reference (TYPE) STRING 'SystemName' Attribute Name 20020821
13 CO_ATT_TIMESTAMP Constant Public Type reference (TYPE) STRING 'TimeStamp' Attribute Name 20020821
14 CO_ATT_TYPE Constant Public Type reference (TYPE) STRING 'Type' Attribute Name 20020823
15 CO_ATT_WASREAD Constant Public Type reference (TYPE) STRING 'WasRead' Attribute Name 20020821
16 CO_PATH_BRANCH Constant Public Type reference (TYPE) STRING 'Hop/Branch' XML Path 20030425
17 CO_PATH_INBOUND Constant Public Type reference (TYPE) STRING 'Hop/MessageInbound' XML Path 20030425
18 CO_PATH_INBOUND_ADREFID Constant Public Type reference (TYPE) STRING 'Hop/MessageInbound/AdapterRefId' XML Path 20030425
19 CO_PATH_INBOUND_ADTYPE Constant Public Type reference (TYPE) STRING 'Hop/MessageInbound/Type' XML Path 20030425
20 CO_PATH_INBOUND_MSGID Constant Public Type reference (TYPE) STRING 'Hop/MessageInbound/MessageId' XML Path 20030425
21 CO_PATH_OUTBOUND Constant Public Type reference (TYPE) STRING 'Hop/MessageOutbound' XML Path 20030425
22 CO_PATH_OUTBOUND_ADREFID Constant Public Type reference (TYPE) STRING 'Hop/MessageOutbound/AdapterRefId' XML Path 20030425
23 CO_PATH_OUTBOUND_ADTYPE Constant Public Type reference (TYPE) STRING 'Hop/MessageOutbound/Type' XML Path 20030425
24 CO_PATH_OUTBOUND_MSGID Constant Public Type reference (TYPE) STRING 'Hop/MessageOutbound/MessageId' XML Path 20030425
25 CO_TAG_ADREFID Constant Public Type reference (TYPE) STRING 'AdapterRefId' Tag Name 20020830
26 CO_TAG_ADREF_IN Constant Public Type reference (TYPE) STRING 'AdapterRefInbound' Tag Name 20020821
27 CO_TAG_ADREF_OUT Constant Public Type reference (TYPE) STRING 'AdapterRefOutbound' Tag Name 20020821
28 CO_TAG_ADTYPE Constant Public Type reference (TYPE) STRING 'Type' Tag Name 20020830
29 CO_TAG_BRANCH Constant Public Type reference (TYPE) STRING 'Branch' Tag Name 20020821
30 CO_TAG_HOP Constant Public Type reference (TYPE) STRING 'Hop' Tag Name 20020821
31 CO_TAG_INBOUND Constant Public Type reference (TYPE) STRING 'MessageInbound' Tag Name 20020830
32 CO_TAG_MSGGUID Constant Public Type reference (TYPE) STRING 'MessageId' Tag Name 20020830
33 CO_TAG_MSGGUID_IN Constant Public Type reference (TYPE) STRING 'MessageIdInbound' Tag Name 20020821
34 CO_TAG_MSGGUID_OUT Constant Public Type reference (TYPE) STRING 'MessageIdOutbound' Tag Name 20020821
35 CO_TAG_OUTBOUND Constant Public Type reference (TYPE) STRING 'MessageOutbound' Tag Name 20020830
36 CURRENT_BRANCH Instance attribute Public Type reference (TYPE) SXMSBRANCH Branch Description Following Message Split 20020823
37 HOPNUMBER Instance attribute Public Type reference (TYPE) SXMSHOPCNT Number of Integration Engine Performing Processing 20020823
38 LCNAME Constant Public Type reference (TYPE) STRING 'Hop' Name Space URI 20020821
39 MSGGUID_IN Instance attribute Public Type reference (TYPE) SXMSMGUID Integration Engine: Message ID 20020821
40 MSGGUID_OUT Instance attribute Public Type reference (TYPE) SXMSMGUID Integration Engine: Message ID 20020821
41 MSG_IN_TYPE Instance attribute Public Type reference (TYPE) SXMSPSTYPE Pipeline Service Type 20020829
42 MSG_OUT_TYPE Instance attribute Public Type reference (TYPE) SXMSPSTYPE Pipeline Service Type 20020829
43 MUSTUNDERSTAND Instance attribute Private Type reference (TYPE) SXMSFLAG Integration Engine: Flag (True/False) 20020821
44 NSURI Constant Public Type reference (TYPE) STRING 'http://sap.com/exchange/MessageFormat/Hop' Name Space URI 20020821
45 SYSTEMNAME Instance attribute Public Type reference (TYPE) PRX_SYSTEM Sending System 20020823
46 TIMESTAMP Instance attribute Public Type reference (TYPE) TIMESTAMP UTC time stamp in long form (YYYYMMDDhhmmssmmmuuun) 20020821
47 TYPE Instance attribute Public Type reference (TYPE) SXMSPID Integration Engine: Pipeline ID 20020823
48 WASREAD Instance attribute Public Type reference (TYPE) SXMSFLAG Integration Engine: Flag (True/False) 20020821
Methods
# Method Level Visibility Method type Description Created on
1 CREATE_BRANCH Instance method Protected Method Adds Message Branch 20020823
2 DEL_BRANCH_LIST Instance method Protected Method Deletes all message branches 20020823
3 GET_ADAPTER_REFID_IN Instance method Protected Method Gets adapter reference value (inbound) 20020823
4 GET_ADAPTER_REFID_OUT Instance method Protected Method Gets adapter reference value (outbound) 20020823
5 GET_ADAPTER_TYPE_IN Instance method Protected Method Gets adapter type value (inbound) 20020823
6 GET_ADAPTER_TYPE_OUT Instance method Protected Method Gets adapter type value (outbound) 20020823
7 GET_BRANCH_FIRST Instance method Protected Method Imports first branch in 'CURRENT_BRANCH' 20020823
8 GET_BRANCH_MSGGUID Instance method Protected Method Gets MsgGuid of branch in 'CURRENT_BRANCH' 20020823
9 GET_BRANCH_NEXT Instance method Protected Method Imports next branch in 'CURRENT_BRANCH' 20020823
10 GET_BRANCH_NUMBER Instance method Protected Method Gets number of branch in 'CURRENT_BRANCH' 20020823
11 GET_BRANCH_QOS Instance method Protected Method Gets QoS of branch in 'CURRENT_BRANCH' 20020823
12 GET_BRANCH_RECVBS Instance method Protected Method 20031202
13 GET_HOPNUMBER Instance method Protected Method Gets object key 'HOPNUMBER' 20020823
14 GET_MSGGUID_IN Instance method Protected Method Gets Message GUID (Inbound) 20020821
15 GET_MSGGUID_OUT Instance method Protected Method Gets Message GUID (Outbound) 20020821
16 GET_NUMBER_OF_BRANCHES Instance method Protected Method Gets Number of Branches 20020823
17 GET_SYSTEMNAME Instance method Protected Method Gets Object Key 'SYSTEMNAME' 20020823
18 GET_TIMESTAMP Instance method Protected Method Gets Time Stamp 20020821
19 GET_TYPE Instance method Protected Method Gets Object Key 'ROLE' 20020823
20 GET_WASREAD Instance method Protected Method Gets Read-Flag 20020821
21 READFROMXMLSTRING Instance method Protected Method Parses XML string and initializes object contents 20020830
22 SET_ADAPTER_REFID_IN Instance method Protected Method Sets adapter reference value (inbound) 20020823
23 SET_ADAPTER_REFID_OUT Instance method Protected Method Sets adapter reference value (outbound) 20020823
24 SET_ADAPTER_TYPE_IN Instance method Protected Method Sets adapter type value (inbound) 20020823
25 SET_ADAPTER_TYPE_OUT Instance method Protected Method Sets adapter type value on outbound side 20020823
26 SET_HOPNUMBER Instance method Protected Method Sets object key 'HOPNUMBER' 20020823
27 SET_MSGGUID_IN Instance method Protected Method Sets message GUID on inbound side 20020821
28 SET_MSGGUID_OUT Instance method Protected Method Sets message GUID on outbound side 20020821
29 SET_SYSTEMNAME Instance method Protected Method Sets object key 'SYSTEMNAME' 20020823
30 SET_TIMESTAMP Instance method Protected Method Sets time stamp 20020821
31 SET_TIMESTAMP_OF_NOW Instance method Protected Method Sets time stamp to current time 20020827
32 SET_TYPE Instance method Protected Method Sets object key 'ROLE' 20020823
33 SET_WASREAD Instance method Protected Method Sets read flag 20020821
34 WRITETOXMLSTRING Instance method Protected Method Renders object contents in an XML string 20020830
Events
Class CL_XMS_HOP has no event.
Types
Class CL_XMS_HOP has no local type.
Method Signatures

Method CREATE_BRANCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting BRANCH_NUMBER Value transfer Type reference (TYPE) SXMSHOPCNT Integration Engine: Quality of Service 20020826
2 Importing MSGGUID Value transfer Type reference (TYPE) SXMSMGUID Integration Engine: Message-ID 20020823
3 Importing QOS Value transfer Type reference (TYPE) SXMSQOS Integration Engine: Quality of Service 20020823
4 Importing RECVBS Value transfer Type reference (TYPE) PRX_SYSTEM 20031202

Method CREATE_BRANCH on class CL_XMS_HOP has no exception.

Method DEL_BRANCH_LIST Signature

Method DEL_BRANCH_LIST on class CL_XMS_HOP has no parameter.
Method DEL_BRANCH_LIST on class CL_XMS_HOP has no exception.

Method GET_ADAPTER_REFID_IN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ADAPTER_REFID Value transfer Type reference (TYPE) SXMSADPCTX Integration Engine: Referenzwert 20020823

Method GET_ADAPTER_REFID_IN on class CL_XMS_HOP has no exception.

Method GET_ADAPTER_REFID_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ADAPTER_REFID Value transfer Type reference (TYPE) SXMSADPCTX Integration Engine: Referenzwert 20020823

Method GET_ADAPTER_REFID_OUT on class CL_XMS_HOP has no exception.

Method GET_ADAPTER_TYPE_IN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ADAPTER_TYPE Value transfer Type reference (TYPE) SXMSPSTYPE Typ eines Pipeline-Services 20020823

Method GET_ADAPTER_TYPE_IN on class CL_XMS_HOP has no exception.

Method GET_ADAPTER_TYPE_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ADAPTER_TYPE Value transfer Type reference (TYPE) SXMSPSTYPE 20020823

Method GET_ADAPTER_TYPE_OUT on class CL_XMS_HOP has no exception.

Method GET_BRANCH_FIRST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BRANCH_NUMBER Value transfer Type reference (TYPE) SXMSHOPCNT Nummer der bearbeitenden Integration Engine 20020823

Method GET_BRANCH_FIRST on class CL_XMS_HOP has no exception.

Method GET_BRANCH_MSGGUID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning MSGGUID Value transfer Type reference (TYPE) SXMSMGUID Integration Engine: Message-ID 20020823

Method GET_BRANCH_MSGGUID on class CL_XMS_HOP has no exception.

Method GET_BRANCH_NEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BRANCH_NUMBER Value transfer Type reference (TYPE) SXMSHOPCNT Nummer der bearbeitenden Integration Engine 20020823

Method GET_BRANCH_NEXT on class CL_XMS_HOP has no exception.

Method GET_BRANCH_NUMBER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BRANCH_NUMBER Value transfer Type reference (TYPE) SXMSHOPCNT Nummer der bearbeitenden Integration Engine 20020823

Method GET_BRANCH_NUMBER on class CL_XMS_HOP has no exception.

Method GET_BRANCH_QOS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning QOS Value transfer Type reference (TYPE) SXMSQOS Integration Engine: Quality of Service 20020823

Method GET_BRANCH_QOS on class CL_XMS_HOP has no exception.

Method GET_BRANCH_RECVBS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RECVBS Value transfer Type reference (TYPE) PRX_SYSTEM 20031202

Method GET_BRANCH_RECVBS on class CL_XMS_HOP has no exception.

Method GET_HOPNUMBER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning HOPNUMBER Value transfer Type reference (TYPE) SXMSHOPCNT Nummer der bearbeitenden Integration Engine 20020823

Method GET_HOPNUMBER on class CL_XMS_HOP has no exception.

Method GET_MSGGUID_IN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning MSGGUID Value transfer Type reference (TYPE) SXMSMGUID Integration Engine: Message-ID 20020821

Method GET_MSGGUID_IN on class CL_XMS_HOP has no exception.

Method GET_MSGGUID_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning MSGGUID Value transfer Type reference (TYPE) SXMSMGUID Integration Engine: Message-ID 20020821

Method GET_MSGGUID_OUT on class CL_XMS_HOP has no exception.

Method GET_NUMBER_OF_BRANCHES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NUMBER_OF_BRANCHES Value transfer Type reference (TYPE) SXMSHOPCNT Nummer der bearbeitenden Integration Engine 20020823

Method GET_NUMBER_OF_BRANCHES on class CL_XMS_HOP has no exception.

Method GET_SYSTEMNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SYSTEMNAME Value transfer Type reference (TYPE) PRX_SYSTEM 20020823

Method GET_SYSTEMNAME on class CL_XMS_HOP has no exception.

Method GET_TIMESTAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TIMESTAMP Value transfer Type reference (TYPE) TIMESTAMP UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun) 20020821

Method GET_TIMESTAMP on class CL_XMS_HOP has no exception.

Method GET_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TYPE Value transfer Type reference (TYPE) SXMSPID Integration Engine: Pipeline-ID 20020823

Method GET_TYPE on class CL_XMS_HOP has no exception.

Method GET_WASREAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning WASREAD Value transfer Type reference (TYPE) SXMSFLAG Integration Engine: Flag (true/false) 20020821

Method GET_WASREAD on class CL_XMS_HOP has no exception.

Method READFROMXMLSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_PREFIX Call by reference Type reference (TYPE) STRING Tag Prefix 20020830
2 Importing IM_STRING Call by reference Type reference (TYPE) STRING Eingangs-String 20020830

Method READFROMXMLSTRING on class CL_XMS_HOP has no exception.

Method SET_ADAPTER_REFID_IN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ADAPTER_REFID Value transfer Type reference (TYPE) SXMSADPCTX Integration Engine: Referenzwert 20020823

Method SET_ADAPTER_REFID_IN on class CL_XMS_HOP has no exception.

Method SET_ADAPTER_REFID_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ADAPTER_REFID Value transfer Type reference (TYPE) SXMSADPCTX Integration Engine: Referenzwert 20020823

Method SET_ADAPTER_REFID_OUT on class CL_XMS_HOP has no exception.

Method SET_ADAPTER_TYPE_IN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ADAPTER_TYPE Value transfer Type reference (TYPE) SXMSPSTYPE 20020823

Method SET_ADAPTER_TYPE_IN on class CL_XMS_HOP has no exception.

Method SET_ADAPTER_TYPE_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ADAPTER_TYPE Value transfer Type reference (TYPE) SXMSPSTYPE 20020823

Method SET_ADAPTER_TYPE_OUT on class CL_XMS_HOP has no exception.

Method SET_HOPNUMBER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HOPNUMBER Value transfer Type reference (TYPE) SXMSHOPCNT Nummer der bearbeitenden Integration Engine 20020823

Method SET_HOPNUMBER on class CL_XMS_HOP has no exception.

Method SET_MSGGUID_IN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MSGGUID Value transfer Type reference (TYPE) SXMSMGUID Integration Engine: Message-ID 20020821

Method SET_MSGGUID_IN on class CL_XMS_HOP has no exception.

Method SET_MSGGUID_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MSGGUID Value transfer Type reference (TYPE) SXMSMGUID Integration Engine: Message-ID 20020821

Method SET_MSGGUID_OUT on class CL_XMS_HOP has no exception.

Method SET_SYSTEMNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SYSTEMNAME Call by reference Type reference (TYPE) PRX_SYSTEM 20020823

Method SET_SYSTEMNAME on class CL_XMS_HOP has no exception.

Method SET_TIMESTAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing TIMESTAMP Value transfer Type reference (TYPE) TIMESTAMP 20020827

Method SET_TIMESTAMP on class CL_XMS_HOP has no exception.

Method SET_TIMESTAMP_OF_NOW Signature

Method SET_TIMESTAMP_OF_NOW on class CL_XMS_HOP has no parameter.
Method SET_TIMESTAMP_OF_NOW on class CL_XMS_HOP has no exception.

Method SET_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing TYPE Value transfer Type reference (TYPE) SXMSPID Integration Engine: Pipeline-ID 20020823

Method SET_TYPE on class CL_XMS_HOP has no exception.

Method SET_WASREAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing WASREAD Value transfer Type reference (TYPE) SXMSFLAG Integration Engine: Flag (true/false) 20020821

Method SET_WASREAD on class CL_XMS_HOP has no exception.

Method WRITETOXMLSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_STRING Value transfer Type reference (TYPE) STRING 20020830
2 Importing IM_PREFIX Call by reference Type reference (TYPE) STRING 20020830

Method WRITETOXMLSTRING on class CL_XMS_HOP has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 620