SAP ABAP Class CL_CPF_PARAMETERS (CPF: Formula parameters)

Hierarchy

☛ PI_BASIS (Software Component) Basis Plug-In
   ⤷ CA-GTF-PR-CPF (Application Component) Configurable Parameters and Formulas
     ⤷ CPF_BASIS (Package) Configurable Parameters and Formulas (Basis)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CPF_CONSTANTS	Interface CPF constants	20120726
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CPF_PARAMETERS	Interface for CPF Formula parameter handling	20120726
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_OS_CLONE	Object Services: Clone Operations	20120726

Properties

Class	CL_CPF_PARAMETERS
Short Description	CPF: Formula parameters
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CPF_BASIS	Configurable Parameters and Formulas (Basis)
Created	20120726	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_ABAP_STRUCTDESCR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CPF_CONSTANTS	☐	☐	Interface CPF constants	20120726
2	IF_CPF_PARAMETERS	☐	☐	Interface for CPF Formula parameter handling	20120726
3	IF_OS_CLONE	☐	☐	Object Services: Clone Operations	20120726

Friends

Class CL_CPF_PARAMETERS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_FACTORY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CPF_BASIS_FACTORY		CPF Factory: gets/generates needed instances	20120726
2	MT_PARAMCAT	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_PARAMCAT		Table type for CPF parameter catalog	20121211
3	MT_PARAMETER	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_PARAMETER		Table of parameters	20120823
4	MT_SCALE	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_OBJ_SCALE		Table of CPF Scale with values	20130111
5	MT_USAGETASK	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_USAGETASK		Table type for CPF usage tasks	20130109
6	MV_CHANGED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Is true if parameter data were changed	20130320
7	MV_USAGE	Instance attribute	Protected	☐	Type reference (TYPE)	CPF_USAGE		CPF usage	20120806

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20120726
2	CREATE_DATA_FOR_DDIC_TYPE	Static method	Public	Method	Creates a data object based on a DDIC type	20120911
3	FILL_DB_PARAMETER_TABLE	Instance method	Public	Method	Fill parameters as name-value list	20120726
4	FILL_DB_SCALE_TABLE	Instance method	Public	Method	Fill parameters as name-value list	20130415
5	GET_PARAMETER_AS_STRUCT	Instance method	Public	Method	Returns a parameter with its subparameters as structure	20120830
6	GET_PARAMETER_INITIAL_VALUE	Instance method	Public	Method	Returns an object with initial value for a parameter	20120824
7	SET_FROM_DB_PARAMETER_TABLE	Instance method	Public	Method	Set parameters based on DB parameters	20120726
8	SET_FROM_DB_SCALE_TABLE	Instance method	Public	Method	Set scale lines based on DB parameters	20130111
9	SET_PARAMETER_W_INITIAL_VALUE	Instance method	Public	Method	Add/modify parameters with initial value	20120824

Events

Class CL_CPF_PARAMETERS has no event.

Types

Class CL_CPF_PARAMETERS has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FACTORY	Call by reference	☑	Object reference (TYPE REF TO)	IF_CPF_BASIS_FACTORY		CPF Factory: gets/generates needed instances	20120726
2	Importing	IV_USAGE	Call by reference	☐	Type reference (TYPE)	CPF_USAGE		CPF usage	20120806

Method CONSTRUCTOR on class CL_CPF_PARAMETERS has no exception.

Method CREATE_DATA_FOR_DDIC_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_VALUE	Call by reference	☐	Type reference (TYPE)	DATA			20120911
2	Importing	IV_DDIC_TYPE	Call by reference	☐	Type reference (TYPE)	DATATYPE_D		Data Type in ABAP Dictionary	20120911
3	Importing	IV_DDLENGTH	Call by reference	☐	Type reference (TYPE)	DDLENG		Length (No. of Characters)	20120911
4	Importing	IV_DECIMALS	Call by reference	☐	Type reference (TYPE)	DECIMALS		Number of Decimal Places	20120911

Method CREATE_DATA_FOR_DDIC_TYPE on class CL_CPF_PARAMETERS has no exception.

Method FILL_DB_PARAMETER_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	CPF_GUID		CPF document guid	20120807
2	Returning	RT_PARAMETER	Value transfer	☐	Type reference (TYPE)	CPFT_DOC_FORMULAPAR		Table type for CPF Document parameters	20120823

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130320

Method FILL_DB_SCALE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SCALE	Call by reference	☐	Type reference (TYPE)	CPFT_SCALE		Table of CPF Scale Header	20130415
2	Exporting	ET_SCALE_LINE	Call by reference	☐	Type reference (TYPE)	CPFT_SCALE_LINE		Table of CPF Scale Line	20130415
3	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	CPF_GUID		CPF document guid	20130415

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130415

Method GET_PARAMETER_AS_STRUCT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_PARAMETER_NAME		CPF Parameter Name	20120830
2	Returning	RO_STRUCTURE	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20120830

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130320

Method GET_PARAMETER_INITIAL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_PARAMETER_NAME		CPF parameter name	20120824
2	Importing	IV_SUBPARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_SUBPARAMETER	' '	CPF Subparameter	20120824
3	Returning	RO_VALUE	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20120824

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130320

Method SET_FROM_DB_PARAMETER_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FORMULAPAR	Call by reference	☐	Type reference (TYPE)	CPFT_DOC_FORMULAPAR		Table type for CPF Document parameters	20120823

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130320

Method SET_FROM_DB_SCALE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SCALE	Call by reference	☐	Type reference (TYPE)	CPFT_SCALE		Table type for CPF Scale Header	20130111
2	Importing	IT_SCALE_LINE	Call by reference	☐	Type reference (TYPE)	CPFT_SCALE_LINE		Table type for CPF Scale Line	20130111

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130320

Method SET_PARAMETER_W_INITIAL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_PARAMETER_NAME		CPF Parameter Name	20120824
2	Importing	IV_SUBPARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_SUBPARAMETER	' '	CPF Subparameter	20120824

#	Exception	Resumable	Description	Created on
1	CX_CPF	☐	Exception for CPF	20130320
2	CX_CPF_NOTHING_FOUND	☐	Exception: Nothing was found	20130320

History

Last changed by/on	SAP	20130531
SAP Release Created in	740