SAP ABAP Class CL_GHO_FDT_CM_FACTOR_TL (Class for Factors and TL using BRF)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
PP-PN-ALN (Application Component) Production Allocation
⤷
APPL_GHO_ALLOC_BE (Package) Backend Logic for Allocation
⤷
⤷
Properties
| Class | CL_GHO_FDT_CM_FACTOR_TL | |
| Short Description | Class for Factors and TL using BRF | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | APPL_GHO_ALLOC_BE | Backend Logic for Allocation |
| Created | 20130924 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 3 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class CL_GHO_FDT_CM_FACTOR_TL has no interface implemented.
Friends
Class CL_GHO_FDT_CM_FACTOR_TL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | IF_FDT_TYPES=>NAME | 'BRF_FORMULA_APP_OTH' | Application name for Other network objects | 20131108 | ||
| 2 | Constant | Public | Type reference (TYPE) | IF_FDT_TYPES=>NAME | 'BRF_FORMULA_APP_WC' | Application name for Well completions | 20131108 | ||
| 3 | Constant | Public | Type reference (TYPE) | CHAR2 | 'CM' | Prefix for Function name | 20131108 | ||
| 4 | Static Attribute | Private | Object reference (TYPE REF TO) | IF_FDT_FACTORY | FDT: Factory instance | 20131108 | |||
| 5 | Static Attribute | Private | Type reference (TYPE) | IF_FDT_TYPES=>ID | APPLICATION ID | 20131108 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Checks whether formula is empty or not | 20131108 | |
| 2 | Static method | Public | Method | Create the BRF Formula and return the Formula ID | 20131108 | |
| 3 | Static method | Private | Method | Create the BRF Function | 20131108 | |
| 4 | Static method | Private | Method | Create the Data Object to be used as Function Context | 20131108 | |
| 5 | Static method | Private | Method | Create the Data Objects | 20131108 | |
| 6 | Static method | Private | Method | Create the result data object for Function | 20131108 | |
| 7 | Static method | Public | Method | Deletes the formula | 20131108 | |
| 8 | Static method | Public | Method | Fetch the formula result | 20131108 | |
| 9 | Static method | Private | Method | Fetch the Application ID | 20131108 | |
| 10 | Static method | Private | Method | Get the Factory instance | 20131108 | |
| 11 | Static method | Private | Method | Gets the Object ID | 20131108 | |
| 12 | Static method | Private | Method | Process the formula and get the result | 20131108 | |
| 13 | Static method | Public | Method | Refreshes the data | 20131108 | |
| 14 | Static method | Public | Method | Reset the formula context to add new context data objects | 20131108 | |
| 15 | Static method | Public | Method | Save the Formula created by user | 20131108 | |
| 16 | Static method | Public | Method | Validates whether the given Formula is valid or not | 20131108 |
Events
Class CL_GHO_FDT_CM_FACTOR_TL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TS_DATA_OBJ_ID_VALUE | Public | See coding | 20131108 | BEGIN OF ts_data_obj_id_value,
id TYPE if_fdt_types=>id,
name TYPE if_fdt_types=>name,
value TYPE gho_quantity,
object_type TYPE if_fdt_types=>object_type,
END OF ts_data_obj_id_value
|
||
| 2 | TS_DATA_OBJ_NAME_VALUE | Public | See coding | 20131108 | BEGIN OF ts_data_obj_name_value,
data_object_name TYPE if_fdt_types=>name,
data_object_value TYPE gho_quantity,
END OF ts_data_obj_name_value
|
||
| 3 | TS_FDT_DATA_OBJECT | Public | See coding | 20131108 | BEGIN OF ts_fdt_data_object,
do_name TYPE if_fdt_types=>name,
do_text TYPE if_fdt_types=>text,
do_short_text TYPE if_fdt_types=>short_text,
END OF ts_fdt_data_object
|
||
| 4 | TS_FDT_DATA_OBJ_ID_NAME | Public | See coding | 20131108 | BEGIN OF ts_fdt_data_obj_id_name,
context_id TYPE if_fdt_types=>id,
context_name TYPE if_fdt_types=>name,
END OF ts_fdt_data_obj_id_name
|
||
| 5 | TT_DATA_OBJ_ID_VALUE | Public | See coding | 20131108 | tt_data_obj_id_value TYPE STANDARD TABLE OF ts_data_obj_id_value
|
||
| 6 | TT_DATA_OBJ_NAME_VALUE | Public | See coding | 20131108 | tt_data_obj_name_value TYPE STANDARD TABLE OF ts_data_obj_name_value
|
||
| 7 | TT_FDT_DATA_OBJECT | Public | See coding | Table type for creation of data object | 20131108 | tt_fdt_data_object TYPE STANDARD TABLE OF ts_fdt_data_object
|
|
| 8 | TT_FDT_DATA_OBJ_ID_NAME | Public | See coding | 20131108 | tt_fdt_data_obj_id_name type STANDARD TABLE OF ts_fdt_data_obj_id_name
|
Method Signatures
Method CHECK_EMPTY_FORMULA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20131108 | |||
| 2 | EV_FORMULA_EMPTY | Call by reference | Type reference (TYPE) | FLAG | Flag to check if formula is empty or not | 20131108 | |||
| 3 | EV_UNSAVED_CHANGES | Call by reference | Type reference (TYPE) | FLAG | Flag to check if formula has unsaved changes | 20131108 | |||
| 4 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Formula ID | 20131108 |
Method CHECK_EMPTY_FORMULA on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method CREATE_BRF_FORMULA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_FORMULA | Call by reference | Object reference (TYPE REF TO) | IF_FDT_FORMULA | Formula Instance | 20131108 | |||
| 2 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Error Messages | 20131108 | |||
| 3 | EV_FORMULA_ID | Call by reference | Type reference (TYPE) | FDT_UUID | FDT: Universal Unique Identifier | 20131108 | |||
| 4 | IT_CONTEXT_DATA | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_FDT_DATA_OBJECT | Table type for creation of data object | 20131108 | |||
| 5 | IT_RESULT_DATA_OBJECT | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_FDT_DATA_OBJECT | Table type for creation of data object | 20131108 | |||
| 6 | IV_APPLICATION_NAME | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>NAME | 20131108 | ||||
| 7 | IV_CONTEXT_DDIC_TYPENAME | Call by reference | Type reference (TYPE) | CHAR40 | Character field of length 40 | 20131108 | |||
| 8 | IV_RESULT_DOBJ_DDIC_TYPENAME | Call by reference | Type reference (TYPE) | CHAR40 | Character field of length 40 | 20131108 |
Method CREATE_BRF_FORMULA on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method CREATE_BRF_FUNCTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_FUNCTION | Call by reference | Object reference (TYPE REF TO) | IF_FDT_FUNCTION | BRF PLus Function instance | 20131108 | |||
| 2 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20131108 | |||
| 3 | IT_CONTEXT_IDS | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Context Data ID's | 20131108 | |||
| 4 | IV_APPLICATION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | BRF Plus Application ID of function | 20131108 | |||
| 5 | IV_FUNCTION_NAME | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>NAME | Function Name | 20131108 | |||
| 6 | IV_FUNCTION_SHORT_TEXT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>SHORT_TEXT | Function Short Text | 20131108 | |||
| 7 | IV_FUNCTION_TEXT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TEXT | Function Text | 20131108 | |||
| 8 | IV_RESULT_DATA_OBJECT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Result Data Object ID | 20131108 |
Method CREATE_BRF_FUNCTION on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method CREATE_CONTEXT_IDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_DATA_CONTEXT_IDS | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Object IDs as sorted table | 20131108 | |||
| 2 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20131108 | |||
| 3 | IT_FDT_CONTEXT_DATA | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_FDT_DATA_OBJECT | Table type for creation of data object | 20131108 | |||
| 4 | IV_DDIC_TYPENAME | Call by reference | Type reference (TYPE) | CHAR40 | Character field of length 40 | 20131108 |
Method CREATE_CONTEXT_IDS on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method CREATE_DATA_OBJECTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_DATA_OBJECT_IDS | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Object IDs as sorted table | 20131108 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20131108 | |||
| 3 | IT_DATA_OBJECTS | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_FDT_DATA_OBJECT | Table type for passing data objects | 20131108 | |||
| 4 | IV_DDIC_TYPENAME | Call by reference | Type reference (TYPE) | CSEQUENCE | DDIC type for Binding data Object | 20131108 |
Method CREATE_DATA_OBJECTS on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method CREATE_RESULT_DATA_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20131108 | |||
| 2 | EV_RESULT_DATA_OBJECT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Result Data Object ID | 20131108 | |||
| 3 | IT_FDT_RESULT_DOBJ_DETAILS | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_FDT_DATA_OBJECT | Table type for creation of data object | 20131108 | |||
| 4 | IV_DDIC_TYPENAME | Call by reference | Type reference (TYPE) | CHAR40 | Character field of length 40 | 20131108 |
Method CREATE_RESULT_DATA_OBJECT on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method DELETE_BRF_FORMULA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20131108 | |||
| 2 | IV_DEEP | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20131108 | |||
| 3 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 | |||
| 4 | IV_MARK_FOR_DELETE | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20131108 | |||
| 5 | IV_REVERSE_MARK_FOR_DELETE | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20131108 |
Method DELETE_BRF_FORMULA on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method FETCH_FORMULA_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Error Message Log | 20131108 | |||
| 2 | EV_RESULT | Call by reference | Type reference (TYPE) | GHO_QUANTITY | Quantity Measured/Planned against the Node:Vol,Mass,Energy | 20131108 | |||
| 3 | IT_DATA_OBJ_ID_VALUE | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_DATA_OBJ_NAME_VALUE | 20131108 | ||||
| 4 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 |
Method FETCH_FORMULA_RESULT on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method GET_APPLICATION_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20131108 | |||
| 2 | EV_ACTIVATION_FAILED | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20131108 | ||||
| 3 | EV_APPLICATION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 | |||
| 4 | IV_APPLICATION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 | |||
| 5 | IV_APPLICATION_NAME | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>NAME | 20131108 |
Method GET_APPLICATION_ID on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method GET_FACTORY_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Error Message Log | 20131108 | |||
| 2 | IV_APPLICATION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | BRF Plus Application ID | 20131108 |
Method GET_FACTORY_INSTANCE on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method GET_OBJECT_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Message Log | 20131108 | |||
| 2 | EV_OBJ_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Unique Object ID | 20131108 | |||
| 3 | IV_OBJ_NAME | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>NAME | Name of the Object | 20131108 | |||
| 4 | IV_OBJ_TYPE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>OBJECT_TYPE | Object Type | 20131108 |
Method GET_OBJECT_ID on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method PROCESS_BRF_FORMULA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Error Messages | 20131108 | |||
| 2 | EV_RESULT | Call by reference | Type reference (TYPE) | GHO_QUANTITY | Quantity Measured/Planned against the Node:Vol,Mass,Energy | 20131108 | |||
| 3 | IT_DATA_OBJ_NAME_VALUE | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_DATA_OBJ_NAME_VALUE | Data Object ID and their values | 20131108 | |||
| 4 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Formula ID | 20131108 |
Method PROCESS_BRF_FORMULA on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method REFRESH_DATA Signature
Method REFRESH_DATA on class CL_GHO_FDT_CM_FACTOR_TL has no parameter.
Method REFRESH_DATA on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method RESET_FORMULA_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20131108 | |||
| 2 | IT_FDT_CONTEXT_DATA | Call by reference | Type reference (TYPE) | CL_GHO_FDT_CM_FACTOR_TL=>TT_FDT_DATA_OBJECT | 20131108 | ||||
| 3 | IV_APPLICATION_NAME | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>NAME | Universal Unique Identifier | 20131108 | |||
| 4 | IV_DDIC_TYPENAME | Call by reference | Type reference (TYPE) | CHAR40 | 20131108 | ||||
| 5 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 |
Method RESET_FORMULA_CONTEXT on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method SAVE_BRF_FORMULA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Error Messages | 20131108 | |||
| 2 | IR_FORMULA | Call by reference | Object reference (TYPE REF TO) | IF_FDT_FORMULA | FDT: Formula | 20131108 | |||
| 3 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 |
Method SAVE_BRF_FORMULA on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
Method VALIDATE_FORMULA_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE_LOG | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20131108 | |||
| 2 | EV_INVALID_FORMULA_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | Flag whether Formula ID is invalid or not, if true: invalid | 20131108 | |||
| 3 | IV_FORMULA_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20131108 |
Method VALIDATE_FORMULA_ID on class CL_GHO_FDT_CM_FACTOR_TL has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in |