SAP ABAP Class CL_BCFG_CONFIG_MANAGER (factory class for configuration containers)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CUS-TOL-API (Application Component) Business Configuration API (SAP-internal)
     ⤷ S_BCFG_API (Package) Business Configuration Support API

Properties

Class	CL_BCFG_CONFIG_MANAGER
Short Description	factory class for configuration containers
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_BCFG_API	Business Configuration Support API
Created	20100514	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BCFG_CONFIG_MANAGER has no forward declaration.

Interfaces

Class CL_BCFG_CONFIG_MANAGER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BCFG_BCSET_DS_HELPER	☐	20110223	helper for data-strategy, access to persistence Fubas
2	CL_BCFG_ENUM_CONTAINER_TYPE	☐	20100701	enum of container types (extendable)

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_FACTORIES	Static Attribute	Protected	☐	See coding				20100514

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_REGISTRATION	Static method	Private	Method		20100702
2	CHECK_VALID_CONTAINER_TYPE	Static method	Private	Method		20100702
3	CHECK_VALID_FACTORY	Static method	Private	Method		20100702
4	CREATE_CONTAINER	Static method	Public	Method	creates an empty container of a given type (see doc.)	20100514
5	DELETE_CONTAINER	Static method	Public	Method	deletes a saved container (see doc.)	20100706
6	DEREGISTER_FACTORY	Static method	Private	Method		20100623
7	FIND_CONTAINER	Static method	Public	Method	retrieves an existing container of a given type (see doc.)	20100514
8	GET_FACTORY	Static method	Private	Method		20100514
9	REGISTER_FACTORY	Static method	Private	Method		20100623

Events

Class CL_BCFG_CONFIG_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_FACTORY_ENTRY	Protected	See coding			20100623	begin of ty_factory_entry, ct_name type string, factory type ref to if_bcfg_config_factory, end of ty_factory_entry

Method Signatures

Method CHECK_REGISTRATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100702
2	Importing	IV_IS_REGISTRATED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100702

Method CHECK_REGISTRATION on class CL_BCFG_CONFIG_MANAGER has no exception.

Method CHECK_VALID_CONTAINER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100702

Method CHECK_VALID_CONTAINER_TYPE on class CL_BCFG_CONFIG_MANAGER has no exception.

Method CHECK_VALID_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100702
2	Importing	IO_FACTORY	Call by reference	☐	Object reference (TYPE REF TO)	IF_BCFG_CONFIG_FACTORY			20100702

Method CHECK_VALID_FACTORY on class CL_BCFG_CONFIG_MANAGER has no exception.

Method CREATE_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMMIT_MODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_COMMIT_MODE	CL_BCFG_ENUM_COMMIT_MODE=>USER_COMMIT	commit behavior of the container	20101202
2	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE		type of the container	20100628
3	Importing	IT_LANGUS	Call by reference	☑	Type reference (TYPE)	IF_BCFG_CONFIG_CONTAINER=>TY_T_LANGUAGES		list of covered languages	20100915
4	Importing	IT_OBJECT_MAPPINGS	Call by reference	☐	Type reference (TYPE)	IF_BCFG_CONFIG_CONTAINER=>TY_T_MAPPING_INFO		mapping structures to customizing objects ... (see doc.)	20101126
5	Importing	IV_RFC_DEST	Call by reference	☑	Type reference (TYPE)	RFCDEST		host of the container (for remote containers only)	20100922
6	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BCFG_CONFIG_CONTAINER		newly created container instance	20101125

#	Exception	Resumable	Description	Created on
1	CX_BCFG_COMMIT_MODE_UNSUPPORT	☐	container type does not support this commit mode and dest.	20110412
2	CX_BCFG_INVALID_MAPPING	☐	IT_OBJECT_MAPPINGS contains invalid data	20101126
3	CX_BCFG_LANGU_MISSING	☐	IT_LANGUS was not specified despite language spec. content	20101104
4	CX_BCFG_LANGU_NOT_ALLOWED	☐	Do not specify IT_LANGUS if content is not language specific	20101104

Method DELETE_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMMIT_MODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_COMMIT_MODE	CL_BCFG_ENUM_COMMIT_MODE=>USER_COMMIT		20110503
2	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100906
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100906
4	Importing	IV_RFC_DEST	Call by reference	☑	Type reference (TYPE)	RFCDEST			20100922
5	Importing	IV_WITH_LOGS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	remove also the corresponding log files from apply	20100714

#	Exception	Resumable	Description	Created on
1	CX_BCFG_COMMIT_MODE_UNSUPPORT	☐		20110503
2	CX_BCFG_OPERATION_FAILED	☐		20100706

Method DEREGISTER_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100628

Method DEREGISTER_FACTORY on class CL_BCFG_CONFIG_MANAGER has no exception.

Method FIND_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMMIT_MODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_COMMIT_MODE	CL_BCFG_ENUM_COMMIT_MODE=>USER_COMMIT		20101202
2	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE		container type (actual values provided by the impl.!)	20100628
3	Importing	IO_LOCK_MODE	Call by reference	☑	Object reference (TYPE REF TO)	CL_BCFG_ENUM_LOCK_MODE		Type safe enumeration for object locking	20101201
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100611
5	Importing	IV_RFC_DEST	Call by reference	☑	Type reference (TYPE)	RFCDEST			20100922
6	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BCFG_CONFIG_CONTAINER			20101125

#	Exception	Resumable	Description	Created on
1	CX_BCFG_COMMIT_MODE_UNSUPPORT	☐	container type or contents prevent usage of req. commit mode	20110503
2	CX_BCFG_NOT_FOUND	☐	no persistent container with type/id available	20100514
3	CX_BCFG_OPERATION_FAILED	☐	an internal error occured when loading the container	20101124

Method GET_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100628
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BCFG_CONFIG_FACTORY			20101125

Method GET_FACTORY on class CL_BCFG_CONFIG_MANAGER has no exception.

Method REGISTER_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCFG_ENUM_CONTAINER_TYPE			20100702
2	Importing	IO_FACTORY	Call by reference	☐	Object reference (TYPE REF TO)	IF_BCFG_CONFIG_FACTORY			20100623

Method REGISTER_FACTORY on class CL_BCFG_CONFIG_MANAGER has no exception.

History

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