SAP ABAP Class CL_CLS_FACTORY (Factory)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL-CLS (Application Component) Classification Toolset
     ⤷ SPAK_API_CLASSIFICATION (Package) API for Classification Tool Set

Properties

Class	CL_CLS_FACTORY
Short Description	Factory
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPAK_API_CLASSIFICATION	API for Classification Tool Set
Created	20050419	SAP
Last change	20110908	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)

Interfaces

Class CL_CLS_FACTORY has no interface implemented.

Friends

Class CL_CLS_FACTORY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CACHED_OBJECT_LIST	Static Attribute	Private	☐	Type reference (TYPE)	TY_CACHED_OBJECT_LIST		Instance cache	20050420
2	CO_CLASSES	Constant	Private	☐	See coding				20050420
3	SYSTEM_TYPE	Static Attribute	Public	☐	Type reference (TYPE)	SY-SYSID		Name of the SAP System	20050812

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_OBJECT_EXISTENCE	Static method	Private	Method	Checks if needed instance already exists in memory	20050420
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20050504
3	CREATE_ASSIGNMENT_CACHE	Static method	Public	Method	Create a cache for assignments	20070313
4	CREATE_OBJECT_ATTRIBUTE	Static method	Public	Method	Creates a new attribute	20050511
5	CREATE_OBJECT_TYPE_GROUP	Static method	Public	Method	Creates a new object type group	20050420
6	CREATE_REPORT_DEF	Static method	Public	Method	Creates a new report definition	20050901
7	CREATE_REPORT_RUN	Static method	Public	Method	Create run	20051014
8	CREATE_TYPE_DIRECTORY	Static method	Public	Method	Create type directory	20050915
9	DELETE_FROM_CACHE	Static method	Private	Method	Deletes instances from the cache	20050503
10	GET_ACTIVATION_STATE	Static method	Private	Method	Returns relevant activation state for activation state 'X'	20050420
11	GET_ATTRIBUTE_OBJECT	Static method	Private	Method	Returns a reference to an attribute	20050510
12	GET_ATTR_VALUE_ASSIGNMENT	Static method	Public	Method	Returns an existing classification	20050601
13	GET_OBJECT_ATTRIBUTE	Static method	Public	Method	Returns an existing attribute	20050510
14	GET_OBJECT_TYPE_GROUP	Static method	Public	Method	Returns an existing object type group	20050420
15	GET_OTYGR_OBJECT	Static method	Private	Method	Returns a reference to an object type group	20050420
16	GET_REPORT_DEF	Static method	Public	Method	Returns an existing report definition	20050901
17	GET_REPORT_RUN	Static method	Public	Method	Get run	20051014
18	GET_REP_DEF	Static method	Private	Method	Returns a reference to a report definition	20050901
19	ON_ATTRIBUTE_DELETED	Static method	Private	Event handling method	Event: An attribute has been deleted	20050504
20	ON_OTYGR_DELETED	Static method	Private	Event handling method	Event: An object type group has been deleted	20050504
21	UNCACHE_ALL	Static method	Public	Method	Clear cache	20050527
22	UNCACHE_OBJECT_ATTRIBUTE	Static method	Public	Method	Remove attribute from the cache	20050510
23	UNCACHE_OBJECT_TYPE_GROUP	Static method	Public	Method	Remove a group from the cache	20050506

Events

Class CL_CLS_FACTORY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_CACHED_OBJECT	Private	See coding			20050420	begin of ty_cached_object, object_name type sobj_name, class_name type seoclsname, object_ref type ref to object, end of ty_cached_object
2	TY_CACHED_OBJECT_LIST	Private	See coding			20050420	ty_cached_object_list type hashed table of ty_cached_object with unique key object_name class_name

Method Signatures

Method CHECK_OBJECT_EXISTENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name of the appropriate class of the object name	20050420
2	Importing	IM_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Name of an object; e.g. package name, interface name	20050420
3	Returning	RE_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20050420

Method CHECK_OBJECT_EXISTENCE on class CL_CLS_FACTORY has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_CLS_FACTORY has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CLS_FACTORY has no exception.

Method CREATE_ASSIGNMENT_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ASSIGNMENT_CACHE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_ASSIGNMENT_CACHE		Cache for classifications	20070313

Method CREATE_ASSIGNMENT_CACHE on class CL_CLS_FACTORY has no exception.

