SAP ABAP Class IF_FDT_DOC_PKG (Basic access to document packages)
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_FDT_DOCUMENT | General interface for document | 20080616 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_FDT_DOC_SPREADSHEET | FDT: Spreadsheet Interface | 20080616 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FDT_DOC_PKG | Class for document packages (like OOXML, ODF) | 20080616 |
Properties
| Class | IF_FDT_DOC_PKG | |
| Short Description | Basic access to document packages | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20080616 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  IF_FDT_DOC_PKG |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class IF_FDT_DOC_PKG has no interface implemented.
Friends
Class IF_FDT_DOC_PKG has no friend class.
Attributes
Class IF_FDT_DOC_PKG has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_FILENAMES |
Instance method | Public | Method | Get list of included files | 20080616 |
| 2 | GET_FILE_AS_XSTRING |
Instance method | Public | Method | Get a file from the package as XSTRING | 20080616 |
| 3 | GET_METADATA |
Instance method | Public | Method | Get the metadata of the document (table) | 20080616 |
| 4 | GET_META_CREATED |
Instance method | Public | Method | Get metadata created at | 20080616 |
| 5 | GET_META_CREATOR |
Instance method | Public | Method | Get metadata creator | 20080616 |
| 6 | GET_META_DESCRIPTION |
Instance method | Public | Method | Get metadata description | 20080616 |
| 7 | GET_META_KEYWORDS |
Instance method | Public | Method | Get metadata keywords | 20080616 |
| 8 | GET_META_LANGUAGE |
Instance method | Public | Method | Get metadata language | 20080616 |
| 9 | GET_META_LASTPRINTED |
Instance method | Public | Method | Get metadate lastprinted | 20080616 |
| 10 | GET_META_MODIFIED |
Instance method | Public | Method | Get metadata modified | 20080616 |
| 11 | GET_META_REVISION |
Instance method | Public | Method | Get metadata revision | 20080616 |
| 12 | GET_META_SUBJECT |
Instance method | Public | Method | Get metadata subject | 20080616 |
| 13 | GET_META_TITLE |
Instance method | Public | Method | Get metadata title | 20080616 |
| 14 | SET_XSTRING_AS_FILE |
Instance method | Public | Method | Add file to doc pkg given by XSTRING (overwrite existing!) | 20080616 |
Events
Class IF_FDT_DOC_PKG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_FILE | Public | See coding | File structure | 20080616 | BEGIN OF s_file,
name TYPE string,
date TYPE dats,
time TYPE tims,
size TYPE int4,
END OF s_file
|
|
| 2 | S_FILE_METADATA | Public | See coding | File Metadata structure | 20080616 | BEGIN OF s_file_metadata,
created TYPE string,
creator TYPE string,
description TYPE string,
keywords TYPE string,
language TYPE string,
lastprinted TYPE string,
modified TYPE string,
revision TYPE string,
subject TYPE string,
title TYPE string,
END OF s_file_metadata
|
|
| 3 | T_FILE | Public | See coding | Table of Files | 20080616 | t_file TYPE STANDARD TABLE OF s_file
|
Method Signatures
Method GET_FILENAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
FILENAMES | Call by reference | Type reference (TYPE) | IF_FDT_DOC_PKG=>T_FILE | Table of Files | 20080616 |
Method GET_FILENAMES on class IF_FDT_DOC_PKG has no exception.
Method GET_FILE_AS_XSTRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
ABS_FILENAME | Call by reference | Type reference (TYPE) | STRING | Absolut path and filename | 20080616 | ||
| 2 |  Returning |
X_FILE | Value transfer | Type reference (TYPE) | XSTRING | File content as XSTRING | 20080616 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_FDT_EXCEL_CORE |
20080616 |
Method GET_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
METADATA | Value transfer | Type reference (TYPE) | IF_FDT_DOC_PKG=>S_FILE_METADATA | Meta data of documents | 20080616 |
Method GET_METADATA on class IF_FDT_DOC_PKG has no exception.
Method GET_META_CREATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CREATED | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_CREATED on class IF_FDT_DOC_PKG has no exception.
Method GET_META_CREATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CREATOR | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_CREATOR on class IF_FDT_DOC_PKG has no exception.
Method GET_META_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DESCRIPTION | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_DESCRIPTION on class IF_FDT_DOC_PKG has no exception.
Method GET_META_KEYWORDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
KEYWORDS | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_KEYWORDS on class IF_FDT_DOC_PKG has no exception.
Method GET_META_LANGUAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
LANGUAGE | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_LANGUAGE on class IF_FDT_DOC_PKG has no exception.
Method GET_META_LASTPRINTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
LASTPRINTED | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_LASTPRINTED on class IF_FDT_DOC_PKG has no exception.
Method GET_META_MODIFIED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
MODIFIED | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_MODIFIED on class IF_FDT_DOC_PKG has no exception.
Method GET_META_REVISION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
REVISION | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_REVISION on class IF_FDT_DOC_PKG has no exception.
Method GET_META_SUBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
SUBJECT | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_SUBJECT on class IF_FDT_DOC_PKG has no exception.
Method GET_META_TITLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
TITLE | Value transfer | Type reference (TYPE) | STRING | 20080616 |
Method GET_META_TITLE on class IF_FDT_DOC_PKG has no exception.
Method SET_XSTRING_AS_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ABS_FILENAME | Call by reference | Type reference (TYPE) | STRING | 20080616 | |||
| 2 | Importing |
X_FILE | Call by reference | Type reference (TYPE) | XSTRING | 20080616 |
Method SET_XSTRING_AS_FILE on class IF_FDT_DOC_PKG has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
