SAP ABAP Interface /IPRO/IF_DOCUMENT (Document Builder Document Interface)
Hierarchy
☛ 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_DOCUMENT  
Short Description Document Builder Document Interface    
General Data
Package /IPRO/INTERFACE   BADI's, Interfaces 
Created 20031107   SAP 
Last changed 20130531   SAP 
Unicode checks active    
Forward declarations
Interface /IPRO/IF_DOCUMENT has no forward declaration.
Interfaces
# Interface Abstract Final Description Created on
1 /IPRO/IF_ACTION Document Builder Action Interface 20031113
2 /IPRO/IF_MESSAGING Interface for message handling 20031113
3 /IPRO/IF_MODEL Document Builder Model Interface 20031113
4 /IPRO/IF_OUTPUT Generating output for Document Bulder 20040527
5 /IPRO/IF_SUBJECT Document Builder Subject Interface 20031113
6 /IPRO/IF_VERSIONS Version Handling for Document Builder 20040628
Friends
Interface /IPRO/IF_DOCUMENT has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_DOCSTAT_APPROVAL Constant Public Type reference (TYPE) /IPRO/DOCSTAT '6' Document in status 'Approval' 20041209
2 GC_DOCSTAT_ARCHIVED_EXTERNALLY Constant Public Type reference (TYPE) /IPRO/DOCSTAT '7' Document in status 'Archived Externally' 20070409
3 GC_DOCSTAT_CHECKED_OUT_EXT Constant Public Type reference (TYPE) /IPRO/DOCSTAT 'C' Document in status 'Checked out external' 20070409
4 GC_DOCSTAT_CHECKED_OUT_INT Constant Public Type reference (TYPE) /IPRO/DOCSTAT 'B' Document in status 'Checked out internal' 20070409
5 GC_DOCSTAT_COMPLETED Constant Public Type reference (TYPE) /IPRO/DOCSTAT '8' Document in status 'Completed' 20070409
6 GC_DOCSTAT_DELETED Constant Public Type reference (TYPE) /IPRO/DOCSTAT '5' Document in status 'Deleted' 20041207
7 GC_DOCSTAT_EXPIRED Constant Public Type reference (TYPE) /IPRO/DOCSTAT '9' Document in status 'Expired' 20070409
8 GC_DOCSTAT_HELD Constant Public Type reference (TYPE) /IPRO/DOCSTAT '1' Document in status 'Held' 20040624
9 GC_DOCSTAT_INACTIVE Constant Public Type reference (TYPE) /IPRO/DOCSTAT 'D' Document in status 'Inactive' 20070731
10 GC_DOCSTAT_REJECTED Constant Public Type reference (TYPE) /IPRO/DOCSTAT 'A' Document in status 'Rejcted' 20070404
11 GC_DOCSTAT_RELEASED Constant Public Type reference (TYPE) /IPRO/DOCSTAT '4' Document in status 'Released' 20041207
12 GC_DOCSTAT_SAVED Constant Public Type reference (TYPE) /IPRO/DOCSTAT '2' Document in status 'Saved' 20040624
13 GC_DOCSTAT_SUBMIT_FAILED Constant Public Type reference (TYPE) /IPRO/DOCSTAT '3' Document in status 'SubmitFailed' 20040625
14 GC_TYP_DOC Constant Public Type reference (TYPE) /IPRO/OBJ_TYP 'D' Object Type 20050519
15 GC_TYP_STMPL Constant Public Type reference (TYPE) /IPRO/OBJ_TYP 'T' Object Type 20050519
16 GC_TYP_UTMPL Constant Public Type reference (TYPE) /IPRO/OBJ_TYP 'X' Object Type 20050519
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ATTACHMENT Instance method Public Method Add an attachment to document 20040707
2 DELETE_ATTACHMENT Instance method Public Method Delete an attachment from the document 20040708
3 GET_CMODIF_VALUE Instance method Public Method get cmodif value 20040504
4 GET_CONTENT Instance method Public Method Get reference to content object 20040123
5 GET_DOCSL Instance method Public Method Get document selection 20080731
6 GET_DOCUMENT_ATTACHMENTS Instance method Public Method Return document attachments 20040706
7 GET_DOCUMENT_DATA Instance method Public Method Return document data node for a document 20031107
8 GET_DOCUMENT_HEADER Instance method Public Method Return document header data 20031107
9 GET_DOCUMENT_HEADER_FIELDS Instance method Public Method Get all document header fields in a structure 20080825
10 GET_EFFT_DTE Instance method Public Method get document effective date 20040109
11 GET_ELEMENT_LIST Instance method Public Method Return element list node for a document 20031107
12 GET_FORMAT Instance method Public Method Get document format (part of the docsl) 20080731
13 GET_LANGUAGE_VALUE Instance method Public Method get lalnguage value 20031223
14 GET_MODE Instance method Public Method Mode Display/Update/Create 20040419
15 GET_NAME Instance method Public Method Get the name of the document in user readable form 20050502
16 GET_REGSETS Instance method Public Method Get the regulation sets used for the document 20040226
17 GET_REGSETS_UPDATE Instance method Public Method Get Updates regulation sets 20110606
18 GET_TYPE Instance method Public Method Document/Template/UserTemplate 20040519
19 IS_CHANGED Instance method Public Method Changed? 20040625
20 IS_INTEGRATED Instance method Public Method Do we have an external document? 20090526
21 IS_VALID Instance method Public Method Is the document valid? 20051019
22 REGENERATE_OUTPUT Instance method Public Method Regenerate output in case the elements have been edited 20120714
23 SET_REGSETS Instance method Public Method Set the regulation sets used for the document 20040226
24 UPDATE_REPORT Instance method Public Method Run the update Report 20060626
Events
Interface /IPRO/IF_DOCUMENT has no event.
Types
Interface /IPRO/IF_DOCUMENT has no local type.
Method Signatures

