SAP ABAP Interface IF_ILM_STOR_SINK (ILM DB Store: Data Sink)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ILM-STO (Application Component) Integrated Data Base Archive Store
⤷
S_ILM_STOR_PROCESS (Package) ILM DB Store: Processing
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ILM_STOR_SINK_FILE | ILM DB Store: File-Based Data Sink | 20130816 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ILM_STOR_SINK_MEM | ILM DB Store: Data Sink with Memory Buffer | 20130816 |
Properties
| Interface | IF_ILM_STOR_SINK | |
| Short Description | ILM DB Store: Data Sink |
General Data
| Package | S_ILM_STOR_PROCESS | ILM DB Store: Processing |
| Created | 20130510 | SAP |
| Last changed | 20140121 | SAP |
| 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) |
Interfaces
Interface IF_ILM_STOR_SINK has no interface.
Friends
Interface IF_ILM_STOR_SINK has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_SINK_ATTRIBUTES | Constant | Public | See coding | 20130816 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Close Data Sink | 20130816 | |
| 2 | Instance method | Public | Method | Delete Data Sink | 20130816 | |
| 3 | Instance method | Public | Method | Get Data from Data Sink | 20130816 | |
| 4 | Instance method | Public | Method | Get File Name for Persisted Data Sinks | 20130816 | |
| 5 | Instance method | Public | Method | Determines Length of Data in the Data Sink | 20130816 | |
| 6 | Instance method | Public | Method | Determines Whether a Data Sink Is File-Based | 20130816 | |
| 7 | Instance method | Public | Method | Open Data Sink for Reading | 20130816 | |
| 8 | Instance method | Public | Method | Open Data Sink for Writing | 20130816 | |
| 9 | Instance method | Public | Method | Set File Name for Persisting Data | 20130816 | |
| 10 | Instance method | Public | Method | Write Data in Data Sink | 20130816 |
Events
Interface IF_ILM_STOR_SINK has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_SINK_ATTRIBUTE | Public | Type reference (TYPE) | SYCHAR02 | 20130816 | |
Method Signatures
Method CLOSE Signature
Method CLOSE on Interface IF_ILM_STOR_SINK has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Transferfehler | 20130816 |
Method DELETE Signature
Method DELETE on Interface IF_ILM_STOR_SINK has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Transferfehler | 20130816 |
Method GET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_LENGTH | Call by reference | Type reference (TYPE) | I | -1 | Anzahl der zu lesenden Bytes | 20130816 | ||
| 2 | IV_OFFSET | Call by reference | Type reference (TYPE) | ABAP_MSIZE | -1 | Offset, ab dem gelesen werden soll | 20130816 | ||
| 3 | RV_VALUE | Value transfer | Type reference (TYPE) | XSTRING | Gelesener Datenblock | 20130816 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130816 | |||
| 2 | Transferfehler | 20130816 |
Method GET_FILE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_VALUE | Value transfer | Type reference (TYPE) | STRING | Name der zugrundeliegenden Datei | 20130816 |
Method GET_FILE_NAME on Interface IF_ILM_STOR_SINK has no exception.
Method GET_PUFFER_LENGTH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_VALUE | Value transfer | Type reference (TYPE) | I | Länge der bisher übertragenen Daten | 20130816 |
Method GET_PUFFER_LENGTH on Interface IF_ILM_STOR_SINK has no exception.
Method IS_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | abap_true, wenn es eine dateibasierte Datensenke ist | 20130816 |
Method IS_FILE on Interface IF_ILM_STOR_SINK has no exception.
Method OPEN_FOR_READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HANDLE | Call by reference | Type reference (TYPE) | ILM_STOR_HANDLE | ILM-DB-Ablage: Ressource Handle | 20130816 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ILM-DB-Ablage: Laufzeitfehler | 20130816 | ||
| 2 | Transferfehler | 20130816 |
Method OPEN_FOR_WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HANDLE | Call by reference | Type reference (TYPE) | ILM_STOR_HANDLE | ILM-DB-Ablage: Ressource Handle | 20130816 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ILM-DB-Ablage: Laufzeitfehler | 20130816 | ||
| 2 | Transferfehler | 20130816 |
Method SET_FILE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_READ_ONLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Indikator, ob die Datei nur gelesen werden darf | 20130816 | ||
| 2 | IV_VALUE | Value transfer | Type reference (TYPE) | STRING | Zu verwendender Dateiname | 20130816 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Laufzeitfehler | 20130816 | ||
| 2 | 20130816 |
Method WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CHUNK | Call by reference | Type reference (TYPE) | XSTRING | Zu übertragender Datenblock | 20130816 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ILM-DB-Ablage: Laufzeitfehler | 20130816 | ||
| 2 | Transferfehler | 20130816 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |