SAP ABAP Class C_OI_ERRORS (Error Handling for Office Integration)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-FES-OFF (Application Component) SAP Desktop Office Integration
⤷
SOFFICEINTEGRATION (Package) Platform- and application-indep. Office integration
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-FES-OFF (Application Component) SAP Desktop Office Integration⤷
SOFFICEINTEGRATION (Package) Platform- and application-indep. Office integrationProperties
| Class | C_OI_ERRORS | |
| Short Description | Error Handling for Office Integration | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SOFFICEINTEGRATION | Platform- and application-indep. Office integration |
| Created | 19981118 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  SOI |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class C_OI_ERRORS has no interface implemented.
Friends
Class C_OI_ERRORS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ERROR_CODE |
Static Attribute | Public | Type reference (TYPE) | SOI_RET_STRING | Error Code | 19981118 | ||
| 2 | ERROR_LIST |
Static Attribute | Private | See coding | Error list | 19981118 | |||
| 3 | HAS_FAILED |
Static Attribute | Public | Type reference (TYPE) | CHAR1 | 'X' - Failed | 19981118 | ||
| 4 | HAS_SUCCEEDED |
Static Attribute | Public | Type reference (TYPE) | CHAR1 | 'X' - Succeeded | 19981118 | ||
| 5 | MESSAGE_ID |
Static Attribute | Private | Type reference (TYPE) | SY-MSGID | For Internal Use | 19981118 | ||
| 6 | MESSAGE_NR |
Static Attribute | Private | Type reference (TYPE) | SY-MSGNO | For Internal Use | 19981118 | ||
| 7 | NEEDS_FLUSH |
Static Attribute | Private | Type reference (TYPE) | CHAR1 | For Internal Use | 19981118 | ||
| 8 | PARAM1 |
Static Attribute | Private | Type reference (TYPE) | SY-MSGV1 | For Internal Use | 19981118 | ||
| 9 | PARAM2 |
Static Attribute | Private | Type reference (TYPE) | SY-MSGV2 | For Internal Use | 19981118 | ||
| 10 | PARAM3 |
Static Attribute | Private | Type reference (TYPE) | SY-MSGV3 | For Internal Use | 19981118 | ||
| 11 | PARAM4 |
Static Attribute | Private | Type reference (TYPE) | SY-MSGV4 | For Internal Use | 19981118 | ||
| 12 | RET_APPLICATION_NOT_RESPONDING |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'APPLICATION_NOT_RESPONDING' | Application Is Not Responding Or Is Busy | 19981221 | |
| 13 | RET_CALL_NOT_FLUSHED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'CALL_NOT_FLUSHED' | Call not Executed | 19981118 | |
| 14 | RET_CONTROL_CREATE_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'CONTROL_CREATE_ERROR' | Control Not Created | 19981118 | |
| 15 | RET_CONTROL_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'CONTROL_ERROR' | General Error | 19981118 | |
| 16 | RET_CONTROL_INSTALL_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'CONTROL_INSTALL_ERROR' | Installation errors | 19981118 | |
| 17 | RET_CONTROL_INTERNAL_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'CONTROL_INTERNAL_ERROR' | Internal error | 19981118 | |
| 18 | RET_CONTROL_NOT_INITIALIZED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'CONTROL_NOT_INITIALIZED' | Control not installed | 19981118 | |
| 19 | RET_DOCUMENT_ALREADY_OPEN |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'DOCUMENT_ALREADY_OPEN' | Document already opened | 19981118 | |
| 20 | RET_DOCUMENT_NOT_OPEN |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'DOCUMENT_NOT_OPEN' | Document Not Opened | 19981118 | |
| 21 | RET_DOCUMENT_NO_VIEW_DATA |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'DOCUMENT_NO_VIEW_DATA_AVAILA' | No Presentation Data Available | 19981118 | |
| 22 | RET_DOC_TYPE_NOT_REGISTERED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'DOCUMENT_TYPE_NOT_REGISTERED' | No Editing Program Available | 19981118 | |
| 23 | RET_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'ERROR' | Errors | 19981118 | |
| 24 | RET_INPLACE_DISABLED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'INPLACE_ACTIVATION_DISABLED' | InPlace Display Deactivated | 19981118 | |
| 25 | RET_INTERFACE_NOT_SUPPORTED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'INTERFACE_NOT_SUPPORTED' | Interface Not Supported | 19981118 | |
| 26 | RET_LINK_SERVER_ALREADY_ACTIVE |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'LINK_SERVER_ALREADY_ACTIVE' | Link Server is Already Running | 19981118 | |
| 27 | RET_LINK_SERVER_NOT_ACTIVE |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'LINK_SERVER_NOT_ACTIVE' | Link Server is Inactive | 19981118 | |
| 28 | RET_MACRO_OR_SCRIPT_FAILED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'MACRO_OR_SCRIPT_FAILED' | Macro Execution Failed | 19981118 | |
| 29 | RET_MACRO_OR_SCRIPT_NOT_FOUND |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'MACRO_OR_SCRIPT_NOT_FOUND' | Macro Not Found | 19981118 | |
| 30 | RET_METHOD_CANCELLED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'METHOD_CANCELLED' | Call Terminated by User | 19981118 | |
| 31 | RET_METHOD_NOT_SUPPORTED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'METHOD_NOT_SUPPORTED' | Method Not Supported | 19981118 | |
| 32 | RET_NO_LINK_ITEM_SELECTED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'NO_LINK_ITEM_SELECTED' | No link item selected | 19981118 | |
| 33 | RET_NO_STANDARD_INTERFACE |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'NO_STANDARD_INTERFACE' | Standard Interface Not Supported | 19981118 | |
| 34 | RET_OBJECT_ALREADY_INITIALIZED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'OBJECT_ALREADY_INITIALIZED' | Object Already Initialized | 19981118 | |
| 35 | RET_OBJECT_NOT_INITIALIZED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'OBJECT_NOT_INITIALIZED' | Object Not Initialized | 19981118 | |
| 36 | RET_OK |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'OK' | OK | 19981118 | |
| 37 | RET_OPEN_DOCUMENT_FAILED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'OPEN_DOCUMENT_FAILED' | Error While Opening | 19981118 | |
| 38 | RET_OPEN_DOCUMENT_FILE_FAILED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'OPEN_DOCUMENT_FILE_FAILED' | Error While Opening | 19981118 | |
| 39 | RET_SAVE_DOCUMENT_FAILED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'SAVE_DOCUMENT_FAILED' | Error When Saving | 19981118 | |
| 40 | RET_SAVE_DOCUMENT_FILE_FAILED |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'SAVE_DOCUMENT_FILE_FAILED' | Error When Saving | 19981118 | |
| 41 | RET_SYSTEM_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'SYSTEM_ERROR' | System Error | 19981118 | |
| 42 | RET_UNKNOWN_ERROR |
Constant | Public | Type reference (TYPE) | SOI_RET_STRING | 'UNKNOWN_ERROR' | Unknown error | 19981118 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_ERROR |
Static method | Public | Method | For Internal Use | 19981118 |
| 2 | CREATE_ERROR_FOR_RETCODE |
Static method | Public | Method | For Internal Use | 19981118 |
| 3 | FLUSH_ERRORS |
Static method | Public | Method | For Internal Use | 19981118 |
| 4 | GET_MESSAGE |
Static method | Public | Method | Returns Error Data | 19981118 |
| 5 | RAISE_MESSAGE |
Static method | Public | Method | Triggers Error Display for Error | 19981118 |
| 6 | SET_ERROR_CODE |
Static method | Public | Method | For Internal Use | 19981118 |
| 7 | SET_MESSAGE |
Static method | Public | Method | For Internal Use | 19981118 |
| 8 | SET_MESSAGE_FOR_ERROR |
Static method | Public | Method | For Internal Use | 19981118 |
| 9 | SHOW_MESSAGE |
Static method | Public | Method | Triggers Error Display for Error | 19981118 |
| 10 | TRANSLATE_PROXY_ERROR_CODE |
Static method | Public | Method | For Internal Use | 19981118 |
Events
Class C_OI_ERRORS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | ERROR_ENTRY | Private | See coding | ERROR_ENTRY | 19981118 | |
Method Signatures
Method ADD_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehler | 19981118 |
Method ADD_ERROR on class C_OI_ERRORS has no exception.
Method CREATE_ERROR_FOR_RETCODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehler | 19981118 | ||
| 2 | Importing |
METHOD_NAME | Call by reference | Type reference (TYPE) | C | 'Unknown' "#EC NOTEXT | Methodenname | 19981118 | |
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | 19981118 | |||
| 4 | Importing |
OBJECT_NAME | Call by reference | Type reference (TYPE) | C | 'Unknown' "#EC NOTEXT | Objektname | 19981118 | |
| 5 | Importing |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehler | 19981118 |
Method CREATE_ERROR_FOR_RETCODE on class C_OI_ERRORS has no exception.
Method FLUSH_ERRORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NO_FLUSH | Call by reference | Type reference (TYPE) | C | 19981118 |
Method FLUSH_ERRORS on class C_OI_ERRORS has no exception.
Method GET_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
MESSAGE_ID | Call by reference | Type reference (TYPE) | SY-MSGID | 19981118 | |||
| 2 | Exporting |
MESSAGE_NUMBER | Call by reference | Type reference (TYPE) | SY-MSGNO | 19981118 | |||
| 3 | Exporting |
PARAM1 | Call by reference | Type reference (TYPE) | SY-MSGV1 | 19981118 | |||
| 4 | Exporting |
PARAM2 | Call by reference | Type reference (TYPE) | SY-MSGV2 | 19981118 | |||
| 5 | Exporting |
PARAM3 | Call by reference | Type reference (TYPE) | SY-MSGV3 | 19981118 | |||
| 6 | Exporting |
PARAM4 | Call by reference | Type reference (TYPE) | SY-MSGV4 | 19981118 |
Method GET_MESSAGE on class C_OI_ERRORS has no exception.
Method RAISE_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
TYPE | Call by reference | Type reference (TYPE) | C | 19981118 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  MESSAGE_RAISED |
19981118 |
Method SET_ERROR_CODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ERROR_CODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlercode | 19981118 |
Method SET_ERROR_CODE on class C_OI_ERRORS has no exception.
Method SET_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MESSAGE_ID | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 2 | Importing |
MESSAGE_NUMBER | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 3 | Importing |
PARAM1 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 4 | Importing |
PARAM2 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 5 | Importing |
PARAM3 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 6 | Importing |
PARAM4 | Call by reference | Type reference (TYPE) | C | 19981118 |
Method SET_MESSAGE on class C_OI_ERRORS has no exception.
Method SET_MESSAGE_FOR_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PARAM1 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 2 | Importing |
PARAM2 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 3 | Importing |
PARAM3 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 4 | Importing |
PARAM4 | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 5 | Importing |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehler | 19981118 |
Method SET_MESSAGE_FOR_ERROR on class C_OI_ERRORS has no exception.
Method SHOW_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
TYPE | Call by reference | Type reference (TYPE) | C | 19981118 |
Method SHOW_MESSAGE on class C_OI_ERRORS has no exception.
Method TRANSLATE_PROXY_ERROR_CODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ERRORCODE | Call by reference | Type reference (TYPE) | SOI_PROXY_ERROR_CODE | Fehlercode | 19981118 | ||
| 2 | Importing |
ERRORSTRING | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 3 | Importing |
OBJECTNAME | Call by reference | Type reference (TYPE) | C | 19981118 | |||
| 4 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehler | 19981118 |
Method TRANSLATE_PROXY_ERROR_CODE on class C_OI_ERRORS has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
