SAP ABAP Interface /IPRO/IF_CONTENT (Document Builder Content 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_CONTENT  
Short Description Document Builder Content Interface    
General Data
Package /IPRO/INTERFACE   BADI's, Interfaces 
Created 20031107   SAP 
Last changed 20110908   SAP 
Unicode checks active    
Forward declarations
Interface /IPRO/IF_CONTENT has no forward declaration.
Interfaces
# Interface Abstract Final Description Created on
1 /IPRO/IF_MODEL Document Builder Model Interface 20040203
2 /IPRO/IF_OBSERVER Document Builder Observer Interface 20040609
3 /IPRO/IF_SUBJECT Document Builder Subject Interface 20040203
Friends
Interface /IPRO/IF_CONTENT has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_CONFG_DELETE_LOGICAL Constant Public Type reference (TYPE) /IPRO/CONFIG 'DELETE_IS_LOGICAL' Configuration Parameter 20050607
Methods
# Method Level Visibility Method type Description Created on
1 COMMIT Instance method Public Method Commit 20040417
2 GET_ALTERNATIVE_ELEMENTS Instance method Public Method get a list of alternative elements 20060907
3 GET_CONFIGS Instance method Public Method Get the configuration variable data 20040420
4 GET_DELETE_IS_LOGICAL Instance method Public Method get value of config variable for doc delete(log or physical) 20050606
5 GET_DOCB_FACTORY Instance method Public Method Get document builder factory 20040202
6 GET_DOCUMENT_EXIST Instance method Public Method get guid of document 20040729
7 GET_ELEMENT_FACTORY Instance method Public Method Get element factory instance 20040121
8 GET_LABEL Instance method Public Method Label of the content 20040202
9 GET_LIST_OF_CONTENTS Static method Public Method List of content objects 20040202
10 GET_NAME Instance method Public Method Name of the content 20040202
11 GET_OVERLAYS Instance method Public Method Get all Overlay pages 20040614
12 GET_PARAMETER_BY_NAME Instance method Public Method Returns a parameter value by given name 20070515
13 GET_REFERENCE Instance method Public Method get reference object for variable 20050510
14 GET_RULE_PROXY Instance method Public Method Get the rule proxy 20050425
15 GET_TABLE_DATA_NAMES Instance method Public Method unique list of data tables defined in /ipro/tvar_cmp 20040116
16 GET_USER_ELEMENTS Static method Public Method Get a list of the user elements 20060121
17 GET_USER_STAT_ACTIVATION Instance method Public Method Is User Status active for content 20080220
18 GET_USER_TEMPLATES Static method Public Method Get a list of the user templates 20060121
19 GET_VARIABLE_FACTORY Instance method Public Method Get variable factory instance 20040301
20 GET_VAR_ROOT Instance method Public Method get var root 20040421
21 GET_WORKFLOW_STATUS Instance method Public Method is WF active or not 20061213
22 GET_WORKFLOW_STATUS_ELM_CHANGE Instance method Public Method is WF active for templates triggered by elm change 20070604
23 HOLD_UPDATE Instance method Public Method hold the update decisions 20060627
24 READ_UPDATE Instance method Public Method read the update decisions 20060628
25 WRITE_UPDATE Instance method Public Method write the update decisions to the database 20060628
Events
Interface /IPRO/IF_CONTENT has no event.
Types
Interface /IPRO/IF_CONTENT has no local type.
Method Signatures

Method COMMIT Signature

Method COMMIT on Interface /IPRO/IF_CONTENT has no parameter.
Method COMMIT on Interface /IPRO/IF_CONTENT has no exception.

Method GET_ALTERNATIVE_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIS_ELEMENT Value transfer Type reference (TYPE) /IPRO/S_ELMNT_ID Structure for element identification 20060907
2 Returning PRT_ALT_ELEMENTS Value transfer Type reference (TYPE) /IPRO/TT_STDELMRES Element IDs 20060907

Method GET_ALTERNATIVE_ELEMENTS on Interface /IPRO/IF_CONTENT has no exception.

Method GET_CONFIGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_CONTENT Value transfer Type reference (TYPE) /IPRO/CONTENT Content Identifier 20040420
2 Returning PRT_CONFIGS Value transfer Type reference (TYPE) /IPRO/TT_CONFIGS Table of configuration variables 20040420

Method GET_CONFIGS on Interface /IPRO/IF_CONTENT has no exception.

Method GET_DELETE_IS_LOGICAL Signature

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

Method GET_DELETE_IS_LOGICAL on Interface /IPRO/IF_CONTENT has no exception.

Method GET_DOCB_FACTORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRO_DOCB_FACTORY Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_FACTORY Document Builder Factory 20040202

Method GET_DOCB_FACTORY on Interface /IPRO/IF_CONTENT has no exception.

Method GET_DOCUMENT_EXIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_DOCMNT Call by reference Type reference (TYPE) GUID Globally Unique Identifier 20040729
2 Importing PIV_DOCMNT_ID Call by reference Type reference (TYPE) /IPRO/DOCMNT_ID Document Number 20040729
3 Returning PRV_GUID Value transfer Type reference (TYPE) GUID Globally Unique Identifier 20040729

Method GET_DOCUMENT_EXIST on Interface /IPRO/IF_CONTENT has no exception.

Method GET_ELEMENT_FACTORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRO_ELEMENT_FACTORY Value transfer Object reference (TYPE REF TO) /IPRO/IF_ELEMENT_FACTORY Element Factory Interface 20040121

Method GET_ELEMENT_FACTORY on Interface /IPRO/IF_CONTENT has no exception.

Method GET_LABEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_LABEL Value transfer Type reference (TYPE) STRING Label 20040202

Method GET_LABEL on Interface /IPRO/IF_CONTENT has no exception.

Method GET_LIST_OF_CONTENTS 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) STRING The name of the context 20040202
2 Returning PRT_CONTENTLIST Value transfer Type reference (TYPE) /IPRO/TT_CONTENTS Table type for /ipro/if_content 20040202