Method CREATE_OBJECT_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CACHE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	SPACE	ABAP_TRUE to put created instance into the factory's cache	20050511
2	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Name of the attribute to create	20050511
3	Importing	IM_TYPE_GROUP	Call by reference	☑	Type reference (TYPE)	CLS_OBJECT_TYPE_GROUP		Object type group	20050517
4	Returning	RE_GROUP	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_ATTRIBUTE		Instance representing the created package	20050511

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid object type group data	20050706
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20050706
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050511
4	CX_PAK_WB_OBJECT_LOCKED	☐	Error situation: enqueue locks hold by other instance	20060602

Method CREATE_OBJECT_TYPE_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CACHE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	SPACE	ABAP_TRUE to put created instance into the factory's cache	20050420
2	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLS_OBJECT_TYPE_GROUP		Name of the package to create	20050420
3	Returning	RE_GROUP	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_OBJECT_TYPE_GROUP		Instance representing the created package	20050420

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid package data	20050615
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20050615
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050420
4	CX_PAK_WB_OBJECT_LOCKED	☐	Error situation: enqueue locks hold by other instance	20060602

Method CREATE_REPORT_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CACHE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20050901
2	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLS_REPORT_DEF_NAME		Program/transaction in SQL trace analysis	20050901
3	Returning	RE_REPORT_DEF	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_DEF			20050901

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20050901
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20050901
3	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20050901
4	CX_PAK_WB_OBJECT_LOCKED	☐	Error situation: enqueue locks hold by other instance	20060602

Method CREATE_REPORT_RUN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REPORT	Call by reference	☐	Type reference (TYPE)	CLIKE		Name of report definition	20051014
2	Returning	RE_REPORT_RUN	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_RUN		Interface for report run	20051014

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20051014
2	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20051118

Method CREATE_TYPE_DIRECTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_GROUP_LIST	Call by reference	☑	Type reference (TYPE)	CLS_OBJECT_TYPE_GROUP_ELEMENTS		Elements of an object type group	20050915
2	Importing	IM_TYPE_LIST	Call by reference	☐	Type reference (TYPE)	CLS_OBJECT_TYPE_GROUP_ELEMENTS		Elements of an object type group	20050915
3	Returning	RE_TYPE_DIRECTORY	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_TYPE_DIRECTORY		Attribute	20050915

Method CREATE_TYPE_DIRECTORY on class CL_CLS_FACTORY has no exception.

Method DELETE_FROM_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name of the appropriate class of the object name	20050503
2	Importing	IM_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Name of an object; e.g. package name, interface name	20050503

Method DELETE_FROM_CACHE on class CL_CLS_FACTORY has no exception.

Method GET_ACTIVATION_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	SOBJ_NAME		Object Name in Object List	20050420
2	Importing	IM_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	TROBJTYPE		cl_pak_domains=>co_obj_type	20050420
3	Returning	RE_ACTIVATION_STATE	Value transfer	☐	Type reference (TYPE)	PAK_ACTIVATION_STATE		Activation state for package data	20050420

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20061026
2	CX_PAK_INVALID_STATE	☐	Method can not be executed at present object state	20050420

Method GET_ATTRIBUTE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Development class for Transport Organizer	20050510
2	Importing	IM_VERSION	Call by reference	☑	Type reference (TYPE)	PAK_VERSION	CL_PAK_DOMAINS=>CO_VERSION-AUTOMATIC	Package version	20050510
3	Returning	RE_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_ATTRIBUTE		Groups common properties of packages & generation extensions	20050510

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid object type group data	20050812
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20060411
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050510

Method GET_ATTR_VALUE_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ASSIGNMENT_ID	Call by reference	☑	Type reference (TYPE)	GUID_32		GUID in 'CHAR' Format in Uppercase	20050601
2	Importing	IM_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	CLIKE		Attribute	20050601
3	Importing	IM_CACHE	Call by reference	☑	Object reference (TYPE REF TO)	IF_CLS_ASSIGNMENT_CACHE		Versions of API-objects	20070313
4	Importing	IM_OBJECT	Call by reference	☑	Type reference (TYPE)	PAK_OBJECT_KEY		Object	20050601
5	Importing	IM_PACKAGE	Call by reference	☑	Type reference (TYPE)	DEVCLASS		Package	20050601
6	Importing	IM_REPORT_RUN_RESULT	Call by reference	☑	Object reference (TYPE REF TO)	CL_CLS_REPORT_RUN_RESULT		Container for objects and classifications	20100128
7	Returning	RE_ASSIGNMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_ATTR_VALUE_ASSIGNMENT		Instance representing the group	20050601

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid package data	20050615
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20050615
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050601

