SAP ABAP Class CL_SHP_APPL_XI_HELPER (Helper for XI Message Sender and Receiver)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
LE-SHP-GF-ES (Application Component) Enterprise Services in Shipping
⤷
OPS_SE_SHP_XI_PROXY (Package) Web Service Proxies Delivery
SAP_APPL (Software Component) Logistics and Accounting⤷
LE-SHP-GF-ES (Application Component) Enterprise Services in Shipping⤷
OPS_SE_SHP_XI_PROXY (Package) Web Service Proxies DeliveryProperties
| Class | CL_SHP_APPL_XI_HELPER | |
| Short Description | Helper for XI Message Sender and Receiver | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | OPS_SE_APPL_SHP | |
| Program status | ||
| Category | 0 | |
| Package | OPS_SE_SHP_XI_PROXY | Web Service Proxies Delivery |
| Created | 20080206 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | IF_OPS_SE_SOC_TYPES |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | SAI |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_SHP_APPL_XI_HELPER has no interface implemented.
Friends
Class CL_SHP_APPL_XI_HELPER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_BAL_OBJECT |
Constant | Public | Type reference (TYPE) | BALOBJ_D | 'OPS_SE_APPL_SHP' | Application Log: Object Name (Application Code) | 20080206 | |
| 2 | GC_XI_OBJRELTYPE_IN |
Constant | Public | Type reference (TYPE) | OBLRELTYPE | 'XI_IN_BOR' | Relationship type | 20080206 | |
| 3 | GC_XI_OBJRELTYPE_OUT |
Constant | Public | Type reference (TYPE) | OBLRELTYPE | 'XI_OUT_BOR' | Relationship type | 20080206 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_MESSAGE_ID_INBOUND |
Static method | Public | Method | Get message ID of inbound XI message | 20080206 |
| 2 | GET_MESSAGE_ID_OUTBOUND |
Static method | Public | Method | Get message ID of outbound XI message | 20090203 |
| 3 | GET_PAYLOAD_FIELDS |
Static method | Public | Method | Return fields in payload | 20100303 |
| 4 | IS_IN_PAYLOAD |
Static method | Public | Method | Is field in payload? | 20080206 |
| 5 | MOVE_CORRESPONDING |
Static method | Public | Method | Move corresponding for a set of components only | 20080213 |
| 6 | WRITE_APPLICATION_LOG |
Static method | Public | Method | Write application log | 20080213 |
| 7 | WRITE_LINK_INBOUND |
Static method | Public | Method | Link inbound XI message with delivery | 20080206 |
| 8 | WRITE_LINK_OUTBOUND |
Static method | Public | Method | Link outbound XI message with delivery | 20090203 |
Events
Class CL_SHP_APPL_XI_HELPER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTY_COMPONENT_MAPPING | Public | See coding | 20080206 | begin of gty_component_mapping,
name1 type string,
name2 type string,
end of gty_component_mapping
|
||
| 2 | GTY_COMPONENT_MAPPING_T | Public | See coding | 20080206 | gty_component_mapping_t type table of gty_component_mapping
|
||
| 3 | GTY_COMPONENT_RANGE_T | Public | See coding | 20080206 | gty_component_range_t type range of string
|
||
| 4 | GTY_FIELD_RANGE_S | Public | See coding | 20080206 | gty_field_range_s type line of gty_field_range_t
|
||
| 5 | GTY_FIELD_RANGE_T | Public | See coding | 20080206 | gty_field_range_t type range of fieldname
|
||
| 6 | GTY_MSGID | Public | Type reference (TYPE) | RAW16 | RAW16 | 20080206 | |
Method Signatures
Method GET_MESSAGE_ID_INBOUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RF_MSGID | Value transfer | Type reference (TYPE) | GTY_MSGID | 20080206 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_AI_SYSTEM_FAULT |
20080206 |
Method GET_MESSAGE_ID_OUTBOUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_PROXY | Call by reference | Object reference (TYPE REF TO) | CL_PROXY_BASIS | ABAP Proxies: Basic Proxy Methods | 20090203 | ||
| 2 | Returning |
RF_MSGID | Value transfer | Type reference (TYPE) | IF_OPS_SE_SOC_TYPES=>GTY_MSGID | XML Message ID | 20090203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_AI_SYSTEM_FAULT |
Application Integration: Technical Error | 20090203 |
Method GET_PAYLOAD_FIELDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_FIELD_RANGE | Call by reference | Type reference (TYPE) | GTY_FIELD_RANGE_T | 20100303 | |||
| 2 | Importing |
IS_STRUCTURE | Call by reference | Type reference (TYPE) | ANY | 20100303 |
Method GET_PAYLOAD_FIELDS on class CL_SHP_APPL_XI_HELPER has no exception.
Method IS_IN_PAYLOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IF_FIELD | Call by reference | Type reference (TYPE) | FIELDNAME | 20080206 | |||
| 2 | Importing |
IT_CONTROLLER | Call by reference | Type reference (TYPE) | PRXCTRLTAB | 20080206 | |||
| 3 | Returning |
RF_IN_PAYLOAD | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20080206 |
Method IS_IN_PAYLOAD on class CL_SHP_APPL_XI_HELPER has no exception.
Method MOVE_CORRESPONDING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CS_STRUCT | Call by reference | Type reference (TYPE) | ANY | 20080213 | |||
| 2 | Exporting |
ET_SKIPPED_COMPONENTS | Call by reference | Type reference (TYPE) | GTY_COMPONENT_RANGE_T | 20080613 | |||
| 3 | Importing |
IS_STRUCT | Call by reference | Type reference (TYPE) | ANY | 20080213 | |||
| 4 | Importing |
IT_COMPONENTS | Call by reference | Type reference (TYPE) | GTY_COMPONENT_RANGE_T | 20080213 | |||
| 5 | Importing |
IT_MAPPING | Call by reference | Type reference (TYPE) | GTY_COMPONENT_MAPPING_T | 20080213 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SHP_APPL_ERROR_MESSAGE |
20080213 |
Method WRITE_APPLICATION_LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IF_BAL_OBJECT | Call by reference | Type reference (TYPE) | BALOBJ_D | GC_BAL_OBJECT | 20080213 | ||
| 2 | Importing |
IF_BAL_SUBOBJECT | Call by reference | Type reference (TYPE) | BALSUBOBJ | 20080213 | |||
| 3 | Importing |
IF_IN_NEW_TASK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20080213 | ||
| 4 | Importing |
IF_MSGID | Call by reference | Type reference (TYPE) | GTY_MSGID | 20080213 | |||
| 5 | Importing |
IT_LOG | Call by reference | Type reference (TYPE) | BAPIRETTAB | 20080213 |
Method WRITE_APPLICATION_LOG on class CL_SHP_APPL_XI_HELPER has no exception.
Method WRITE_LINK_INBOUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_LOG | Call by reference | Type reference (TYPE) | BAPIRETTAB | 20080206 | |||
| 2 | Importing |
IF_BUSOBJ | Call by reference | Type reference (TYPE) | SWO_OBJTYP | 20080206 | |||
| 3 | Importing |
IF_MSGID | Call by reference | Type reference (TYPE) | GTY_MSGID | 20080206 | |||
| 4 | Importing |
IF_VBELN | Call by reference | Type reference (TYPE) | VBELN_VL | 20080206 |
Method WRITE_LINK_INBOUND on class CL_SHP_APPL_XI_HELPER has no exception.
Method WRITE_LINK_OUTBOUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_LOG | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20090203 | ||
| 2 | Importing |
IF_BUSOBJ | Call by reference | Type reference (TYPE) | SWO_OBJTYP | Object Type | 20090203 | ||
| 3 | Importing |
IF_MSGID | Call by reference | Type reference (TYPE) | IF_OPS_SE_SOC_TYPES=>GTY_MSGID | XML Message ID | 20090203 | ||
| 4 | Importing |
IF_VBELN | Call by reference | Type reference (TYPE) | VBELN_VL | Delivery | 20090203 |
Method WRITE_LINK_OUTBOUND on class CL_SHP_APPL_XI_HELPER has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 604 |
