SAP ABAP Interface /IPRO/IF_DOCB_VARIABLE (Interface to document builder variable)
Hierarchy
☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/PROGS (Package) programs
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  /IPRO/IF_DOCB_TABLEDATA docb table data interface 20040204
Properties
Interface /IPRO/IF_DOCB_VARIABLE  
Short Description Interface to document builder variable    
General Data
Package /IPRO/PROGS   programs 
Created 20031126   SAP 
Last changed 20130531   SAP 
Unicode checks active    
Forward declarations
Interface /IPRO/IF_DOCB_VARIABLE has no forward declaration.
Interfaces
# Interface Abstract Final Description Created on
1 /IPRO/IF_DOCB_ATTRIBUTE Attribute 20031126
2 /IPRO/IF_MESSAGE_SUBJECT message subject interface 20040211
3 /IPRO/IF_MESSAGING Interface for message handling 20040211
Friends
Interface /IPRO/IF_DOCB_VARIABLE has no friend.
Attributes
Interface /IPRO/IF_DOCB_VARIABLE has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 ADD_DEPENDENT Instance method Public Method Add another variable as its dependent 20040217
2 ADD_PRECONDITION Instance method Public Method Add a precondition variable 20040213
3 ASK_FOR Instance method Public Method Ask for a value of a variable. 20031202
4 CLOSE_TAG Instance method Public Method 20111128
5 CREATE_ADDIN_SCHEMA_FROM_VAR Instance method Public Method 20111128
6 CREATE_FILLIN_LIST Instance method Public Method Creates th whole list of all fillins 20100308
7 CREATE_TAG Instance method Public Method 20111128
8 GET_COUNT Instance method Public Method Get the count that determines if the variable is required 20031206
9 GET_CURRENCY Instance method Public Method Get the currency for the variable 20040122
10 GET_CURRENCY_VARIABLE Instance method Public Method Get the associated currency variable 20060116
11 GET_DEPENDENT Instance method Public Method Get the list of dependents of the variable 20040217
12 GET_DIALOG_VISIBILITY Instance method Public Method 20100809
13 GET_PRECONDITION Instance method Public Method Get the precondition variables for the current variable 20040213
14 GET_PRESENTATION_TYPE Instance method Public Method Get the Presentation properties of a variable 20031211
15 GET_REFERENCE Instance method Public Method Get the reference text 20040216
16 GET_UNIT_OF_MEASURE Instance method Public Method Get the units of measure for the varialble 20040122
17 GET_UOM_VARIABLE Instance method Public Method Get the associated unit of measure variable 20060119
18 GET_VAR_TYPE Instance method Public Method get variable type--E,S or T 20040130
19 IS_ACCEPTED Instance method Public Method Determine if the value in the variable has been accepted 20031206
20 SET_ACCEPTED Instance method Public Method Set the variable to assume an accepted value 20040115
21 SET_VALUE_FROM_XML Instance method Public Method Set the variable value from an XML element 20080205
Events
Interface /IPRO/IF_DOCB_VARIABLE has no event.
Types
Interface /IPRO/IF_DOCB_VARIABLE has no local type.
Method Signatures

Method ADD_DEPENDENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VARIABLE Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Dependent variable 20040217

Method ADD_DEPENDENT on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method ADD_PRECONDITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VARIABLE Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE The pre-condition variable 20040213

Method ADD_PRECONDITION on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method ASK_FOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_DATA Call by reference Type reference (TYPE) ANY 20031202
# Exception Resumable Description Created on
1 /IPRO/CX_VARIABLE_NOT_ACCEPTED Variable not accepted 20031204
2 /IPRO/CX_VARIABLE_NOT_VALID Variable not valid 20031202

Method CLOSE_TAG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SCHEMA_STRING Call by reference Type reference (TYPE) STRING 20111128
2 Returning RV_TAG Value transfer Type reference (TYPE) STRING 20111128

