SAP ABAP Interface IF_WS_UPGRADE (SOA upgrade support API)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
⤷
SOAP_WS_UPGRADE_SUPPORT (Package) SOA Upgrade support
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime⤷
SOAP_WS_UPGRADE_SUPPORT (Package) SOA Upgrade support
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_WS_UPGRADE_SUPPORT | WS upgrade support | 20071212 |
Properties
| Interface | IF_WS_UPGRADE | |
| Short Description | SOA upgrade support API |
General Data
| Package | SOAP_WS_UPGRADE_SUPPORT | SOA Upgrade support |
| Created | 20071210 | SAP |
| Last changed | 20090618 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_WS_UPGRADE has no forward declaration.
Interfaces
Interface IF_WS_UPGRADE has no interface.
Friends
Interface IF_WS_UPGRADE has no friend.
Attributes
Interface IF_WS_UPGRADE has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BGRFC_DESTINATION_IS_LOCKED |
Instance method | Public | Method | .check if the bgRFC Inbound destination is locked | 20080103 |
| 2 | GET_BGRFC_INBOUND_DEST_INFO |
Instance method | Public | Method | .et the bgRFC inbound destination that is used by WS Runtime | 20080103 |
| 3 | GET_QUEUED_MESSAGES_FOR_QUEUE |
Instance method | Public | Method | get actually queued messages for a list of queues | 20071210 |
| 4 | GET_QUEUED_MSG_FOR_SEQUENCES |
Instance method | Public | Method | get actually queued messages for a list of log sequences | 20080104 |
| 5 | GET_QUEUES_ALL_CLNT |
Instance method | Public | Method | get queues and state, client independant | 20080115 |
| 6 | GET_QUEUES_DETAILEDINFO |
Instance method | Public | Method | get queues and state (all , failedin proc locked ) | 20071210 |
| 7 | GET_QUEUES_STATISTICAL_INFO |
Instance method | Public | Method | .get statistical info, how many queues (all , failed...) | 20071210 |
| 8 | GET_QUEUES_STAT_INFO_ALL_CLNT |
Instance method | Public | Method | get statistical info, client independent | 20080114 |
| 9 | GET_SEQUENCES_FOR_QUEUES |
Instance method | Public | Method | get logical sequences for a list of queues | 20071213 |
| 10 | LOCK_BGRFC_INBOUND_DEST |
Instance method | Public | Method | lock the bgRFC inbound destination | 20071210 |
| 11 | LOCK_QUEUES |
Instance method | Public | Method | lock a list of bgRFC inbound queues | 20071210 |
| 12 | LOCK_QUEUES_ALL_CLNT |
Instance method | Public | Method | lock a list of bgRFC inbound queus client indept. | 20080117 |
| 13 | TERMINATE_CONSUMER_SEQS_SOFT |
Instance method | Public | Method | finalize consumer sequences client independant | 20071210 |
| 14 | TERMINATE_SEQUENCES_HARD |
Instance method | Public | Method | discard logical sequences client independant | 20071210 |
| 15 | UNLOCK_BGRFC_INBOUND_DEST |
Instance method | Public | Method | unlock the bgRFC inbound destination | 20071210 |
| 16 | UNLOCK_QUEUES |
Instance method | Public | Method | unlock a list of bgRFC inbound queues | 20071210 |
| 17 | UNLOCK_QUEUES_ALL_CLNT |
Instance method | Public | Method | unlock a list of bgRFC inbound queus client indept. | 20080117 |
Events
Interface IF_WS_UPGRADE has no event.
Types
Interface IF_WS_UPGRADE has no local type.
Method Signatures
Method BGRFC_DESTINATION_IS_LOCKED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
LOCKED | Value transfer | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20080103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080103 |
Method GET_BGRFC_INBOUND_DEST_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DESTINATION_INFO | Value transfer | Type reference (TYPE) | SRT_S_BGRFC_DESTINATION_INFO | Ifo about the bgRFC destination used by WS Runtime | 20080103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080103 |
Method GET_QUEUED_MESSAGES_FOR_QUEUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
QUEUES | Call by reference | Type reference (TYPE) | SRT_T_QUEUE | list of queues | 20080110 | ||
| 2 | Returning |
QUEUES_MESSAGES | Value transfer | Type reference (TYPE) | SRT_T_SEQ_QUEUED_MSG | queued but not processed messages | 20080110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080103 |
Method GET_QUEUED_MSG_FOR_SEQUENCES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
QUEUED_MESSAGES | Value transfer | Type reference (TYPE) | SRT_T_SEQ_QUEUED_MSG | queued but not processed messages | 20080104 | ||
| 2 | Importing |
SEQUENCES | Call by reference | Type reference (TYPE) | SRT_T_SEQUENCE_KEY | list of sequences | 20080104 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080104 |
Method GET_QUEUES_ALL_CLNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
FAILED_CLIENTS | Call by reference | Type reference (TYPE) | SRT_T_CLIENT | system clients | 20080130 | ||
| 2 | Exporting |
QUEUES_INFO | Value transfer | Type reference (TYPE) | SRT_T_QUEUES_INFO_CLNT | list of relationship sequence to queue | 20080115 | ||
| 3 | Importing |
SELECTION_PARAM | Call by reference | Type reference (TYPE) | SRT_QUEUE_SELECTPARAM_STATE | 'A' | selection: specification of requested sequences | 20080115 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080115 |
Method GET_QUEUES_DETAILEDINFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
QUEUES_INFO_ALL_CLIENTS | Value transfer | Type reference (TYPE) | SRT_T_QUEUES_INFO_CLNT | list of relationship sequence to queue | 20080115 | ||
| 2 | Importing |
SELECTION_PARAM | Call by reference | Type reference (TYPE) | SRT_QUEUE_SELECTPARAM_STATE | 'A' | selection: specification of requested sequences | 20080110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080103 |
Method GET_QUEUES_STATISTICAL_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
QUEUES_INFO | Value transfer | Type reference (TYPE) | SRT_S_QUEUES_INFO_STATISTIC | selection: specification of requested sequences | 20080110 | ||
| 2 | Importing |
SELECTION_PARAM | Call by reference | Type reference (TYPE) | SRT_QUEUE_SELECTPARAM_STATE | 'A' | selection: specification of requested sequences | 20080110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080103 |
Method GET_QUEUES_STAT_INFO_ALL_CLNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_CLIENTS | Call by reference | Type reference (TYPE) | SRT_T_CLIENT | system clients | 20080129 | ||
| 2 | Exporting |
QUEUES_INFO_ALL_CLIENTS | Value transfer | Type reference (TYPE) | SRT_T_QUES_INFO_STATISTIC_CLNT | statistical queueinfo client specified | 20080114 | ||
| 3 | Importing |
SELECTION_PARAM | Call by reference | Type reference (TYPE) | SRT_QUEUE_SELECTPARAM_STATE | 'A' | selection: specification of requested sequences | 20080114 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method GET_SEQUENCES_FOR_QUEUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
QUEUES | Call by reference | Type reference (TYPE) | SRT_T_QUEUE | list of queues | 20080110 | ||
| 2 | Returning |
SEQUENCES_QUEUES | Value transfer | Type reference (TYPE) | SRT_T_SEQUENCE_QUEUE | list of relationship sequence to queue | 20080110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080103 |
Method LOCK_BGRFC_INBOUND_DEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
LOCK_ID | Value transfer | Type reference (TYPE) | BGRFC_LOCK_ID | ID of Lock in Background RFC | 20080516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method LOCK_QUEUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_QUEUES | Call by reference | Type reference (TYPE) | SRT_T_FAILED_QUEUE | Protocol: List of failed sequences (termination etc) | 20080117 | ||
| 2 | Importing |
QUEUES | Call by reference | Type reference (TYPE) | SRT_T_QUEUE | list of queues | 20080117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method LOCK_QUEUES_ALL_CLNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_CLIENTS | Call by reference | Type reference (TYPE) | SRT_T_CLIENT | Protocol: List of failed clients | 20080314 | ||
| 2 | Exporting |
FAILED_QUEUES | Call by reference | Type reference (TYPE) | SRT_T_FAILED_QUEUE | Protocol: List of failed sequences (termination etc) | 20080117 | ||
| 3 | Importing |
QUEUES | Value transfer | Type reference (TYPE) | SRT_T_QUEUE | list of queues | 20080117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080117 |
Method TERMINATE_CONSUMER_SEQS_SOFT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_CLIENTS | Call by reference | Type reference (TYPE) | SRT_T_CLIENT | system clients | 20080130 | ||
| 2 | Exporting |
FAILED_SEQUENCES | Call by reference | Type reference (TYPE) | SRT_T_FAILED_SEQUENCE | Protocol: List of failed sequences | 20080110 | ||
| 3 | Importing |
SEQUENCES | Value transfer | Type reference (TYPE) | SRT_T_SEQUENCE_KEY | list of sequences | 20080110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method TERMINATE_SEQUENCES_HARD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_CLIENTS | Call by reference | Type reference (TYPE) | SRT_T_CLIENT | system clients | 20080130 | ||
| 2 | Exporting |
FAILED_SEQUENCES | Call by reference | Type reference (TYPE) | SRT_T_FAILED_SEQUENCE | Single-Character Flag | 20080110 | ||
| 3 | Importing |
SEQUENCES | Value transfer | Type reference (TYPE) | SRT_T_SEQUENCE_KEY | list of sequences | 20080110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method UNLOCK_BGRFC_INBOUND_DEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LOCK_ID | Call by reference | Type reference (TYPE) | BGRFC_LOCK_ID | ID of Lock in Background RFC | 20080516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method UNLOCK_QUEUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_QUEUES | Call by reference | Type reference (TYPE) | SRT_T_FAILED_QUEUE | Protocol: List of failed sequences (termination etc) | 20080117 | ||
| 2 | Importing |
QUEUES | Call by reference | Type reference (TYPE) | SRT_T_QUEUE | list of queues | 20080117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080114 |
Method UNLOCK_QUEUES_ALL_CLNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FAILED_CLIENTS | Call by reference | Type reference (TYPE) | SRT_T_CLIENT | Protocol: List of failed clients | 20080314 | ||
| 2 | Exporting |
FAILED_QUEUES | Call by reference | Type reference (TYPE) | SRT_T_FAILED_QUEUE | Protocol: List of failed sequences (termination etc) | 20080117 | ||
| 3 | Importing |
QUEUES | Value transfer | Type reference (TYPE) | SRT_T_QUEUE | list of queues | 20080117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WS_UPGRADE_SUPPORT |
exceptions within upgrade support API | 20080117 |
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in | 711 |
