SAP ABAP Class CL_SWF_XI_SRV_OUTBOUND (Superclass for ccBPM Outbound Service Provider)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-XI-IS-BPE (Application Component) Business Process Engine
     SWF_XI_ADAPTER (Package) Workflow Adapter for XI
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  BI_OBJECT Business Instance 20060317
2 Interface implementation (CLASS c. INTERFACES i_ref)  BI_PERSISTENT Persistent Business Instance 20060317
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SWF_TSI_SERVICE_PROVIDER TSI: Service Provider Interface 20060621
4 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SWF_WFM_SVC_OBJECTS Use of objects in service providers 20060621
5 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SWF_WFM_TSI_SERVICE TSI service provider with utilities for WFM integration 20060621
6 Interface implementation (CLASS c. INTERFACES i_ref)  IF_WORKFLOW Business Workflow 20060317
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_SWF_XI_SRV_ROUTING Receiver Determination Service 20060313
2 Inheritance (c INHERITING FROM c_ref)  CL_SWF_XI_SRV_SEND_ACK Service for Sending Acknowledgment 20060313
3 Inheritance (c INHERITING FROM c_ref)  CL_SWF_XI_SRV_SEND_ASYNCHRON Service for Sending Message Asynchronously 20060317
4 Inheritance (c INHERITING FROM c_ref)  CL_SWF_XI_SRV_SEND_SYNCHRON Service for Sending Message Synchronously 20060720
5 Inheritance (c INHERITING FROM c_ref)  CL_SWF_XI_SRV_TRANSFORMATION Mapping 20060314
Properties
Class CL_SWF_XI_SRV_OUTBOUND  
Short Description Superclass for ccBPM Outbound Service Provider    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SWF_XI_ADAPTER   Workflow Adapter for XI 
Created 20060313   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 IF_SWF_WFM_TSI_SERVICE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 BI_OBJECT Business Instance 20060317
2 BI_PERSISTENT Persistent Business Instance 20060317
3 IF_SWF_TSI_SERVICE_PROVIDER TSI: Service Provider Interface 20060621
4 IF_SWF_WFM_SVC_OBJECTS Use of objects in service providers 20060621
5 IF_SWF_WFM_TSI_SERVICE TSI service provider with utilities for WFM integration 20060621
6 IF_WORKFLOW Business Workflow 20060317
Friends
Class CL_SWF_XI_SRV_OUTBOUND has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MC_COMPONENT_MAPPING Constant Protected Type reference (TYPE) SYMSGV 'MAPPING' Message Variable 20060531
2 MC_COMPONENT_XI_INSTANCE Constant Protected Type reference (TYPE) SYMSGV 'BPE_XI_INSTANCE' Message Variable 20060531
3 MC_COMPONENT_XMSMAIN Constant Protected Type reference (TYPE) SYMSGV 'MESSAGING_SXMSF' Message Variable 20060531
4 MC_COMPONENT_XMSPERSIST Constant Protected Type reference (TYPE) SYMSGV 'MESSAGING_SXMSPERSIST' Message Variable 20060531
5 MC_EXCEPTION_TSI_SP Constant Protected Type reference (TYPE) STRING 'TSI_SP' 20060314
6 MC_EXCEPTION_TSI_SP_ABORT Constant Protected Type reference (TYPE) STRING 'TSI_SP_ABORT' 20070621
7 MC_RECEIVER_TYPE_RECEIVERS Constant Protected Type reference (TYPE) SWFDXISRECTYP 'REC' Type of Receiver Handling When Sending 20060720
8 MC_RECEIVER_TYPE_REPLY_TO Constant Protected Type reference (TYPE) SWFDXISRECTYP 'RTM' Type of Receiver Handling When Sending 20060720
9 MC_SENDCONTEXT_NAME Constant Private Type reference (TYPE) STRING 'ProcessStep' 20060313
10 MC_SENDCONTEXT_NAMESPACE Constant Private Type reference (TYPE) STRING 'http://sap.com/xi/XI/System' 20060313
11 MC_SEND_ACK_APPLICATION Constant Protected Type reference (TYPE) SWFDXISDAK 'APPL' XI: Sender Confirmation 20060720
12 MC_SEND_ACK_TRANSPORT Constant Protected Type reference (TYPE) SWFDXISDAK 'TRANS' XI: Sender Confirmation 20060720
13 MT_USED_MESSAGES Instance attribute Private Type reference (TYPE) TTY_USED_MESSAGES Messages Used 20060621
14 MT_USED_OBJECTS Instance attribute Private Type reference (TYPE) TTY_USED_OBJECTS 20090213
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_RECEIVERS Instance method Protected Method Check Recipient 20090128
2 COPY_MESSAGE Instance method Protected Method Create Identical Message in a New Object 20060822
3 CREATE_EXCEPTION Instance method Protected Method Generates an exception 20060313
4 GET_MESSAGE_XMB Instance method Protected Method Gets XI Message Handle for Specified POR or XML Instance 20060313
5 INSERT_MESSAGES Instance method Protected Method Save Messages 20070404
6 PREPARE_MESSAGE Instance method Protected Method Sets message fields as per guidelines 20060720
7 PREPARE_RECEIVERS Instance method Protected Method Set Receiver 20060720
8 PREPARE_SENDER_INTERFACE Instance method Protected Method Sets sender and sender interface 20060720
9 REGISTER_USED_MESSAGES Instance method Protected Method Registers message or messages for IF_SWF_WFM_SVC_OBJECTS 20060621
10 REGISTER_USED_OBJECTS Instance method Protected Method Registers objects for IF_SWF_WFM_SVC_OBJECTS 20090213
11 RESET_USED_MESSAGES Instance method Protected Method Resets list of objects used 20060621
12 RESET_USED_OBJECTS Instance method Protected Method Resets list of objects used 20090213
13 REVERT_CHANGES Instance method Protected Method Undoes changes to message handle 20060720
14 SEND_MESSAGES Instance method Protected Method Send Messages (by bulk if possible) 20070404
15 SEND_NOTIFICATION Instance method Protected Method Send Confirmation of Sending of Message (PMI) 20060922
16 SET_PROCESS_CONTEXT Instance method Protected Method Sets Process Context on Message Handle 20060313
Events
Class CL_SWF_XI_SRV_OUTBOUND has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TTY_MESSAGES Protected See coding 20070404 tty_messages TYPE TABLE OF ty_message
2 TTY_USED_MESSAGES Private See coding 20060621 TTY_USED_MESSAGES TYPE STANDARD TABLE OF TY_USED_MESSAGES WITH KEY method_name
3 TTY_USED_OBJECTS Private See coding 20090213 TTY_USED_OBJECTS TYPE STANDARD TABLE OF TY_USED_OBJECTS WITH KEY method_name
4 TY_BEFORE_IMAGE Protected See coding 20060720 BEGIN OF ty_before_image, queue_id TYPE sxmsqid, message_id TYPE sxmsmguid, procmode TYPE sxmsprocmode, message_class TYPE sxmsmsgcl, qos TYPE sxmsqos, app_ack_req TYPE sxmsflag, app_err_ack_req TYPE sxmsflag, sys_ack_req TYPE sxmsflag, sys_err_ack_req TYPE sxmsflag, conv_id TYPE sxmsconvid, refval_inbound TYPE sxmsrefval, refid_inbound TYPE sxmsrefid, sender TYPE sxi_fromorto, context TYPE rmt_context, receivers TYPE sxi_tos, ref_to_message_id TYPE sxmsmguid, skip_recv_determ TYPE sxmsflag, receiver TYPE sxi_fromorto, END OF ty_before_image
5 TY_CHANGE_LIST Protected See coding 20060720 BEGIN OF ty_change_list, * prepare_receivers receivers TYPE sxi_addresses, receiver_type TYPE swfdxisrectyp, replytomessage TYPE REF TO cl_swf_xi_message, sendcontext TYPE swf_string, * prepare_sender_interface: is a before_image value, so no need to record * sender TYPE sxi_fromorto, * prepare_message message_id TYPE sxmsmguid, queue_id TYPE sxmsqid, qos TYPE sxmsqos, procmode TYPE sxmsprocmode, message_class TYPE sxmsmsgcl, acknowledgement TYPE swfdxisdak, conv_id TYPE sxmsconvid, refval_inbound TYPE sxmsrefval, pp_data TYPE swfxippdata, userinfo_guid TYPE userinfo_guid, END OF ty_change_list
6 TY_MESSAGE Protected See coding 20070404 BEGIN OF ty_message, message_xmb TYPE REF TO if_xms_message_xmb, xi_instance TYPE REF TO cl_swf_xi_instance, END OF ty_message
7 TY_USED_MESSAGES Private See coding 20060621 BEGIN OF TY_USED_MESSAGES, method_name TYPE if_swf_wfm_tsi_service=>ty_method_name, messages TYPE sibflport, END OF TY_USED_MESSAGES
8 TY_USED_OBJECTS Private See coding 20090213 BEGIN OF TY_USED_OBJECTS, method_name TYPE if_swf_wfm_tsi_service=>ty_method_name, objects TYPE sibflport, END OF TY_USED_OBJECTS
Method Signatures