Method ADD_ATTACHMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONTENT Call by reference Type reference (TYPE) XSTRING Content 20040707
2 Importing IV_CONTENT_TYPE Call by reference Type reference (TYPE) /IPRO/CONTENT_TYPE Content Type 20040707
3 Importing IV_FILENAME Call by reference Type reference (TYPE) STRING Filename 20041006
4 Importing IV_TITLE Call by reference Type reference (TYPE) /IPRO/TITLE Description 20040707
5 Returning RO_ATTACHMENT Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_ATTACHMENT DocB Document Attachment 20040707

Method ADD_ATTACHMENT on Interface /IPRO/IF_DOCUMENT has no exception.

Method DELETE_ATTACHMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ATTACHMENT Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_ATTACHMENT DocB Document Attachment 20040708

Method DELETE_ATTACHMENT on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_CMODIF_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CMODIF Value transfer Type reference (TYPE) /IPRO/TTEXT_T-CMODIF 20040504

Method GET_CMODIF_VALUE on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRO_CONTENT Value transfer Object reference (TYPE REF TO) /IPRO/IF_CONTENT Document Builder Content Object 20040123

Method GET_CONTENT on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_DOCSL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DOCSL Value transfer Type reference (TYPE) /IPRO/DOCSL Document Selection 20080731

Method GET_DOCSL on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_DOCUMENT_ATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRT_DOCUMENT_ATTACHMENTS Value transfer Type reference (TYPE) /IPRO/TT_ATTACH DocB Attachments 20040707

Method GET_DOCUMENT_ATTACHMENTS on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_DOCUMENT_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRR_DOCUMENT_DATA Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_ATTRIBUTE Attribute 20031107
# Exception Resumable Description Created on
1 /IPRO/CX_ATTRIBUTE_NOT_FOUND Specified child node not found 20031125

Method GET_DOCUMENT_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRR_DOCUMENT_HEADER Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_ATTRIBUTE Attribute 20031107
# Exception Resumable Description Created on
1 /IPRO/CX_ATTRIBUTE_NOT_FOUND Specified child node not found 20031125

