SAP ABAP Class CL_XMS_QM (XI Queue Monitoring)
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_QM | |
| Short Description | XI Queue Monitoring | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SXMSF | XI: Integration Engine Runtime |
| Created | 20070306 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_XMS_QM has no forward declaration.
Interfaces
Class CL_XMS_QM has no interface implemented.
Friends
Class CL_XMS_QM has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Public | Type reference (TYPE) | CHAR1 | 'N' | Single-Character Flag | 20070306 | ||
| 2 | Static Attribute | Public | Type reference (TYPE) | TBTCJOB-PRDMINS | Duration period (in minutes) for a background job | 20070306 | |||
| 3 | Static Attribute | Public | Type reference (TYPE) | WPINFO-WP_NO | Work Process Number | 20070306 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | activate queue monitor | 20070306 | |
| 2 | Instance method | Public | Method | mark queue name for processing to process list | 20070306 | |
| 3 | Instance method | Public | Constructor | CONSTRUCTOR | 20070306 | |
| 4 | Static method | Public | Method | deactivate queue monitor | 20070306 | |
| 5 | Instance method | Public | Method | mark queue name as processed to process list | 20070306 | |
| 6 | Static method | Public | Method | delete entries older than history period | 20070306 | |
| 7 | Instance method | Public | Method | del queue name | 20070306 | |
| 8 | Static method | Public | Method | get deletion duration | 20070306 | |
| 9 | Instance method | Public | Method | get end time | 20070306 | |
| 10 | Static method | Public | Method | get monitoring interval | 20070306 | |
| 11 | Static method | Public | Method | get queue statistics | 20070319 | |
| 12 | Static method | Public | Method | queue monitor activated | 20070306 | |
| 13 | Static method | Private | Method | set server for queue monitoring | 20070306 | |
| 14 | Static method | Public | Method | set monitoring interval | 20070306 |
Events
Class CL_XMS_QM has no event.
Types
Class CL_XMS_QM has no local type.
Method Signatures
Method ACTIVATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PERIOD | Call by reference | Type reference (TYPE) | CHAR2 | '10' | period | 20070306 |
Method ACTIVATE on class CL_XMS_QM has no exception.
Method ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_COUNT | Call by reference | Type reference (TYPE) | INT4 | 1 | Natürliche Zahl | 20070306 | ||
| 2 | I_QNAME | Call by reference | Type reference (TYPE) | TRFCQIN-QNAME | Name einer tRFC-Queue | 20070306 |
Method ADD on class CL_XMS_QM has no exception.
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_XMS_QM has no parameter.
Method CONSTRUCTOR on class CL_XMS_QM has no exception.
Method DEACTIVATE Signature
Method DEACTIVATE on class CL_XMS_QM has no parameter.
Method DEACTIVATE on class CL_XMS_QM has no exception.
Method DEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_COUNT | Call by reference | Type reference (TYPE) | INT4 | 1 | Natürliche Zahl | 20070306 | ||
| 2 | I_QNAME | Call by reference | Type reference (TYPE) | TRFCQIN-QNAME | Name einer tRFC-Queue | 20070306 |
Method DEL on class CL_XMS_QM has no exception.
Method DELETE_OBSOLETE_ENTRIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PERIOD | Call by reference | Type reference (TYPE) | CHAR2 | Komponente der Versionsnummer | 20070306 | |||
| 2 | RETURN | Value transfer | Type reference (TYPE) | I | 20070306 |
Method DELETE_OBSOLETE_ENTRIES on class CL_XMS_QM has no exception.
Method DEL_QNAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | QUEUE | Call by reference | Type reference (TYPE) | TRFCQNAM | Name einer tRFC-Queue | 20100423 |
Method DEL_QNAME on class CL_XMS_QM has no exception.
Method GET_DEL_DURATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | CHAR3 | Feld der Laenge 3 Bytes | 20070306 |
Method GET_DEL_DURATION on class CL_XMS_QM has no exception.
Method GET_END_TIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20070306 | |||
| 2 | RETURN | Value transfer | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20070306 |
Method GET_END_TIME on class CL_XMS_QM has no exception.
Method GET_PERIOD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | TBTCJOB-PRDMINS | Periodendauer (Minuten) für einen Batch-Job | 20070306 |
Method GET_PERIOD on class CL_XMS_QM has no exception.
Method GET_QUEUE_RANGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_END_TIME | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20070319 | |||
| 2 | IM_QUEUE | Call by reference | Type reference (TYPE) | TRFCQNAM | Name einer tRFC-Queue | 20070319 | |||
| 3 | IM_START_TIME | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20070319 | |||
| 4 | RETURN | Value transfer | Type reference (TYPE) | SXMS_QM_T | Tabellentyp von sxms_qm | 20070319 |
Method GET_QUEUE_RANGES on class CL_XMS_QM has no exception.
Method IS_ACTIVATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | CHAR1 | Einstelliges Kennzeichen | 20070306 |
Method IS_ACTIVATED on class CL_XMS_QM has no exception.
Method QM_GET_SERVER Signature
Method QM_GET_SERVER on class CL_XMS_QM has no parameter.
Method QM_GET_SERVER on class CL_XMS_QM has no exception.
Method SET_PERIOD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MINUTES | Call by reference | Type reference (TYPE) | TBTCJOB-PRDMINS | 10 | Periodendauer (Minuten) für einen Batch-Job | 20070306 |
Method SET_PERIOD on class CL_XMS_QM has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 710 |