SAP ABAP Class CL_CPE_PRCFIX_OPTION (CPE Definition of Price Fixation Option)
Hierarchy
PI_BASIS (Software Component) Basis Plug-In
   CA-GTF-CPE (Application Component) Commodity Pricing Engine
     CPE_FA_FE (Package) Commodity Pricing: Formula Assembly and Evaluation (ABAP)
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CPE_EXTENSION Interface for a CPE Extension 20130410
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CPE_PRCFIX_LIMIT CPE Price Fixation Limit 20130410
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CPE_PRCFIX_OPTION CPE Price Fixation Option Definition 20130410
Properties
Class CL_CPE_PRCFIX_OPTION  
Short Description CPE Definition of Price Fixation Option    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package CPE_FA_FE   Commodity Pricing: Formula Assembly and Evaluation (ABAP) 
Created 20130222   SAP 
Last change 20140121   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 IF_CPE_CONSTANTS Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
2 IF_CPE_PRCFIX_OPTION Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_CPE_EXTENSION Interface for a CPE Extension 20130410
2 IF_CPE_PRCFIX_LIMIT CPE Price Fixation Limit 20130410
3 IF_CPE_PRCFIX_OPTION CPE Price Fixation Option Definition 20130410
Friends
Class CL_CPE_PRCFIX_OPTION has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 DEFINITION Instance attribute Private Type reference (TYPE) CPED_PRCFIX_DEF Price Fixation Definition 20130410
2 MC_CLASS_NAME Instance attribute Private Type reference (TYPE) CPET_LOG_PROGRAM 'CL_CPE_PRCFIX_OPTION' CPE - Log: Program 20130410
3 MS_KEY Instance attribute Private Type reference (TYPE) CPET_EXTENSION_KEY CPE Extension Key 20130410
4 MT_SUBTERMS_INPUT Instance attribute Private Type reference (TYPE) CPET_TERMINPUT_TAB CPE Term - Table Type for Changed General Data Input 20130410
5 MT_SUBTERMS_OUTPUT Instance attribute Private Type reference (TYPE) CPET_TERMOUTPUT_TAB CPE Term - Table Type for Generic Term Output in Evaluation 20130410
6 MV_FORECAST_STATUS Instance attribute Private Type reference (TYPE) CPET_FORECAST_STATUS Status of Quotation Forecast 20130527
7 REF_GUID Instance attribute Public Type reference (TYPE) CPET_REF_GUID CPE Reference Guid 20130410
Methods
# Method Level Visibility Method type Description Created on
1 ADD_SUBTERM Instance method Public Method Add an exercise term to the option 20130410
2 BEGIN_TRACE Instance method Private Method Write trace begin entry 20130415
3 CALCULATE_NON_FIXED_QUANTITY Instance method Private Method Calculate the non fixed quantity 20130418
4 CALCULATE_ROOT_TERM_RATE Instance method Public Method Calculate the rate of the root term from the sub-terms 20130410
5 CHECK_EXERCISE_DATES Instance method Private Method Check the date values 20130410
6 CHECK_LIMIT Instance method Private Method Check the limit of the option 20130410
7 CONSTRUCTOR Instance method Public Constructor 20130410
8 END_TRACE Instance method Private Method Write trace end entry 20130415
9 EVALUATE Instance method Public Method Evaluate option 20130410
10 GET_DEFINITION Instance method Private Method 20130410
11 GET_FIXED_QUANTITY Instance method Private Method 20130410
12 GET_FORECAST_STATUS Instance method Public Method Get the forecast status of the option 20130527
13 GET_LIMIT_QUANTITY Instance method Private Method 20130410
14 GET_REMAINDER Instance method Public Method Get remainder term 20130410
15 GET_REMAINDER_RATE Instance method Private Method Get the rate of the remainder (via price reference routine) 20130410
16 GET_ROOT_TERM Instance method Private Method Get the root term of the option definition 20130410
17 GET_SUBTERMS_DATA Instance method Public Method Get all subterms data 20130410
18 GET_TERM_VALUE Instance method Private Method 20130410
19 LOG_MESSAGE Instance method Private Method Logs a message 20130425
20 PRICEFIXOPTDEF_RULE Instance method Public Method CPE Price Fixation Option Definition Rule 20130912
21 SET_ATTRIBUTE Instance method Public Method Set an attribute value of the definition 20130410
22 SET_DEFINITION Instance method Public Method 20130410
23 SET_FORECAST_STATUS Instance method Public Method Set the forecast status of sub-terms 20130527
24 SET_OPTION_STATUS Instance method Private Method Set the status of the option based on the evaluation 20130410
25 WRITE_EXERCISE_DATE_TRACE Instance method Private Method Write trace entries for the exercise date routines 20130415
26 WRITE_LIMIT_TRACE Instance method Private Method Write trace entries for the limit routine 20130415
27 WRITE_PRICE_REF_TRACE Instance method Private Method Write trace entries for the limit routine 20130415
28 WRITE_QUANTITY_DISTRIB_TRACE Instance method Private Method Write trace entries for the quantity distribution routine 20130415
29 WRITE_TRACE Instance method Private Method Write trace entry 20130415
30 WRITE_TRACE_FOR_STRUCTURE Instance method Private Method Write trace entry for a given structure 20130415
31 WRITE_TRACE_FOR_STRUCT_FIELD Instance method Private Method Write trace entry for a field of a structure 20130415
Events
# Event Type Visibility Description Created on
1 LIMIT_EXCEEDED Instance Event
(0)
Public
(2)
20130410
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_FIELNAMES Private See coding 20130415 TY_FIELNAMES type standard table of FIELDNAME with default key
2 TY_QUANTITY Private Attribute reference (LIKE) 20130410
Method Signatures