Method CHECK_RECEIVERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_RECEIVERS Call by reference Type reference (TYPE) SXI_ADDRESSES Tabelle von Adressen 20090128
2 Importing IM_RECEIVER_TYPE Call by reference Type reference (TYPE) SWFDXISRECTYP Art der Empfängerbehandlung beim Senden 20090128
3 Importing IM_REPLYTOMESSAGE Call by reference Object reference (TYPE REF TO) CL_SWF_XI_MESSAGE Nachricht, auf die geantwortet wird 20090128
4 Importing IM_SENDCONTEXT Call by reference Type reference (TYPE) SWF_STRING Sendekontext 20090128
# Exception Resumable Description Created on
1 CX_SWF_XI_EXCEPTION 20090128

Method COPY_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Originalmessage 20060822
2 Returning RE_MESSAGE_XMB_COPY Value transfer Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Neues Objekt mit identischem Inhalt 20060822

Method COPY_MESSAGE on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method CREATE_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MSGID Call by reference Type reference (TYPE) SYMSGID 'SWF_XI_ADAPTER' Nachrichtenklasse 20060313
2 Importing IM_MSGNO Call by reference Type reference (TYPE) SYMSGNO Nachrichtennummer 20060313
3 Importing IM_MSGTY Call by reference Type reference (TYPE) SYMSGTY 'E' Nachrichtentyp 20060313
4 Importing IM_MSGV1 Call by reference Type reference (TYPE) SYMSGV Nachrichtenvariable 20060313
5 Importing IM_MSGV2 Call by reference Type reference (TYPE) SYMSGV Nachrichtenvariable 20060313
6 Importing IM_MSGV3 Call by reference Type reference (TYPE) SYMSGV Nachrichtenvariable 20060313
7 Importing IM_MSGV4 Call by reference Type reference (TYPE) SYMSGV Nachrichtenvariable 20060313
8 Importing IM_PREVIOUS Call by reference Object reference (TYPE REF TO) CX_ROOT Abstrakte Oberklasse aller globalen Exceptions 20060313
9 Importing IM_TYPE Call by reference Type reference (TYPE) STRING MC_EXCEPTION_TSI_SP Typ der Exception 20060314
10 Returning RE_EXCEPTION Value transfer Object reference (TYPE REF TO) CX_ROOT Abstrakte Oberklasse aller globalen Exceptions 20060720

