SAP ABAP Class CL_UA_FORMULA_ (Formula)
Hierarchy
FINBASIS (Software Component) Fin. Basis
   FIN-FB-SRV (Application Component) Services
     UA_FORMULA (Package) Costing Solutions: Formula Editor
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_UA_FORMULA_BOOLEANS TRUE/FALSE 20021117
Properties
Class CL_UA_FORMULA_  
Short Description Formula    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package UA_FORMULA   Costing Solutions: Formula Editor 
Created 20021111   SAP 
Last change 20060920   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ICON Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_UA_FORMULA_BOOLEANS TRUE/FALSE 20021117
Friends
# Friend Modeled only Created on Description
1 CL_UA_FORMULA_LOADER 20050819 Services to Load and Save Formulas
2 CL_UA_FUNCTION 20030401 Basic Class for All Functions
3 CL_UA_PARAMETER 20030522 Basic Class for All Functions
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CD_ATTR_ID Constant Public Type reference (TYPE) STRING 'id' 20021213
2 CD_ATTR_IS_MDF_FIELD Constant Public Type reference (TYPE) STRING 'isMDFField' 20030801
3 CD_ATTR_IS_VALID Constant Public Type reference (TYPE) STRING 'isValid' 20031114
4 CD_ATTR_NAME Constant Public Type reference (TYPE) STRING 'name' 20021213
5 CD_ATTR_RESULT Constant Public Type reference (TYPE) STRING 'result' 20040930
6 CD_ATTR_RETURN_TYPE Constant Public Type reference (TYPE) STRING 'returnType' 20021217
7 CD_ATTR_RETURN_TYPEKIND Constant Public Type reference (TYPE) STRING 'returnTypekind' 20030329
8 CD_ATTR_STEP_DESCRIPTION Constant Public Type reference (TYPE) STRING 'stepDescr' 20041026
9 CD_ATTR_TERM Constant Public Type reference (TYPE) STRING 'term' 20040806
10 CD_ATTR_TRACE_INFO Constant Public Type reference (TYPE) STRING 'traceInfo' 20030430
11 CD_ATTR_TYPE Constant Public Type reference (TYPE) STRING 'type' 20021213
12 CD_ATTR_VALUE Constant Public Type reference (TYPE) STRING 'value' 20021217
13 CD_ROOT_PARAMETER_NAME Constant Public Type reference (TYPE) UAB_FUNCTION_NAME 'ROOT' Technical Name of a Function 20021217
14 CD_TAG_COMPONENT Constant Public Type reference (TYPE) STRING 'Component' 20021213
15 CD_TAG_CONSTANT Constant Public Type reference (TYPE) STRING 'Constant' 20021213
16 CD_TAG_FORMULA Constant Public Type reference (TYPE) STRING 'Formula' 20021213
17 CD_TAG_FUNCTION Constant Public Type reference (TYPE) STRING 'Function' 20021213
18 CD_TAG_PARAMETER Constant Public Type reference (TYPE) STRING 'Parameter' 20021213
19 CD_TAG_TRACE_ENTRY Constant Public Type reference (TYPE) STRING 'TraceEntry' 20030425
20 CD_TAG_VARIABLE Constant Public Type reference (TYPE) STRING 'Variable' 20021213
21 CD_UAF_PREFIX Constant Public Type reference (TYPE) STRING 'uaf' 20021213
22 CD_UAF_URI Constant Public Type reference (TYPE) STRING 'http://www.sap.com/gbu-fin/uaf' 20021213
23 CD_XMLNS_PREFIX Constant Public Type reference (TYPE) STRING 'xmlns' 20021213
24 FALSE Instance attribute Public Attribute reference (LIKE) 20021125
25 MD_DESCRIPTION Instance attribute Public Type reference (TYPE) UAB_FTEXT Description of Formula 20021212
26 MD_ID Instance attribute Public Type reference (TYPE) UAB_FUNCTION_ID Formula ID 20021115
27 MD_IS_SAP_FORMULA Instance attribute Public Type reference (TYPE) BOOLE_D 20050819
28 MD_IS_VALID Instance attribute Public Type reference (TYPE) UAB_BOOLEAN Formula has no errors (according to the check) 20030606
29 MD_RETURN_TYPE Instance attribute Public Type reference (TYPE) UAB_DDIC_TYPENAME Dictionary Type of Returning Parameters 20021205
30 MD_RETURN_TYPEKIND Instance attribute Public Type reference (TYPE) DDTYPEKIND Category of Table Type, which Should Deliver Formula 20030306
31 MO_BUILD_ENVIRONMENT Instance attribute Public Object reference (TYPE REF TO) CL_UA_FORMULA_BUILD_ENV Formula Environment 20021115
32 MO_LOADER Instance attribute Private Object reference (TYPE REF TO) CL_UA_FORMULA_LOADER Services to Load and Save Formulas 20030110
33 MO_MD_FACTORY Instance attribute Public Object reference (TYPE REF TO) IF_FINB_MD_CHAR_FACTORY 20050405
34 MO_ROOT_PARAMETER Instance attribute Public Object reference (TYPE REF TO) CL_UA_PARAMETER Root Parameter of Formula 20021210
35 SO_CURR_CONVERTER Static Attribute Private Object reference (TYPE REF TO) IF_UA_FORMULA_CURR_CONVERTER 20030401
36 SO_DEFAULT_CURR_CONVERTER Static Attribute Public Object reference (TYPE REF TO) IF_UA_FORMULA_CURR_CONVERTER 20030401
37 SO_DEFAULT_QUAN_CONVERTER Static Attribute Public Object reference (TYPE REF TO) IF_UA_FORMULA_QUAN_CONVERTER 20030401
38 SO_QUAN_CONVERTER Static Attribute Private Object reference (TYPE REF TO) IF_UA_FORMULA_QUAN_CONVERTER 20030401
39 TRUE Instance attribute Public Attribute reference (LIKE) 20021125
Methods
# Method Level Visibility Method type Description Created on
1 ADD_PARAMETER_TO_XML Instance method Private Method 20030110
2 CHECK Instance method Public Method 20021118
3 CLASS_CONSTRUCTOR Static method Public Constructor 20030401
4 COMMIT Instance method Public Method 20030110
5 COMPARE Instance method Public Method 20041117
6 CREATE_CLONE Instance method Public Method Generates Copy of Existing Formula 20030425
7 CREATE_FORMULA Static method Public Method Create New Formula 20021115
8 CREATE_FROM_XML Static method Public Method Generate Formula Object from XML String 20021217
9 CREATE_ROOT_FUNCTION Instance method Public Method Obsolete - Replaced by mo_root_parameter->set_value_func,.. 20021113
10 CURR_CONVERSION_RESULT_TAB Instance method Private Method 20030502
11 DEQUEUE Instance method Public Method Unlock Formula 20030113
12 EMPTY Instance method Public Method "Empties" the Formula ("Master Data" Is Kept) 20040206
13 ENQUEUE Instance method Public Method Lock Formula 20030113
14 EVALUATE Instance method Public Method 20021118
15 GET_AS_FUNCTION Instance method Public Method Gets a Description of Formula as Function 20021216
16 GET_AS_STRING Instance method Public Method 20030115
17 GET_AS_XML Instance method Public Method 20021216
18 GET_DESCRIPTION Instance method Public Method Get Icon and Text of Formula 20021212
19 GET_FUNCTION Instance method Public Method Find Function Reference to an ID 20021206
20 GET_PARAMETER Instance method Public Method Find Parameter Reference to an ID 20021206
21 GET_ROOT_PARAMETER Instance method Public Method 20021210
22 GET_USED_FUNCTIONS Instance method Public Method Gets All Functions that Are Used in the Formula 20030113
23 GET_USED_VARIABLES Instance method Public Method Gets All Variables that Are Used in the Formula 20030108
24 IS_CHANGEABLE Instance method Public Method Check whether formula is locked 20030113
25 IS_EMPTY Instance method Public Method Formula Is Initial 20030307
26 LOAD Static method Public Method Load Existing Formula 20021213
27 QUAN_CONVERSION_RESULT_TAB Instance method Private Method 20030502
28 SAVE Instance method Public Method Formula Secure (then COMMIT() Must Be Called) 20021213
29 SET_DESCRIPTION Instance method Public Method Set Text of Formula 20021212
30 SET_PARAMETER_FROM_XML Instance method Private Method 20021218
Events
Class CL_UA_FORMULA_ has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 YS_TEXT Public See coding 20050623 BEGIN OF ys_text, langu TYPE langu, text TYPE uab_ftext, END OF ys_text
2 YTS_TEXT Public See coding 20050623 yts_text TYPE SORTED TABLE OF ys_text WITH UNIQUE KEY langu
Method Signatures