Method GET_OBJECT_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Attribute	20050510
2	Importing	IM_VERSION	Call by reference	☑	Type reference (TYPE)	PAK_VERSION	CL_PAK_DOMAINS=>CO_VERSION-AUTOMATIC	Version	20050510
3	Returning	RE_ATTRIBUTE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_ATTRIBUTE		Instance representing the attribute	20050510

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid object type group data	20050812
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20060411
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050510

Method GET_OBJECT_TYPE_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Group	20050420
2	Importing	IM_VERSION	Call by reference	☑	Type reference (TYPE)	PAK_VERSION	CL_PAK_DOMAINS=>CO_VERSION-AUTOMATIC	Version	20050420
3	Returning	RE_GROUP	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_OBJECT_TYPE_GROUP		Instance representing the group	20050420

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid package data	20060411
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20060411
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050420

Method GET_OTYGR_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLS_OBJECT_TYPE_GROUP		Development class for Transport Organizer	20050420
2	Importing	IM_VERSION	Call by reference	☑	Type reference (TYPE)	PAK_VERSION	CL_PAK_DOMAINS=>CO_VERSION-AUTOMATIC	Package version	20050420
3	Returning	RE_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_OBJECT_TYPE_GROUP		Groups common properties of packages & generation extensions	20050420

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid package data	20060411
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20060411
3	CX_PAK_NOT_AUTHORIZED	☐	User does not have the right privileges	20050420

Method GET_REPORT_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20050901
2	Importing	IM_VERSION	Call by reference	☑	Type reference (TYPE)	PAK_VERSION	CL_PAK_DOMAINS=>CO_VERSION-AUTOMATIC	Versions of API-objects	20050901
3	Returning	RE_REPORT_DEF	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_DEF		Report definition	20050901

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20050901
2	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20050901

Method GET_REPORT_RUN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REPORT	Call by reference	☐	Type reference (TYPE)	CLS_REPORT_DEF_NAME		Name of report definition	20051014
2	Importing	IM_VERSION	Call by reference	☐	Type reference (TYPE)	CLS_RUN_VERSION		Version of a report run	20051014
3	Returning	RE_REPORT_RUN	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_RUN		Interface for report run	20051014

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20051014
2	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20051118

Method GET_REP_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20050901
2	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLS_REPORT_DEF_NAME		Program/transaction in SQL trace analysis	20050901
3	Importing	IM_VERSION	Call by reference	☑	Type reference (TYPE)	PAK_VERSION	CL_PAK_DOMAINS=>CO_VERSION-AUTOMATIC	Versions of API-objects	20050901
4	Returning	RE_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_DEF		Definition of calssificationsreport	20050901

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20050901
2	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20050901

Method ON_ATTRIBUTE_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_ATTRIBUTE_NAME	Value transfer	☐	Attribute reference (LIKE)				20050504
2	Importing	EX_CLASS_NAME	Value transfer	☐	Attribute reference (LIKE)				20050504

Method ON_ATTRIBUTE_DELETED on class CL_CLS_FACTORY has no exception.

Method ON_OTYGR_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_CLASS_NAME	Value transfer	☐	Attribute reference (LIKE)				20050504
2	Importing	EX_GROUP_NAME	Value transfer	☐	Attribute reference (LIKE)				20050504

Method ON_OTYGR_DELETED on class CL_CLS_FACTORY has no exception.

Method UNCACHE_ALL Signature

Method UNCACHE_ALL on class CL_CLS_FACTORY has no parameter.
Method UNCACHE_ALL on class CL_CLS_FACTORY has no exception.

Method UNCACHE_OBJECT_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20050510

Method UNCACHE_OBJECT_ATTRIBUTE on class CL_CLS_FACTORY has no exception.

Method UNCACHE_OBJECT_TYPE_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_GROUP	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20050506

Method UNCACHE_OBJECT_TYPE_GROUP on class CL_CLS_FACTORY has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	710