Method ADD_SUBTERM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_TERMOUTPUT Call by reference Type reference (TYPE) CPET_TERMOUTPUT CPE Term - Generic Output Structure during Evaluation 20130410

Method ADD_SUBTERM on class CL_CPE_PRCFIX_OPTION has no exception.

Method BEGIN_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IV_SUBMODULE Call by reference Type reference (TYPE) CPET_LOG_SUBMODULE CPE Log - Submodule 20130415

Method BEGIN_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method CALCULATE_NON_FIXED_QUANTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130418

Method CALCULATE_NON_FIXED_QUANTITY on class CL_CPE_PRCFIX_OPTION has no exception.

Method CALCULATE_ROOT_TERM_RATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130410
2 Returning RV_OPTION_RATE Value transfer Type reference (TYPE) CPET_INTERNAL_VALUE CPE - Used for internal calculation (rounding, conversion) 20130410
# Exception Resumable Description Created on
1 CX_CPE_EVALUATION_TERMINATED CPE Evaluation Terminated 20130410

Method CHECK_EXERCISE_DATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130410
2 Importing IV_EXERCISE_DATE_EARLY Call by reference Type reference (TYPE) CPET_PRCFIX_EARLY_EXERCISEDATE CPE Price Fixation - Earliest Exercise Date 20130410
3 Importing IV_EXERCISE_DATE_LATE Call by reference Type reference (TYPE) CPET_PRCFIX_LATE_EXERCISEDATE CPE Price Fixation - Latest Exercise Date 20130410

Method CHECK_EXERCISE_DATES on class CL_CPE_PRCFIX_OPTION has no exception.

Method CHECK_LIMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130410
# Exception Resumable Description Created on
1 CX_CPE_EVALUATION_TERMINATED CPE Evaluation Terminated 20130410

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REF_GUID Call by reference Type reference (TYPE) CPET_REF_GUID CPE Reference Guid 20130410

Method CONSTRUCTOR on class CL_CPE_PRCFIX_OPTION has no exception.

Method END_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IV_SUBMODULE Call by reference Type reference (TYPE) CPET_LOG_SUBMODULE CPE Log - Submodule 20130415

Method END_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method EVALUATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130410
# Exception Resumable Description Created on
1 CX_CPE_EVALUATION_TERMINATED CPE Evaluation Terminated 20130410

Method GET_DEFINITION Signature

Method GET_DEFINITION on class CL_CPE_PRCFIX_OPTION has no parameter.
Method GET_DEFINITION on class CL_CPE_PRCFIX_OPTION has no exception.

Method GET_FIXED_QUANTITY Signature

Method GET_FIXED_QUANTITY on class CL_CPE_PRCFIX_OPTION has no parameter.
Method GET_FIXED_QUANTITY on class CL_CPE_PRCFIX_OPTION has no exception.

Method GET_FORECAST_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_FORECAST_STATUS Value transfer Type reference (TYPE) CPET_FORECAST_STATUS Status of Quotation Forecast 20130527

Method GET_FORECAST_STATUS on class CL_CPE_PRCFIX_OPTION has no exception.