Method ADD_PARAMETER_TO_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_DOCUMENT Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT 20030110
2 Importing IO_PARAMETER Call by reference Object reference (TYPE REF TO) CL_UA_PARAMETER 20030110
3 Importing IO_PARENT Call by reference Object reference (TYPE REF TO) IF_IXML_NODE 20030110
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION Ausnahmeklasse für Formeln 20030110

Method CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_IGNORE_INITIAL_PARAMETERS Call by reference Type reference (TYPE) BOOLE_D Initiale Parameter akzeptieren 20050422
2 Importing IO_MSG_HANDLER Call by reference Object reference (TYPE REF TO) IF_FINB_MSG_HANDLER Message Handler 20030303

Method CHECK on class CL_UA_FORMULA_ has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_UA_FORMULA_ has no parameter.
Method CLASS_CONSTRUCTOR on class CL_UA_FORMULA_ has no exception.

Method COMMIT Signature

Method COMMIT on class CL_UA_FORMULA_ has no parameter.
Method COMMIT on class CL_UA_FORMULA_ has no exception.

Method COMPARE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_FORMULA Call by reference Object reference (TYPE REF TO) CL_UA_FORMULA_ 20041117
2 Returning RD_IS_EQUAL Value transfer Type reference (TYPE) BOOLE_D 20041117
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20041117