Method CREATE_EXCEPTION on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method GET_MESSAGE_XMB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Message als XI Handle 20060313
2 Exporting EX_XI_INSTANCE Call by reference Object reference (TYPE REF TO) CL_SWF_XI_INSTANCE XI Instanz 20060313
3 Importing IM_XI_MESSAGE Call by reference Object reference (TYPE REF TO) CL_SWF_XI_MESSAGE Message als XML-Instanz 20060313

Method GET_MESSAGE_XMB on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method INSERT_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGES Call by reference Type reference (TYPE) TTY_MESSAGES zu speichernde Messages 20070404
# Exception Resumable Description Created on
1 CX_SWF_XI_EXCEPTION XI-Ausnahme 20070404
2 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20070404

Method PREPARE_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CH_BEFORE_IMAGE Call by reference Type reference (TYPE) TY_BEFORE_IMAGE 20060720
2 Importing IM_ACKNOWLEDGEMENT Call by reference Type reference (TYPE) SWFDXISDAK Zu setzender Ack-Typ 20060720
3 Importing IM_CONV_ID Call by reference Type reference (TYPE) SXMSCONVID Zu setzende Conversation-Id 20060720
4 Importing IM_MESSAGE_CLASS Call by reference Type reference (TYPE) SXMSMSGCL Zu setzende Nachrichtenklasse 20060720
5 Importing IM_MESSAGE_ID Call by reference Type reference (TYPE) SXMSMGUID Zu setzende Message-Id 20060720
6 Importing IM_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Message, deren Felder gesetzt werden 20060720
7 Importing IM_PROCMODE Call by reference Type reference (TYPE) SXMSPROCMODE Zu setzender Processing Mode 20060720
8 Importing IM_QOS Call by reference Type reference (TYPE) SXMSQOS IF_XMS_MESSAGE_XMB=>CO_QOS_EXACTLY_ONCE Zu setzende Quality-of-Service, falls IM_QUEUE_ID = space 20060720
9 Importing IM_QUEUE_ID Call by reference Type reference (TYPE) SXMSQID Zu setzende Queue-ID (bestimmt auch QoS) 20060720
10 Importing IM_REFVAL_INBOUND Call by reference Type reference (TYPE) SXMSREFVAL Zu setzendes Inbound-Handle 20060720

