SAP ABAP Class CL_DB2_FILE_UTILS (Utilities for Filesystem operations)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DB-DB2 (Application Component) DB2 for z/OS
⤷
STU2 (Package) CCMS for DB2 for OS/390
⤷
⤷
Properties
| Class | CL_DB2_FILE_UTILS | |
| Short Description | Utilities for Filesystem operations | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | STU2 | CCMS for DB2 for OS/390 |
| Created | 20080605 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_DB2_FILE_UTILS has no interface implemented.
Friends
Class CL_DB2_FILE_UTILS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | C | 20080617 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | check if directory exists | 20081127 | |
| 2 | Static method | Public | Constructor | 20080617 | ||
| 3 | Static method | Public | Method | 20080617 | ||
| 4 | Static method | Private | Method | 20080617 | ||
| 5 | Static method | Public | Method | 20080617 | ||
| 6 | Static method | Public | Method | get file | 20101102 | |
| 7 | Static method | Public | Method | writes file | 20101022 |
Events
Class CL_DB2_FILE_UTILS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | DIR_ENTRY | Public | See coding | 20080617 | begin of DIR_ENTRY,
DIRNAME(75) TYPE C, " name of directory. (possibly truncated.)
NAME(75) TYPE C, " name of entry. (possibly truncated.)
TYPE(10) TYPE C, " type of entry.
LEN(8) TYPE P DECIMALS 0, " length in bytes.
OWNER(8) TYPE C, " owner of the entry.
MTIME(6) TYPE P DECIMALS 0, " last modification date, seconds since 1970
MODE(9) TYPE C, " like "rwx-r-x--x": protection mode.
SUBRC(4) TYPE C,
ERRNO(3) TYPE C,
ERRMSG(40) TYPE C,
MOD_DATE type D,
MOD_TIME TYPE T, " hh:mm:ss
MARKER(1) TYPE C,
END OF DIR_ENTRY
|
||
| 2 | DIR_LIST | Public | See coding | 20080617 | DIR_LIST type standard table of DIR_ENTRY with key name
|
Method Signatures
Method CHECK_DIRECTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DIR_NAME | Call by reference | Type reference (TYPE) | C | 20081127 | ||||
| 2 | EXISTS | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20081127 |
Method CHECK_DIRECTORY on class CL_DB2_FILE_UTILS has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_DB2_FILE_UTILS has no parameter.
Method CLASS_CONSTRUCTOR on class CL_DB2_FILE_UTILS has no exception.
Method CLEANUP_DIRECTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DELETE_DATE | Call by reference | Type reference (TYPE) | D | 20080617 | ||||
| 2 | DIR_NAME | Call by reference | Type reference (TYPE) | C | 20080617 | ||||
| 3 | PATTERN | Call by reference | Type reference (TYPE) | STRING | 20080617 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20080617 |
Method CONVERT_TIMESTAMP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DATE | Call by reference | Type reference (TYPE) | D | 20080617 | ||||
| 2 | GMTIME | Call by reference | Type reference (TYPE) | I | 20080617 | ||||
| 3 | TIME | Call by reference | Type reference (TYPE) | T | 20080617 |
Method CONVERT_TIMESTAMP on class CL_DB2_FILE_UTILS has no exception.
Method READ_DIRECTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DIR_LIST | Value transfer | Type reference (TYPE) | DIR_LIST | 20080617 | ||||
| 2 | DIR_NAME | Call by reference | Type reference (TYPE) | C | 20080617 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20080617 |
Method READ_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILECONTENT | Call by reference | Type reference (TYPE) | DB2JESOUT_TAB | Table of Strings | 20110131 | |||
| 2 | FILEPATH | Call by reference | Type reference (TYPE) | DB2FILEPATH | 20101104 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DB2: root class regarding exceptions | 20110201 |
Method WRITE_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILEPATH | Call by reference | Type reference (TYPE) | DB2FILEPATH | 20110131 | ||||
| 2 | OUTPUT | Call by reference | Type reference (TYPE) | DB2JESOUT_TAB | Table of Strings | 20101022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | System Exceptions Accessing File | 20110411 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 731 |