Method CREATE_CLONE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_FORMULA Value transfer Object reference (TYPE REF TO) CL_UA_FORMULA_ 20030425
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20030425

Method CREATE_FORMULA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_DESCRIPTION Call by reference Type reference (TYPE) UAB_FTEXT Beschreibung der Formel 20021115
2 Importing ID_DESIRED_TYPE Call by reference Type reference (TYPE) UAB_DDIC_TYPENAME Name des Dictionary Typs 20021115
3 Importing ID_RETURN_TYPEKIND Call by reference Type reference (TYPE) DDTYPEKIND Art des generischen Tabellentyps 20030306
4 Importing IO_BUILD_ENVIRONMENT Call by reference Object reference (TYPE REF TO) CL_UA_FORMULA_BUILD_ENV Umgebung einer Formel zum Build-Zeitpunkt 20021115
5 Importing IO_MD_FACTORY Call by reference Object reference (TYPE REF TO) IF_FINB_MD_CHAR_FACTORY 20050405
6 Returning RO_FORMULA Value transfer Object reference (TYPE REF TO) CL_UA_FORMULA_ Formel 20021115
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20021210

Method CREATE_FROM_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_IGNORE_ERRORS Call by reference Type reference (TYPE) UAB_BOOLEAN 20030523
2 Importing ID_XML Call by reference Type reference (TYPE) STRING 20021217
3 Importing IO_BUILD_ENVIRONMENT Call by reference Object reference (TYPE REF TO) CL_UA_FORMULA_BUILD_ENV 20021217
4 Importing IO_DOM Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT 20030801
5 Importing IO_MD_FACTORY Call by reference Object reference (TYPE REF TO) IF_FINB_MD_CHAR_FACTORY 20050405
6 Returning RO_FORMULA Value transfer Object reference (TYPE REF TO) CL_UA_FORMULA_ 20021217
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20021217

