SAP ABAP Interface /IPRO/IF_DOCB_TEMPLATE (Template interface)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-GTF-DOB (Application Component) Document Builder
⤷
/IPRO/INTERFACE (Package) BADI's, Interfaces
SAP_BS_FND (Software Component) SAP Business Suite Foundation⤷
CA-GTF-DOB (Application Component) Document Builder⤷
/IPRO/INTERFACE (Package) BADI's, Interfaces
Properties
| Interface | /IPRO/IF_DOCB_TEMPLATE | |
| Short Description | Template interface |
General Data
| Package | /IPRO/INTERFACE | BADI's, Interfaces |
| Created | 20031106 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
Interface /IPRO/IF_DOCB_TEMPLATE has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /IPRO/IF_MODEL | Document Builder Model Interface | 20031215 |
Friends
Interface /IPRO/IF_DOCB_TEMPLATE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_TMPLSTAT_ACTIVE | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | '4' | Template Status | 20070515 | |
| 2 | GC_TMPLSTAT_APPROVAL | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | '6' | Template Status | 20070404 | |
| 3 | GC_TMPLSTAT_DRAFT | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | '1' | Template Status | 20070404 | |
| 4 | GC_TMPLSTAT_INACTIVE | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | '7' | Template Status | 20070515 | |
| 5 | GC_TMPLSTAT_REJECTED | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | 'A' | Template Status | 20070404 | |
| 6 | GC_TMPLSTAT_RELEASED | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | '4' | Template Status | 20070404 | |
| 7 | GC_TMPLSTAT_SAVED | Constant | Public | Type reference (TYPE) | /IPRO/TMPLSTAT | '2' | Template Status | 20070404 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_DESCR |
Instance method | Public | Method | Get the template description | 20031204 |
| 2 | GET_DOC |
Instance method | Public | Method | Get the related document for the template | 20031204 |
| 3 | GET_DOC_DATA |
Instance method | Public | Method | Get the data for the template | 20031205 |
| 4 | GET_HEADER |
Instance method | Public | Method | Get the header information for the template | 20031205 |
| 5 | GET_NAME |
Instance method | Public | Method | Get the template name | 20031204 |
| 6 | GET_OFFICE |
Instance method | Public | Method | Get the office of the template (for office template) | 20031204 |
| 7 | GET_TYPE |
Instance method | Public | Method | Get the template type | 20031204 |
| 8 | GET_USER |
Instance method | Public | Method | Get the user Id for the template (for user template) | 20031204 |
| 9 | SET_DESCR |
Instance method | Public | Method | Set the template description | 20031204 |
| 10 | SET_DOC |
Instance method | Public | Method | Set the document node for the template | 20031204 |
| 11 | SET_DOC_DATA |
Instance method | Public | Method | Set the data for the template | 20031205 |
| 12 | SET_HEADER |
Instance method | Public | Method | Set the header information for the template | 20031205 |
| 13 | SET_NAME |
Instance method | Public | Method | Set the template name | 20031204 |
| 14 | SET_OFFICE |
Instance method | Public | Method | Set the office of the template (for office template) | 20031204 |
| 15 | SET_TYPE |
Instance method | Public | Method | Set the template type | 20031204 |
| 16 | SET_USER |
Instance method | Public | Method | Set the user Id for the template (for user template) | 20031204 |
| 17 | WRITE_TO_DB |
Instance method | Public | Method | Persist the template to database | 20031204 |
Events
Interface /IPRO/IF_DOCB_TEMPLATE has no event.
Types
Interface /IPRO/IF_DOCB_TEMPLATE has no local type.
Method Signatures
Method GET_DESCR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
PRV_DESCR | Value transfer | Type reference (TYPE) | /IPRO/DESCR | Description | 20031204 |
Method GET_DESCR on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRR_DOC | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document | 20031204 |
Method GET_DOC on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_DOC_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRR_DATA | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031205 |
Method GET_DOC_DATA on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_HEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRR_HEADER | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031205 |
Method GET_HEADER on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRV_NAME | Value transfer | Type reference (TYPE) | /IPRO/TMPL_NAME | Defines the name of a template | 20031204 |
Method GET_NAME on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_OFFICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRV_OFFICE | Value transfer | Type reference (TYPE) | /IPRO/OFFICE | This data element defines an office | 20031204 |
Method GET_OFFICE on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRV_TYPE | Value transfer | Type reference (TYPE) | /IPRO/TMPL_TYP | This data element defines template types. | 20031205 |
Method GET_TYPE on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method GET_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRV_USER | Value transfer | Type reference (TYPE) | USRCHAR20 | User field with 20 characters | 20031204 |
Method GET_USER on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_DESCR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PIV_DESCR | Call by reference | Type reference (TYPE) | /IPRO/DESCR | Description | 20031204 |
Method SET_DESCR on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIR_DOC | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Attribute | 20031204 |
Method SET_DOC on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_DOC_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIR_DATA | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031205 |
Method SET_DOC_DATA on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_HEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIR_HEADER | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031205 |
Method SET_HEADER on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_NAME | Call by reference | Type reference (TYPE) | /IPRO/TMPL_NAME | Defines the name of a template | 20031204 |
Method SET_NAME on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_OFFICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_OFFICE | Call by reference | Type reference (TYPE) | /IPRO/OFFICE | This data element defines an office | 20031204 |
Method SET_OFFICE on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_TYPE | Call by reference | Type reference (TYPE) | /IPRO/TMPL_TYP | This data element defines template types. | 20031204 |
Method SET_TYPE on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method SET_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_USER | Call by reference | Type reference (TYPE) | USRCHAR20 | User field with 20 characters | 20031204 |
Method SET_USER on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
Method WRITE_TO_DB Signature
Method WRITE_TO_DB on Interface /IPRO/IF_DOCB_TEMPLATE has no parameter.
Method WRITE_TO_DB on Interface /IPRO/IF_DOCB_TEMPLATE has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 10A |