Method GET_LIMIT_QUANTITY Signature

Method GET_LIMIT_QUANTITY on class CL_CPE_PRCFIX_OPTION has no parameter.
Method GET_LIMIT_QUANTITY on class CL_CPE_PRCFIX_OPTION has no exception.

Method GET_REMAINDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_REMAINDER Value transfer Type reference (TYPE) CPET_TERMOUTPUT CPE Term - Generic Output Structure during Evaluation 20130410
# Exception Resumable Description Created on
1 CX_CPE_PRCFIX_NO_SUBTERM No extension sub-term exists 20130410

Method GET_REMAINDER_RATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RATE Call by reference Type reference (TYPE) CPET_INTERNAL_VALUE CPE - Used for internal calculation (rounding, conversion) 20130410
2 Exporting EV_STATUS Call by reference Type reference (TYPE) CPET_TERMSTATUS CPE Term - Status 20130429
3 Exporting EV_VALUE Call by reference Type reference (TYPE) CPET_INTERNAL_VALUE CPE - Used for internal calculation (rounding, conversion) 20130410
4 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130410
5 Importing IS_REMAINDER Call by reference Type reference (TYPE) CPET_TERMOUTPUT CPE Term - Generic Output Structure during Evaluation 20130410
6 Importing IS_REMAINDER_QTY Call by reference Type reference (TYPE) IF_CPE_PRCFIX_OPTION=>TY_QUANTITY CPE Quantity and UoM of a Price Fixation Option 20130410
# Exception Resumable Description Created on
1 CX_CPE_EVALUATION_TERMINATED CPE Evaluation Terminated 20130410

Method GET_ROOT_TERM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130410
2 Returning RS_ROOT_TERMOUTPUT Value transfer Type reference (TYPE) CPET_TERMOUTPUT CPE Term - Generic Output Structure during Evaluation 20130410
# Exception Resumable Description Created on
1 CX_CPE_PRCFIX_NO_ROOT_TERM No root term exists 20130410

Method GET_SUBTERMS_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SUBTERMS_INPUT Call by reference Type reference (TYPE) CPET_TERMINPUT_TAB CPE Term - Table Type for Changed General Data Input 20130410
2 Exporting ET_SUBTERMS_OUTPUT Call by reference Type reference (TYPE) CPET_TERMOUTPUT_TAB CPE Term - Table Type for Generic Term Output in Evaluation 20130410

Method GET_SUBTERMS_DATA on class CL_CPE_PRCFIX_OPTION has no exception.

Method GET_TERM_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_TERMOUTPUT Call by reference Type reference (TYPE) CPET_TERMOUTPUT 20130410
2 Returning RV_TERMVAL Value transfer Type reference (TYPE) CPET_TERMVAL 20130410
# Exception Resumable Description Created on
1 CX_CPE_EVALUATION_TERMINATED 20130410

Method LOG_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130425
2 Importing IV_SUBMODULE Call by reference Type reference (TYPE) CPET_LOG_SUBMODULE CPE Log - Submodule 20130425

Method LOG_MESSAGE on class CL_CPE_PRCFIX_OPTION has no exception.

Method PRICEFIXOPTDEF_RULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_PRCFIXOPTDEFRULE Call by reference Type reference (TYPE) CPEC_PRCFIXRULE CPE Term - Rule for Def. of Price Fixation Option 20130912
2 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130912
3 Importing IS_PRCFIXOPTDEF Call by reference Type reference (TYPE) CPED_PRCFIX_DEF Price Fixation Definition 20130912
4 Importing IV_PRCFIXOPTDEFRULE Call by reference Type reference (TYPE) CPET_PRCFIXOPTDEFRULE CPE Term - Rule for Definition of Price Fixation Option 20130912
# Exception Resumable Description Created on
1 CX_CPE_EVALUATION_TERMINATED CPE Evaluation Terminated 20130912

Method SET_ATTRIBUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ATTRIBUTE_NAME Call by reference Type reference (TYPE) FIELDNAME Field Name 20130410
2 Importing IV_ATTRIBUTE_VALUE Call by reference Type reference (TYPE) ANY 20130410

Method SET_ATTRIBUTE on class CL_CPE_PRCFIX_OPTION has no exception.

Method SET_DEFINITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DEFINITION Call by reference Type reference (TYPE) CPED_PRCFIX_DEF Price Fixation Definition 20130410