Method CREATE_ROOT_FUNCTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_FUNCTION_NAME Call by reference Type reference (TYPE) UAB_FUNCTION_NAME 20021113
2 Returning RD_FUNCTION_ID Value transfer Type reference (TYPE) UAB_FUNCTION_ID ID der Funktion 20021117
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20021205

Method CURR_CONVERSION_RESULT_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_TABLE Call by reference Type reference (TYPE) HASHED TABLE 20030502
2 Importing ID_TARGET_CURRENCY Call by reference Type reference (TYPE) FINB_CURRENCY 20030502
3 Importing IO_RT_ENVIRONMENT Call by reference Object reference (TYPE REF TO) IF_UA_FORMULA_RT_ENVIRONMENT 20030502
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20030502

Method DEQUEUE Signature

Method DEQUEUE on class CL_UA_FORMULA_ has no parameter.
Method DEQUEUE on class CL_UA_FORMULA_ has no exception.

Method EMPTY Signature

Method EMPTY on class CL_UA_FORMULA_ has no parameter.
Method EMPTY on class CL_UA_FORMULA_ has no exception.

Method ENQUEUE Signature

Method ENQUEUE on class CL_UA_FORMULA_ has no parameter.
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20030113

Method EVALUATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CURR_CONVERTER Call by reference Object reference (TYPE REF TO) IF_UA_FORMULA_CURR_CONVERTER Währungsumrechner 20021121
2 Importing IO_PARENT_NODE Call by reference Object reference (TYPE REF TO) IF_IXML_NODE Knoten, unter dem die Trace-Info eingefügt werden soll 20030425
3 Importing IO_QUAN_CONVERTER Call by reference Object reference (TYPE REF TO) IF_UA_FORMULA_QUAN_CONVERTER Mengenumrechner 20021121
4 Importing IO_RT_ENVIRONMENT Call by reference Object reference (TYPE REF TO) IF_UA_FORMULA_RT_ENVIRONMENT Formelumgebung zur Laufzeit 20021220
5 Importing IO_TRACE_XML Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT XML-Dokument für Trace 20030425
6 Returning RR_RESULT Value transfer Object reference (TYPE REF TO) DATA 20021119
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION Ausnahmeklasse für Formeln 20021126

Method GET_AS_FUNCTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_FUNCTION Value transfer Object reference (TYPE REF TO) CL_UA_FUNCTION Basisklasse für alle Funktionen 20021216

Method GET_AS_FUNCTION on class CL_UA_FORMULA_ has no exception.

Method GET_AS_STRING Signature

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

Method GET_AS_STRING on class CL_UA_FORMULA_ has no exception.

Method GET_AS_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ED_FORMULA_STRING Call by reference Type reference (TYPE) STRING 20030801
2 Exporting EO_FORMULA_DOM Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT 20030801
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20021216

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ED_ICON Call by reference Type reference (TYPE) ICON_D Ikone in Textfeldern (Ersatzdarstellung, Alias) 20021212
2 Exporting ED_TEXT Call by reference Type reference (TYPE) UAB_FTEXT Texte zu Formeln 20021212

Method GET_DESCRIPTION on class CL_UA_FORMULA_ has no exception.

Method GET_FUNCTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_ID Call by reference Type reference (TYPE) UAB_FUNCTION_ID ID der gesuchten Funktion 20021206
2 Importing IO_ENTRY_FUNCTION Call by reference Object reference (TYPE REF TO) CL_UA_FUNCTION Einstiegsknoten für die Suche 20021206
3 Returning RO_FUNCTION Value transfer Object reference (TYPE REF TO) CL_UA_FUNCTION Basisklasse für alle Funktionen 20021206

Method GET_FUNCTION on class CL_UA_FORMULA_ has no exception.