Method GET_DOCUMENT_HEADER_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting PRS_DOC_DETAILS Value transfer Type reference (TYPE) /IPRO/SDOCUMENT_DETAILS document details 20080825
2 Exporting PRS_TEMP_DETAILS Value transfer Type reference (TYPE) /IPRO/S_TEMPL template details 20080825

Method GET_DOCUMENT_HEADER_FIELDS on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_EFFT_DTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DATE Value transfer Type reference (TYPE) BEGDA Start Date 20040109

Method GET_EFFT_DTE on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_ELEMENT_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRR_ELEMENT_LIST Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_ATTRIBUTE Attribute 20031107
# Exception Resumable Description Created on
1 /IPRO/CX_ATTRIBUTE_NOT_FOUND Specified child node not found 20031125

Method GET_FORMAT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_FORMAT Value transfer Type reference (TYPE) /IPRO/FRMAT Document Format 20080731

Method GET_FORMAT on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_LANGUAGE_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_LANGU Value transfer Type reference (TYPE) /IPRO/TTEXT_T-LANGU Language Key 20031223

Method GET_LANGUAGE_VALUE on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_MODE Value transfer Type reference (TYPE) /IPRO/MODE Display/Update/Create 20040419

Method GET_MODE on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_NAME Value transfer Type reference (TYPE) STRING Document name 20050502

Method GET_NAME on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_REGSETS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_RGSETS Value transfer Type reference (TYPE) /IPRO/TT_REGSETS Table of regulation sets 20040226

Method GET_REGSETS on Interface /IPRO/IF_DOCUMENT has no exception.

Method GET_REGSETS_UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_RGSETS Value transfer Type reference (TYPE) /IPRO/TT_REGSETS Table of regulation sets 20110606

Method GET_REGSETS_UPDATE on Interface /IPRO/IF_DOCUMENT 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/OBJ_TYP This data element defines the object types 20040519

Method GET_TYPE on Interface /IPRO/IF_DOCUMENT has no exception.

Method IS_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_CHANGED Value transfer Type reference (TYPE) SEU_BOOL Changed? 20040625

Method IS_CHANGED on Interface /IPRO/IF_DOCUMENT has no exception.

Method IS_INTEGRATED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_INTEGRATED Value transfer Type reference (TYPE) SEU_BOOL Boolean 20090526

Method IS_INTEGRATED on Interface /IPRO/IF_DOCUMENT has no exception.

Method IS_VALID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_VALID Value transfer Type reference (TYPE) SEU_BOOL Boolean 20051019

Method IS_VALID on Interface /IPRO/IF_DOCUMENT has no exception.

Method REGENERATE_OUTPUT Signature

Method REGENERATE_OUTPUT on Interface /IPRO/IF_DOCUMENT has no parameter.
Method REGENERATE_OUTPUT on Interface /IPRO/IF_DOCUMENT has no exception.

Method SET_REGSETS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RGSETS Call by reference Type reference (TYPE) /IPRO/TT_REGSETS Table of regulation sets 20040226

Method SET_REGSETS on Interface /IPRO/IF_DOCUMENT has no exception.

Method UPDATE_REPORT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_EXECUTE Call by reference Type reference (TYPE) XFELD run the update report 20080723
2 Importing PIV_IS_UPDATE_AVAILABLE Call by reference Type reference (TYPE) XFELD only check for updates 20080723
3 Exporting PRT_ELEMENT_UPDATES Call by reference Type reference (TYPE) /IPRO/TT_UI_ELEMENT_TABLE UI Element Table Structure 20080723
4 Exporting PRV_UPDATE_AVAILABLE Call by reference Type reference (TYPE) XFELD update available 20080723
# Exception Resumable Description Created on
1 /IPRO/CX_ATTRIBUTE Base class for attribute exceptions 20100902
History
Last changed by/on SAP  20130531 
SAP Release Created in 10A