Method PREPARE_MESSAGE on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method PREPARE_RECEIVERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CH_BEFORE_IMAGE Call by reference Type reference (TYPE) TY_BEFORE_IMAGE 20060720
2 Importing IM_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Message, deren Empfänger gesetzt werden 20060720
3 Importing IM_RECEIVERS Call by reference Type reference (TYPE) SXI_ADDRESSES Tabelle von Adressen 20060720
4 Importing IM_RECEIVER_TYPE Call by reference Type reference (TYPE) SWFDXISRECTYP Art der Empfängerbehandlung beim Senden 20060720
5 Importing IM_REPLYTOMESSAGE Call by reference Object reference (TYPE REF TO) CL_SWF_XI_MESSAGE Nachricht, auf die geantwortet wird 20060720
6 Importing IM_SENDCONTEXT Call by reference Type reference (TYPE) SWF_STRING Sendekontext 20060720
# Exception Resumable Description Created on
1 CX_SWF_XI_EXCEPTION 20060720

Method PREPARE_SENDER_INTERFACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CH_BEFORE_IMAGE Call by reference Type reference (TYPE) TY_BEFORE_IMAGE 20060720
2 Importing IM_INTERFACE Call by reference Type reference (TYPE) SXI_INTERFACE zu setzendes Interface, falls abweichend von bisherigem 20060720
3 Importing IM_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Nachricht, die vorbereitet wird 20060720
4 Importing IM_SENDER Call by reference Type reference (TYPE) SXI_FROMORTO Sender der Nachricht 20060720

Method PREPARE_SENDER_INTERFACE on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method REGISTER_USED_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) CL_SWF_XI_MESSAGE Message, die registriert wird 20060621
2 Importing IM_MESSAGES Call by reference Type reference (TYPE) SWFRXIMSGTAB Tabelle von Messages, die registriert wird 20060621
3 Importing IM_METHOD_NAME Call by reference Type reference (TYPE) IF_SWF_WFM_TSI_SERVICE=>TY_METHOD_NAME Methode, in der Messages verwendet werden 20060621

Method REGISTER_USED_MESSAGES on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method REGISTER_USED_OBJECTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_METHOD_NAME Call by reference Type reference (TYPE) IF_SWF_WFM_TSI_SERVICE=>TY_METHOD_NAME Methode, in der Messages verwendet werden 20090213
2 Importing IM_OBJECT Call by reference Type reference (TYPE) SIBFLPOR Objekt, das registriert wird 20090213
3 Importing IM_OBJECTS Call by reference Type reference (TYPE) SIBFLPORT Tabelle von Objekten, die registriert wird 20090213

Method REGISTER_USED_OBJECTS on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method RESET_USED_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_METHOD_NAME Call by reference Type reference (TYPE) IF_SWF_WFM_TSI_SERVICE=>TY_METHOD_NAME 20060621

Method RESET_USED_MESSAGES on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method RESET_USED_OBJECTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_METHOD_NAME Call by reference Type reference (TYPE) IF_SWF_WFM_TSI_SERVICE=>TY_METHOD_NAME 20090213

Method RESET_USED_OBJECTS on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method REVERT_CHANGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_BEFORE_IMAGE Call by reference Type reference (TYPE) TY_BEFORE_IMAGE Aufgezeichnetes Before-Image 20060720
2 Importing IM_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Message, an deren Änderungen zurückgenommen werden 20060720

Method REVERT_CHANGES on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method SEND_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGES Call by reference Type reference (TYPE) TTY_MESSAGES zu sendende Messages 20070404
2 Returning RE_LEAD_MESSAGE Value transfer Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB MMF-Message oder erste Message 20070404
# Exception Resumable Description Created on
1 CX_SWF_XI_EXCEPTION XI-Ausnahme 20070404
2 CX_XMS_MESSAGE_MMF XI: Systemfehler Multi Message 20070404

Method SEND_NOTIFICATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_AGENT Call by reference Object reference (TYPE REF TO) CL_SWF_XI_PMI_AGENT 20060922
2 Importing IM_MESSAGE_ID Call by reference Type reference (TYPE) SXMSMGUID GUID der versendeten Nachricht 20060922
3 Importing IM_TOP_WIID Call by reference Type reference (TYPE) SWW_WIID Workitem-Kennung 20060922

Method SEND_NOTIFICATION on class CL_SWF_XI_SRV_OUTBOUND has no exception.

Method SET_PROCESS_CONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_FULL_CONTEXT Call by reference Type reference (TYPE) RMT_CONTEXT Vollst. Cont.(SEND_CNTXT ignor., BEFORE_CNTXT ni. aktualis.) 20060616
2 Importing IM_MESSAGE_XMB Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB higher level message interface 20060313
3 Importing IM_SENDCONTEXT Call by reference Type reference (TYPE) SWF_STRING Container : Standardtyp STRING 20060313
4 Returning RE_BEFORE_CONTEXT Value transfer Type reference (TYPE) RMT_CONTEXT Context, wie er vor dem Setzen war 20060616

Method SET_PROCESS_CONTEXT on class CL_SWF_XI_SRV_OUTBOUND has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 710