SAP ABAP Class CL_CFX_SETTINGS (Storage of Configurations)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_FOLDERS (Package) Collaboration Folders: Folder and Documents

Properties

Class	CL_CFX_SETTINGS
Short Description	Storage of Configurations
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_FOLDERS	Collaboration Folders: Folder and Documents
Created	20010319	SAP
Last change	20141109
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	CFXF1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	IXML	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SKWFC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CFX_SETTINGS has no interface implemented.

Friends

Class CL_CFX_SETTINGS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MP_DOCUMENT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_CFX_SETTINGS_DOC		Storage of Configurations	20010322
2	MP_DOM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010320
3	M_DOC_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20010329
4	M_FOLDER_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20010329
5	SC_FALSE	Static Attribute	Public	☑	Type reference (TYPE)	STRING	'false'		20010510
6	SC_FOLDER_NAME	Constant	Public	☐	Type reference (TYPE)	SKWF_DESCR	'Settings'	KW Framework: Description	20010322
7	SC_NA_CREATED	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Created	20010323
8	SC_NA_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name	20010319
9	SC_NE_SETTINGS	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Settings	20010319
10	SC_NULL_VALUE	Constant	Public	☐	Type reference (TYPE)	STRING	'NA'		20010615
11	SC_NULL_VALUE_LOC	Constant	Public	☐	Type reference (TYPE)	STRING	'0123456789012345'		20020412
12	SC_TRUE	Static Attribute	Public	☑	Type reference (TYPE)	STRING	'true'		20010510
13	SC_UNDEFINED	Static Attribute	Public	☑	Type reference (TYPE)	STRING	'undefined'		20010814

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Creates a Settings Object	20010319
2	CREATE_DOCUMENT	Instance method	Private	Method	Creates a Settings Document	20010329
3	GET_SETTING	Instance method	Public	Method	Returns a Setting and May Create It	20010319
4	GET_SETTING_LIST	Instance method	Public	Method	Returns a List of Key Value Pairs	20010323
5	GET_SETTING_LIST_BY_ROLE	Instance method	Public	Method	Returns a List of Key Value Pairs	20120920
6	SET_SETTING	Instance method	Public	Method	Changes or Creates a Setting	20010319
7	SET_SETTINGS	Instance method	Public	Method	Set List of Settings at once	20050119
8	SET_SETTING_LIST	Instance method	Public	Method	Creates a List of Key Value Pairs	20010323
9	TEST	Static method	Public	Method	Tests Class	20010319

Events

Class CL_CFX_SETTINGS has no event.

Types

Class CL_CFX_SETTINGS 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	I_FOLDER_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20010327
2	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der XML Datei	20010319

Method CONSTRUCTOR on class CL_CFX_SETTINGS has no exception.

Method CREATE_DOCUMENT Signature

Method CREATE_DOCUMENT on class CL_CFX_SETTINGS has no parameter.
Method CREATE_DOCUMENT on class CL_CFX_SETTINGS has no exception.

Method GET_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DEFAULT	Value transfer	☐	Type reference (TYPE)	STRING		Vorgabewert	20010319
2	Importing	I_KEY	Value transfer	☐	Type reference (TYPE)	STRING		Schlüssel der Einstellung	20010319
3	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Wert der Einstellung	20010319

Method GET_SETTING on class CL_CFX_SETTINGS has no exception.

Method GET_SETTING_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DONT_SPLIT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Abfrage ob der Schlüssel nicht gesplittet werden soll	20100326
2	Importing	I_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20010323
3	Returning	RT_SETTING	Value transfer	☐	Type reference (TYPE)	CFX_TT_KEY_VALUE_PAIR		Tabelle mit Schlüssel-Wert-Paaren	20010323

Method GET_SETTING_LIST on class CL_CFX_SETTINGS has no exception.

Method GET_SETTING_LIST_BY_ROLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20120920
2	Importing	I_LIST	Call by reference	☑	Type reference (TYPE)	STRING		Name of List- Tag	20120920
3	Importing	I_ROLE	Call by reference	☐	Type reference (TYPE)	STRING		Value of Role- Tag	20120920
4	Returning	RT_SETTING	Value transfer	☐	Type reference (TYPE)	CFX_TT_KEY_VALUE_PAIR		Table with Key Value Pairs	20120920

Method GET_SETTING_LIST_BY_ROLE on class CL_CFX_SETTINGS has no exception.

Method SET_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_KEY	Value transfer	☐	Type reference (TYPE)	STRING		Schlüssel der Einstellung	20010319
2	Importing	I_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Wert	20010319

Method SET_SETTING on class CL_CFX_SETTINGS has no exception.

Method SET_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SETTINGS	Call by reference	☐	Type reference (TYPE)	CFX_TT_SETTING_VALUE		Schlüssel-Wert-Paare für cFolders-Einstellungen	20050119

Method SET_SETTINGS on class CL_CFX_SETTINGS has no exception.

Method SET_SETTING_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SETTING	Call by reference	☐	Type reference (TYPE)	CFX_TT_KEY_VALUE_PAIR		Tabelle mit Schlüssel-Wert-Paaren	20010323
2	Importing	I_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20010323

Method SET_SETTING_LIST on class CL_CFX_SETTINGS has no exception.

Method TEST Signature

Method TEST on class CL_CFX_SETTINGS has no parameter.
Method TEST on class CL_CFX_SETTINGS has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	20A