SAP ABAP Interface IF_BTF_DOCUMENT (SAP BTF Document Interface)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BTF (Application Component) Business Text Framework
     ⤷ SBTF (Package) Business Text Framework
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_BTF_DOCUMENT SAP BTF Document Class 20030822
Properties
Interface IF_BTF_DOCUMENT  
Short Description SAP BTF Document Interface    
General Data
Package SBTF   Business Text Framework 
Created 20011108   SAP 
Last changed 20040930   SAP 
Unicode checks active    
Forward declarations
Interface IF_BTF_DOCUMENT has no forward declaration.
Interfaces
Interface IF_BTF_DOCUMENT has no interface.
Friends
Interface IF_BTF_DOCUMENT has no friend.
Attributes
Interface IF_BTF_DOCUMENT has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 COLLECT_FIELDS Instance method Public Method Find fields 20011109
2 COLLECT_LINKS Instance method Public Method Find Links 20011109
3 CONCATENATE Instance method Public Method Assign attachment 20011109
4 CONVERT_CONTENT_TO_ITF Instance method Public Method Convert Content to ITF and Get 20020513
5 GET_CONFIGURATION Instance method Public Method Get Configuration 20020612
6 GET_CONTENT Instance method Public Method Get Content 20011109
7 GET_FIELD_SYNTAX Instance method Public Method Gets Field Display 20021210
8 PARSE_ONLY Instance method Public Method Parse Only (For Test Purposes) 20020916
9 PRINT Instance method Public Method Internal usage 20020515
10 PRINT_WITH_CONFIGURATION Instance method Public Method Internal usage 20020515
11 REPLACE_FIELDS Instance method Public Method Field Replacement 20011109
12 REPLACE_LINKS Instance method Public Method Link Replacement 20011109
13 SET_CONTENT Instance method Public Method Set Content 20011109
Events
Interface IF_BTF_DOCUMENT has no event.
Types
Interface IF_BTF_DOCUMENT has no local type.
Method Signatures

Method COLLECT_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020916
2 Returning FIELD_ADMINISTRATION Value transfer Object reference (TYPE REF TO) IF_BTF_FIELD_ADMINISTRATION Feldadministrationsreferenz 20011109
# Exception Resumable Description Created on
1 CX_BTF_PARAMETER_ERROR BTF Ausnahme: Parameterfehler 20020426
2 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020916
3 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20011210

Method COLLECT_LINKS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020916
2 Returning LINK_ADMINISTRATION Value transfer Object reference (TYPE REF TO) IF_BTF_LINK_ADMINISTRATION Linkadministrationsreferenz 20011109
# Exception Resumable Description Created on
1 CX_BTF_PARAMETER_ERROR BTF Ausnahme: Parameterfehler 20020426
2 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020916
3 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20011210

Method CONCATENATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020916
2 Importing DOCUMENT Call by reference Object reference (TYPE REF TO) IF_BTF_DOCUMENT Dokumentreferenz 20011109
# Exception Resumable Description Created on
1 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020916
2 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20011210

Method CONVERT_CONTENT_TO_ITF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020513
2 Exporting ITF_TEXT Value transfer Type reference (TYPE) TSFTEXT Smart Forms: Text 20020513
3 Exporting ITF_TEXT_HEADER Value transfer Type reference (TYPE) THEAD SAPscript: Text-Header 20020513
# Exception Resumable Description Created on
1 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020516
2 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20020514

Method GET_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020612

Method GET_CONFIGURATION on Interface IF_BTF_DOCUMENT has no exception.

Method GET_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ENCODING Value transfer Type reference (TYPE) STRING Codierung des Dokuments (z. B. 'utf-8') 20020415
2 Exporting LANGUAGE Value transfer Type reference (TYPE) TDSPRAS Sprachenschlüssel 20020621
3 Exporting TEXT Value transfer Type reference (TYPE) XSTRING Text des Dokuments 20011112

Method GET_CONTENT on Interface IF_BTF_DOCUMENT has no exception.

Method GET_FIELD_SYNTAX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FIELD Call by reference Object reference (TYPE REF TO) CL_BTF_FIELD SAP BTF Field 20021210
2 Importing SIZE Call by reference Type reference (TYPE) I Länge 20021210
3 Exporting STRING Call by reference Type reference (TYPE) STRING Darstellung als String 20021211
4 Importing USE_DESCR Call by reference Type reference (TYPE) C Verwende Beschreibung 20021211
5 Exporting XSTRING Call by reference Type reference (TYPE) XSTRING Darstellung binär 20021211
# Exception Resumable Description Created on
1 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20021211

Method PARSE_ONLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020916
# Exception Resumable Description Created on
1 CX_BTF_PARAMETER_ERROR BTF Ausnahme: Parameterfehler 20020916
2 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020916
3 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20020916

Method PRINT Signature

Method PRINT on Interface IF_BTF_DOCUMENT has no parameter.
# Exception Resumable Description Created on
1 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020516
2 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20020515

Method PRINT_WITH_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020515
# Exception Resumable Description Created on
1 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020516
2 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20020515

Method REPLACE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020916
2 Importing FIELD_ADMINISTRATION Call by reference Object reference (TYPE REF TO) IF_BTF_FIELD_ADMINISTRATION Feldadministrationsreferenz 20011109
3 Importing REPLACE_BEHAVIOUR Value transfer Type reference (TYPE) I 1 Ersetzungsverhalten 20011109
# Exception Resumable Description Created on
1 CX_BTF_PARAMETER_ERROR BTF Ausnahme: Parameterfehler 20020123
2 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020916
3 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20011210

Method REPLACE_LINKS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIGURATION Value transfer Object reference (TYPE REF TO) IF_BTF_CONFIGURATION SAP BTF Konfiguration 20020916
2 Importing LINK_ADMINISTRATION Call by reference Object reference (TYPE REF TO) IF_BTF_LINK_ADMINISTRATION Linkadministrationsreferenz 20011109
# Exception Resumable Description Created on
1 CX_BTF_PARAMETER_ERROR BTF Ausnahme: Parameterfehler 20020426
2 CX_BTF_RUNTIME_ERROR BTF Ausnahme: Laufzeitfehler 20020916
3 CX_BTF_SYSTEM_ERROR BTF Ausnahme: Systemfehler 20011210

Method SET_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CLEAN Call by reference Type reference (TYPE) I 1 Benutzung von Tidy '0' oder '1' 20030918
2 Importing ENCODING Call by reference Type reference (TYPE) STRING Codierung des Dokuments (z. B. 'utf-8') 20020415
3 Importing TEXT Call by reference Type reference (TYPE) XSTRING Text des Dokuments 20011112

Method SET_CONTENT on Interface IF_BTF_DOCUMENT has no exception.
History
Last changed by/on SAP  20040930 
SAP Release Created in 620