Method CLOSE_TAG on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method CREATE_ADDIN_SCHEMA_FROM_VAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VAR Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Interface to document builder variable 20111128
2 Importing IV_IS_IN_TAB Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20111128
3 Importing IV_IS_ROOT Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20111128
4 Importing IV_SCHEMA_STRING Call by reference Type reference (TYPE) STRING 20111128
5 Returning RV_TAG Value transfer Type reference (TYPE) STRING 20111128

Method CREATE_ADDIN_SCHEMA_FROM_VAR on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method CREATE_FILLIN_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRT_FILLINS Value transfer Type reference (TYPE) /IPRO/TT_FILLINS Table of /IPRO/S_FILLIN fillins 20100308

Method CREATE_FILLIN_LIST on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method CREATE_TAG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LABEL Call by reference Type reference (TYPE) STRING 20111128
2 Importing IV_NAME Call by reference Type reference (TYPE) STRING 20111128
3 Importing IV_SCHEMA_STRING Call by reference Type reference (TYPE) STRING 20111128
4 Importing IV_TYPE Call by reference Type reference (TYPE) STRING 20111128
5 Returning RV_TAG Value transfer Type reference (TYPE) STRING 20111128

Method CREATE_TAG on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_COUNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DEEP Call by reference Type reference (TYPE) SEU_BOOL Deap evaluation 20040607
2 Returning RV_COUNT Value transfer Type reference (TYPE) I 20031206

Method GET_COUNT on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_CURRENCY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CURRENCY Value transfer Type reference (TYPE) CURCY Currency Key 20040122

Method GET_CURRENCY on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_CURRENCY_VARIABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_CURRENCY Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Interface to document builder variable 20060116

Method GET_CURRENCY_VARIABLE on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_DEPENDENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_VARIABLES Value transfer Type reference (TYPE) /IPRO/TT_VARIABLES The list of dependent variables 20040217

Method GET_DEPENDENT on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_DIALOG_VISIBILITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PRV_DIALOG_VISIBILITY Value transfer Type reference (TYPE) /IPRO/VAR_VISIBILITY variable visibilty (dialog, fillin or both) 20100809

Method GET_DIALOG_VISIBILITY on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_PRECONDITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_VARIABLES Value transfer Type reference (TYPE) /IPRO/TT_VARIABLES Returned list of variables 20040213

Method GET_PRECONDITION on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_PRESENTATION_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_TYPE Value transfer Type reference (TYPE) /IPRO/S_VAR_TYPE Variable type information 20031211

Method GET_PRESENTATION_TYPE on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_REFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_TEXT Value transfer Object reference (TYPE REF TO) /IPRO/CL_DOCB_TEXT Document text 20040625

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

Method GET_UNIT_OF_MEASURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_UNITS Value transfer Type reference (TYPE) /IPRO/ORDER_UNIT This element defines the unit of measure for an item 20040122

Method GET_UNIT_OF_MEASURE on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_UOM_VARIABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_UOM Value transfer Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Interface to document builder variable 20060119

Method GET_UOM_VARIABLE on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method GET_VAR_TYPE Signature

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

Method GET_VAR_TYPE on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method IS_ACCEPTED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ACCEPTED Value transfer Type reference (TYPE) /IPRO/IS_ACCEPTED 20031206

Method IS_ACCEPTED on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method SET_ACCEPTED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIV_ACCEPTED Call by reference Type reference (TYPE) /IPRO/VAR_VISIBILITY 'D' #D# for dialog, #F# for fill-ins 20040505

Method SET_ACCEPTED on Interface /IPRO/IF_DOCB_VARIABLE has no exception.

Method SET_VALUE_FROM_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PIO_XML_ELEMENT Call by reference Object reference (TYPE REF TO) IF_IXML_ELEMENT IF_IXML_ELEMENT 20080205

Method SET_VALUE_FROM_XML on Interface /IPRO/IF_DOCB_VARIABLE has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 10A