SAP ABAP Class CL_CPF_ROUTINE_PARAMETERS (CPF: Routine parameter handling (default class))

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	20120822
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CPF_ROUTINE_PARAMETERS	Interface for CPF Routine parameter handling	20120822

Properties

Class	CL_CPF_ROUTINE_PARAMETERS
Short Description	CPF: Routine parameter handling (default class)
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	20120822	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CPF_ROUTINE_PARAMETERS has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CPF_CONSTANTS	☐	☐	Interface CPF constants	20120822
2	IF_CPF_ROUTINE_PARAMETERS	☐	☐	Interface for CPF Routine parameter handling	20120822

Friends

Class CL_CPF_ROUTINE_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 BASIS Factory: gets/generates needed instances	20120824
2	MO_FORMULA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CPF_FORMULA		Interface for CPF formula	20130415
3	MT_PARAMETER	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_PARAMETER		Routine parameters	20120823
4	MT_SCALE	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_OBJ_SCALE		Table type for CPF Scale with values	20130114
5	MV_BRFPLUS_FUNCTION	Instance attribute	Protected	☐	Type reference (TYPE)	FDT_UUID		FDT: Universal Unique Identifier	20121011
6	MV_ROUTINE	Instance attribute	Protected	☐	Type reference (TYPE)	CPF_ROUTINE		CPF Routine	20120824

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_FORMULA_PARAMETERS	Instance method	Public	Method	Adds formula parameters	20121221
2	CONSTRUCTOR	Instance method	Public	Constructor		20120822
3	GET_ALL_PARAMETERS	Instance method	Public	Method	Returns a list of all parameters	20120824
4	GET_PARAMETER	Instance method	Public	Method	Get parameter value as reference	20120823
5	GET_PARAMETER_AS_STRUCT	Instance method	Public	Method	Returns a parameter as structures	20121221
6	GET_PARAMETER_INFO	Instance method	Public	Method	Get infos about a parameter (data type and category, compon)	20120824
7	SET_BRFPLUS_FUNCTION	Instance method	Public	Method	Adds a BRFplus function	20121015
8	SET_PARAMETER	Instance method	Public	Method	Add/replace parameter with its value	20120823
9	SET_PARAMETER_W_INITIAL_VALUE	Instance method	Public	Method	Sets parameter with initial value	20120824
10	SET_SCALE	Instance method	Public	Method	Add/replace parameter scale	20130114

Events

Class CL_CPF_ROUTINE_PARAMETERS has no event.

Types

Class CL_CPF_ROUTINE_PARAMETERS has no local type.

Method Signatures

Method ADD_FORMULA_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FORMULA_PARAMETERS	Call by reference	☐	Object reference (TYPE REF TO)	IF_CPF_PARAMETERS		Interface for CPF Formula parameter handling	20121221

Method ADD_FORMULA_PARAMETERS on class CL_CPF_ROUTINE_PARAMETERS has no exception.

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 BASIS Factory: gets/generates needed instances	20120824
2	Importing	IO_FORMULA	Call by reference	☐	Object reference (TYPE REF TO)	IF_CPF_FORMULA		Interface for CPF formula	20130415
3	Importing	IV_ROUTINE	Call by reference	☐	Type reference (TYPE)	CPF_ROUTINE		CPF Routine	20120824

Method CONSTRUCTOR on class CL_CPF_ROUTINE_PARAMETERS has no exception.

Method GET_ALL_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PARAMETER	Value transfer	☐	Type reference (TYPE)	CPFT_PARAMETER		Table type for CPF parameter	20120824

Method GET_ALL_PARAMETERS on class CL_CPF_ROUTINE_PARAMETERS has no exception.

Method GET_PARAMETER 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	20120823
2	Importing	IV_SUBPARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_SUBPARAMETER	' '	CPF Subparameter	20120823
3	Returning	RO_VALUE	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Value	20120823

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

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	20121221
2	Returning	RO_STRUCTURE	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20121221

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

Method GET_PARAMETER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMPONENTS	Call by reference	☐	Type reference (TYPE)	CPFT_CUSSTRUCC		Table type for CPF Custom Structure Component	20120824
2	Exporting	EV_DATA_CATEGORY	Call by reference	☐	Type reference (TYPE)	CPF_DATA_CATEGORY		CPF Data Category	20120824
3	Exporting	EV_DATA_TYPE	Call by reference	☐	Type reference (TYPE)	CPF_REF_DATA_TYPE_P		CPF Data Type	20120824
4	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_PARAMETER_NAME		CPF parameter name	20120824
5	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

Method SET_BRFPLUS_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BRFPLUS_FUNCTION	Call by reference	☐	Type reference (TYPE)	FDT_UUID		FDT: Universal Unique Identifier	20121015

Method SET_BRFPLUS_FUNCTION on class CL_CPF_ROUTINE_PARAMETERS has no exception.

Method SET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_VALUE	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20120823
2	Importing	IV_DATACATEGORY	Call by reference	☑	Type reference (TYPE)	CPF_DATA_CATEGORY		CPF Data Category	20121227
3	Importing	IV_DATA_TYPE	Call by reference	☑	Type reference (TYPE)	CPF_REF_DATA_TYPE		CPF Referenced Data Type	20121227
4	Importing	IV_DS_ROUTINE	Call by reference	☑	Type reference (TYPE)	CPF_DS_ROUTINE		CPF Data Source Routine	20121227
5	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_PARAMETER_NAME		CPF parameter name	20120823
6	Importing	IV_SUBPARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_SUBPARAMETER	' '	CPF Subparameter	20120823

Method SET_PARAMETER on class CL_CPF_ROUTINE_PARAMETERS has no exception.

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

Method SET_SCALE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SCALE	Call by reference	☐	Type reference (TYPE)	CPFS_OBJ_SCALE		CPF Scale with values	20130114
2	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_PARAMETER_NAME		CPF parameter name	20130114
3	Importing	IV_SUBPARAMETER	Call by reference	☐	Type reference (TYPE)	CPF_SUBPARAMETER	' '	CPF Subparameter	20130114

Method SET_SCALE on class CL_CPF_ROUTINE_PARAMETERS has no exception.

History

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