Method GET_LIST_OF_CONTENTS on Interface /IPRO/IF_CONTENT 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) STRING Name 20040202

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

Method GET_OVERLAYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_CONTENT Value transfer Type reference (TYPE) /IPRO/CONTENT Content Identifier 20040614
2 Returning PRT_OVERLAYS Value transfer Type reference (TYPE) /IPRO/TT_OVERLAYS Returning all Overlay pages 20040614

Method GET_OVERLAYS on Interface /IPRO/IF_CONTENT has no exception.

Method GET_PARAMETER_BY_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) STRING 20070515
2 Returning PRV_VALUE Value transfer Type reference (TYPE) STRING 20070515
# Exception Resumable Description Created on
1 /IPRO/CX_DB_EXCPT 20070515

Method GET_REFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_CMODIF Call by reference Type reference (TYPE) /IPRO/CMODIF SPACE Content Modifier 20050510
2 Importing PIV_EFFT_DTE Call by reference Type reference (TYPE) BEGDA SY-DATUM Start Date 20050510
3 Importing PIV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key 20050510
4 Importing PIV_VARB Call by reference Type reference (TYPE) /IPRO/VARB Variable 20050510
5 Returning PRO_TEXT Value transfer Object reference (TYPE REF TO) /IPRO/CL_DOCB_TEXT Document Builder Element Text Class 20050510

Method GET_REFERENCE on Interface /IPRO/IF_CONTENT has no exception.

Method GET_RULE_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_RULE_PROXY Value transfer Object reference (TYPE REF TO) /IPRO/CL_RULE_PROXY Rule Proxy reference 20050425

Method GET_RULE_PROXY on Interface /IPRO/IF_CONTENT has no exception.

Method GET_TABLE_DATA_NAMES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_CMODIF Call by reference Type reference (TYPE) STRING 20040629
2 Returning PRT_TBL_NAMES Value transfer Type reference (TYPE) /IPRO/TT_OBJECT_LIST List of object 20040116

Method GET_TABLE_DATA_NAMES on Interface /IPRO/IF_CONTENT has no exception.

Method GET_USER_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting DATA Call by reference Type reference (TYPE) ANY TABLE 20060121
2 Importing IV_USERNAME Call by reference Type reference (TYPE) SYUNAME User Name 20060121

Method GET_USER_ELEMENTS on Interface /IPRO/IF_CONTENT has no exception.

Method GET_USER_STAT_ACTIVATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_USRSTAT_ACTIVE Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20080220

Method GET_USER_STAT_ACTIVATION on Interface /IPRO/IF_CONTENT has no exception.

Method GET_USER_TEMPLATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting DATA Call by reference Type reference (TYPE) ANY TABLE 20060121
2 Importing IV_USERNAME Call by reference Type reference (TYPE) SYUNAME User Name 20060121

Method GET_USER_TEMPLATES on Interface /IPRO/IF_CONTENT has no exception.

Method GET_VARIABLE_FACTORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRO_VARIABLE_FACTORY Value transfer Object reference (TYPE REF TO) /IPRO/IF_VARIABLE_FACTORY Factory for variables 20040301

Method GET_VARIABLE_FACTORY on Interface /IPRO/IF_CONTENT has no exception.

Method GET_VAR_ROOT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_VAR_ROOT Value transfer Type reference (TYPE) STRING 20040421

Method GET_VAR_ROOT on Interface /IPRO/IF_CONTENT has no exception.

Method GET_WORKFLOW_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_WF_STATUS Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20061213

Method GET_WORKFLOW_STATUS on Interface /IPRO/IF_CONTENT has no exception.

Method GET_WORKFLOW_STATUS_ELM_CHANGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_WF_STATUS Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20070604

Method GET_WORKFLOW_STATUS_ELM_CHANGE on Interface /IPRO/IF_CONTENT has no exception.

Method HOLD_UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIT_UPDATE_DATA Value transfer Type reference (TYPE) /IPRO/TTUPDATELOG table type for update report data 20060627

Method HOLD_UPDATE on Interface /IPRO/IF_CONTENT has no exception.

Method READ_UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PET_UPDATE_DATA Value transfer Type reference (TYPE) /IPRO/TTUPDATELOG table type for update report data 20060628
2 Importing PIV_DOCUMENT Call by reference Type reference (TYPE) GUID Document ID 20080814

Method READ_UPDATE on Interface /IPRO/IF_CONTENT has no exception.

Method WRITE_UPDATE Signature

Method WRITE_UPDATE on Interface /IPRO/IF_CONTENT has no parameter.
Method WRITE_UPDATE on Interface /IPRO/IF_CONTENT has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 10A