SAP ABAP Interface /XNFE/IF_DOCUMENT (Interface for Document Access)
Hierarchy
☛
SLL-NFE (Software Component) xNFE
⤷
SLL-NFE-MGM (Application Component) NF-e: Communication Management & Monitoring
⤷
/XNFE/USICORE (Package) User Interface of Core Components (NF-e and CT-e)
SLL-NFE (Software Component) xNFE⤷
SLL-NFE-MGM (Application Component) NF-e: Communication Management & Monitoring⤷
/XNFE/USICORE (Package) User Interface of Core Components (NF-e and CT-e)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /XNFE/CL_DOCUMENT | Base Class of Document | 20111023 |
Properties
| Interface | /XNFE/IF_DOCUMENT | |
| Short Description | Interface for Document Access |
General Data
| Package | /XNFE/USICORE | User Interface of Core Components (NF-e and CT-e) |
| Created | 20110926 | SAP |
| Last changed | 20141107 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | /XNFE/IF_WD_CONSTANTS | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface /XNFE/IF_DOCUMENT has no interface.
Friends
Interface /XNFE/IF_DOCUMENT has no friend.
Attributes
Interface /XNFE/IF_DOCUMENT has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | DOWNLOAD |
Instance method | Public | Method | Download/Display | 20120321 |
| 2 | GET_DETAILS |
Instance method | Public | Method | Return XML-Mapped Proxy Structure for Current Document | 20111020 |
| 3 | GET_DOCTYPE |
Instance method | Public | Method | Return Document Type (NF-e / CT-e) | 20110926 |
| 4 | GET_FPM_HEADER |
Instance method | Public | Method | Access to Properties of FPM Header Area | 20120123 |
| 5 | GET_GUID |
Instance method | Public | Method | Return GUID of Currently Processed Document | 20110926 |
| 6 | GET_ID |
Instance method | Public | Method | Return Currently Set Access Key | 20110926 |
| 7 | GET_OVERVIEW_DETAILS |
Instance method | Public | Method | Return CT-e/NF-e Data for Summary Details | 20111221 |
| 8 | GET_PROCTYP |
Instance method | Public | Method | Return Current Process Type for Selected Document | 20111020 |
| 9 | GET_RELATED |
Instance method | Public | Method | Return Document Reference of Related Document | 20120123 |
| 10 | GET_SELECTED |
Instance method | Public | Method | Return Selected Details About Selected Document | 20120104 |
| 11 | GET_STATUS |
Instance method | Public | Method | Return status table of processed document | 20120308 |
| 12 | GET_XML |
Instance method | Public | Method | Return XML for Currently Selected Document | 20110926 |
| 13 | GET_XMLVERSION |
Instance method | Public | Method | Return XML Version for Currently Selected Document | 20131022 |
| 14 | RESET |
Instance method | Public | Method | Reset All Data (No More Documents Being Processed) | 20110926 |
| 15 | SET_SELECTED |
Instance method | Public | Method | Set Selected Details About a Selected Document | 20120109 |
| 16 | SET_SELECTED_GUID |
Instance method | Public | Method | Set Unique GUID to a Document | 20140224 |
| 17 | SET_SELECTED_ID |
Instance method | Public | Method | Set Unique Key to a Document | 20140222 |
Events
Interface /XNFE/IF_DOCUMENT has no event.
Types
Interface /XNFE/IF_DOCUMENT has no local type.
Method Signatures
Method DOWNLOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20120321 | ||
| 2 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | /XNFE/ID | 44-stelliger Zugriffsschlüssel | 20120321 | ||
| 3 | Importing |
IV_TYPE | Call by reference | Type reference (TYPE) | /XNFE/DOWNLOAD_TYPE | Typ des Downloads | 20120321 |
Method DOWNLOAD on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20111020 | ||
| 2 |  Returning |
RT_STRUCTURES | Value transfer | Type reference (TYPE) | /XNFE/PROXY_STRUCTURES_T | Identifikation mit Referenz Proxystrukturen | 20120110 |
Method GET_DETAILS on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_DOCTYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_DOCTYPE | Value transfer | Type reference (TYPE) | /XNFE/DOCTYPE | Belegart (CTE/NFE) | 20110926 |
Method GET_DOCTYPE on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_FPM_HEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_HEADER | Value transfer | Object reference (TYPE REF TO) | /XNFE/IF_FPM_HEADER | Zugriffe auf Beschaffenheit FPM Header Bereichs | 20120123 |
Method GET_FPM_HEADER on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_GUID | Value transfer | Type reference (TYPE) | /XNFE/GUID_16 | Primärschlüssel als GUID im 'RAW' Format | 20110926 |
Method GET_GUID on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_ID | Value transfer | Type reference (TYPE) | /XNFE/ID | 44-stelliger Zugriffsschlüssel | 20110926 |
Method GET_ID on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_OVERVIEW_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20111221 | ||
| 2 | Returning |
RT_SDETAIL | Value transfer | Type reference (TYPE) | /XNFE/WD_SDETAIL_T | WD TT für Kurzdetails | 20111221 |
Method GET_OVERVIEW_DETAILS on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_PROCTYP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_PROCTYP | Value transfer | Type reference (TYPE) | /XNFE/PROCTYP | Prozesstyp | 20111020 |
Method GET_PROCTYP on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_RELATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20120123 | ||
| 2 | Importing |
IV_ACTION | Call by reference | Type reference (TYPE) | FPM_EVENT_ID | ID des FPM-Ereignisses | 20120123 | ||
| 3 | Returning |
RO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /XNFE/IF_DOCUMENT | Verwandtes Dokument | 20120123 |
Method GET_RELATED on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_SELECTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_SELECTED | Call by reference | Type reference (TYPE) | ANY | Selektierter Eintrag | 20120104 |
Method GET_SELECTED on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_STATUS | Call by reference | Type reference (TYPE) | ANY TABLE | Statustabelle | 20120308 | ||
| 2 | Importing |
IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20120308 | ||
| 3 | Importing |
IV_LOCK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Sperre setzten | 20120308 |
Method GET_STATUS on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20110926 | ||
| 2 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | /XNFE/ID | 44-stelliger Zugriffsschlüssel | 20110926 | ||
| 3 | Importing |
IV_TYPE | Call by reference | Type reference (TYPE) | CHAR2 | /XNFE/IF_WD_CONSTANTS=>CV_XML-NORMAL | Komponente der Versionsnummer | 20110926 | |
| 4 | Returning |
RV_XML | Value transfer | Type reference (TYPE) | /XNFE/XMLSTRING | XML-String | 20110926 |
Method GET_XML on Interface /XNFE/IF_DOCUMENT has no exception.
Method GET_XMLVERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_XMLVERSION | Value transfer | Type reference (TYPE) | /XNFE/XML_VERSION | XML-Versionen (NFe, CTe, Events) | 20131022 |
Method GET_XMLVERSION on Interface /XNFE/IF_DOCUMENT has no exception.
Method RESET Signature
Method RESET on Interface /XNFE/IF_DOCUMENT has no parameter.
Method RESET on Interface /XNFE/IF_DOCUMENT has no exception.
Method SET_SELECTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_SELECTED | Call by reference | Type reference (TYPE) | ANY | Selektierter Eintrag | 20120109 |
Method SET_SELECTED on Interface /XNFE/IF_DOCUMENT has no exception.
Method SET_SELECTED_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_GUID | Call by reference | Type reference (TYPE) | /XNFE/GUID_16 | Primärschlüssel als GUID im 'RAW' Format | 20140224 |
Method SET_SELECTED_GUID on Interface /XNFE/IF_DOCUMENT has no exception.
Method SET_SELECTED_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | /XNFE/ID | 44-stelliger Zugriffsschlüssel | 20140222 |
Method SET_SELECTED_ID on Interface /XNFE/IF_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20141107 |
| SAP Release Created in | 900 |