Method GET_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_PARAMETER_ID Call by reference Type reference (TYPE) UAB_FUNCTION_ID 20021206
2 Importing IO_ENTRY_FUNCTION Call by reference Object reference (TYPE REF TO) CL_UA_FUNCTION Basisklasse für alle Funktionen 20021206
3 Returning RO_PARAMETER Value transfer Object reference (TYPE REF TO) CL_UA_PARAMETER Basisklasse für alle Funktionen 20021206

Method GET_PARAMETER on class CL_UA_FORMULA_ has no exception.

Method GET_ROOT_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_ROOT_PARAMETER Value transfer Object reference (TYPE REF TO) CL_UA_PARAMETER 20021210

Method GET_ROOT_PARAMETER on class CL_UA_FORMULA_ has no exception.

Method GET_USED_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ENTRY_PARAMETER Call by reference Object reference (TYPE REF TO) CL_UA_PARAMETER Default: Root-Parameter 20030113
2 Returning RT_FUNCTIONS Value transfer Type reference (TYPE) UAB_T_FUNCTION_NAMES 20030113

Method GET_USED_FUNCTIONS on class CL_UA_FORMULA_ has no exception.

Method GET_USED_VARIABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ENTRY_PARAMETER Call by reference Object reference (TYPE REF TO) CL_UA_PARAMETER Default: Root-Parameter 20030108
2 Returning RT_VARIABLES Value transfer Type reference (TYPE) UAB_T_VARIABLE_NAMES 20030108

Method GET_USED_VARIABLES on class CL_UA_FORMULA_ has no exception.

Method IS_CHANGEABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RD_IS_CHANGEABLE Value transfer Type reference (TYPE) UAB_BOOLEAN 20030113
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20040315

Method IS_EMPTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RD_IS_EMPTY Value transfer Type reference (TYPE) UAB_BOOLEAN 20030307

Method IS_EMPTY on class CL_UA_FORMULA_ has no exception.

Method LOAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_ENQUEUE Call by reference Type reference (TYPE) UAB_BOOLEAN ' ' X= sperren, ' ' = nicht sperren 20030110
2 Importing ID_FORMULA_ID Call by reference Type reference (TYPE) UAB_FUNCTION_ID Formel-Id 20021213
3 Importing IO_BUILD_ENVIRONMENT Call by reference Object reference (TYPE REF TO) CL_UA_FORMULA_BUILD_ENV Formelumgebung zum Build-Zeitpunkt 20030110
4 Importing IO_MD_FACTORY Call by reference Object reference (TYPE REF TO) IF_FINB_MD_CHAR_FACTORY 20050405
5 Returning RO_FORMULA Value transfer Object reference (TYPE REF TO) CL_UA_FORMULA_ Formel 20021213
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20030110

Method QUAN_CONVERSION_RESULT_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_TABLE Call by reference Type reference (TYPE) HASHED TABLE 20030502
2 Importing ID_TARGET_UNIT Call by reference Type reference (TYPE) FINB_UNIT Mengeneinheit 20030502
3 Importing IO_RT_ENVIRONMENT Call by reference Object reference (TYPE REF TO) IF_UA_FORMULA_RT_ENVIRONMENT Formelumgebung zur Laufzeit 20030502
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20030502

Method SAVE Signature

Method SAVE on class CL_UA_FORMULA_ has no parameter.
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION 20021216

Method SET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_TEXT Call by reference Type reference (TYPE) UAB_FTEXT Texte zu Formeln 20021212

Method SET_DESCRIPTION on class CL_UA_FORMULA_ has no exception.

Method SET_PARAMETER_FROM_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_TOLERATE_ERRORS Call by reference Type reference (TYPE) BOOLE_D 'X' Auch fehlerhafte Werte laden 20040628
2 Importing IO_NODE Call by reference Object reference (TYPE REF TO) IF_IXML_NODE 20021218
3 Importing IO_PARAMETER Call by reference Object reference (TYPE REF TO) CL_UA_PARAMETER 20021218
# Exception Resumable Description Created on
1 CX_UA_FORMULA_EXCEPTION Ausnahmeklasse für Formeln 20021218
History
Last changed by/on SAP  20060920 
SAP Release Created in 350