Method SET_DEFINITION on class CL_CPE_PRCFIX_OPTION has no exception.

Method SET_FORECAST_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FORECAST_STATUS Call by reference Type reference (TYPE) CPET_FORECAST_STATUS Status of Quotation Forecast 20130527

Method SET_FORECAST_STATUS on class CL_CPE_PRCFIX_OPTION has no exception.

Method SET_OPTION_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OPTION_STATUS Call by reference Type reference (TYPE) CPET_PRCFIX_STATUS Status of Price Fixation Option 20130410

Method SET_OPTION_STATUS on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_EXERCISE_DATE_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415

Method WRITE_EXERCISE_DATE_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_LIMIT_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415

Method WRITE_LIMIT_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_PRICE_REF_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IS_REMAINDER Call by reference Type reference (TYPE) CPET_TERMOUTPUT CPE Term - Generic Output Structure during Evaluation 20130415
3 Importing IS_REMAINDER_QTY Call by reference Type reference (TYPE) IF_CPE_PRCFIX_OPTION=>TY_QUANTITY CPE Quantity and UoM of a Price Fixation Option 20130415
4 Importing IV_RATE Call by reference Type reference (TYPE) CPET_INTERNAL_VALUE CPE - Used for internal calculation (rounding, conversion) 20130415
5 Importing IV_STATUS Call by reference Type reference (TYPE) CPET_TERMSTATUS CPE Term - Status 20130429
6 Importing IV_VALUE Call by reference Type reference (TYPE) CPET_INTERNAL_VALUE CPE - Used for internal calculation (rounding, conversion) 20130415

Method WRITE_PRICE_REF_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_QUANTITY_DISTRIB_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IS_TERMOUTPUT Call by reference Type reference (TYPE) CPET_TERMOUTPUT CPE Term - Generic Output Structure during Evaluation 20130415

Method WRITE_QUANTITY_DISTRIB_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_TRACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IV_NAME Call by reference Type reference (TYPE) CPET_LOG_NAME CPE Log - Name 20130415
3 Importing IV_OUTPUT Call by reference Type reference (TYPE) CPET_LOG_OUT_IN CPE Log - Output or Input 20130415
4 Importing IV_SUBMODULE Call by reference Type reference (TYPE) CPET_LOG_SUBMODULE CPE Log - Submodule 20130415
5 Importing IV_VALUE Call by reference Type reference (TYPE) ANY 20130415

Method WRITE_TRACE on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_TRACE_FOR_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IS_STRUCT Call by reference Type reference (TYPE) ANY Structure to be written to trace 20130415
3 Importing IT_COMPONENT_FILTER Call by reference Type reference (TYPE) TY_FIELNAMES List of components of the structure 20130415
4 Importing IV_OUTPUT Call by reference Type reference (TYPE) CPET_LOG_OUT_IN IF_CPE_CONSTANTS=>C_INPUT CPE Log - Output or Input 20130415
5 Importing IV_SUBMODULE Call by reference Type reference (TYPE) CPET_LOG_SUBMODULE CPE Log - Submodule 20130415

Method WRITE_TRACE_FOR_STRUCTURE on class CL_CPE_PRCFIX_OPTION has no exception.

Method WRITE_TRACE_FOR_STRUCT_FIELD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVALUATION_DATA Call by reference Object reference (TYPE REF TO) CL_CPE_FE_EVALUATION_DATA CPE Evaluation data container 20130415
2 Importing IR_DESCR Call by reference Object reference (TYPE REF TO) CL_ABAP_STRUCTDESCR Runtime Type Services 20130529
3 Importing IS_STRUCT Call by reference Type reference (TYPE) ANY 20130415
4 Importing IV_NAME Call by reference Type reference (TYPE) CPET_LOG_NAME CPE Log - Name 20130415
5 Importing IV_OUTPUT Call by reference Type reference (TYPE) CPET_LOG_OUT_IN CPE Log - Output or Input 20130415
6 Importing IV_SUBMODULE Call by reference Type reference (TYPE) CPET_LOG_SUBMODULE CPE Log - Submodule 20130415

Method WRITE_TRACE_FOR_STRUCT_FIELD on class CL_CPE_PRCFIX_OPTION has no exception.
Event Signatures

Event LIMIT_EXCEEDED Signature
Event LIMIT_EXCEEDED on class CL_CPE_PRCFIX_OPTION has no parameter.
History
Last changed by/on SAP  20140121 
SAP Release Created in