SAP ABAP Class CL_BP_CONTROL_OBJ_POOL (All the control objects)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-BTC (Application Component) Background Processing
     ⤷ SBTCONOBJ (Package) Control Objects, Comp. Trace, Verfication, Cleanup for BTC

Properties

Class	CL_BP_CONTROL_OBJ_POOL
Short Description	All the control objects
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SBTCONOBJ	Control Objects, Comp. Trace, Verfication, Cleanup for BTC
Created	19990430	SAP
Last change	20041228	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	BTC0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CNTL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_BP_CONTROL_OBJ_POOL has no interface implemented.

Friends

Class CL_BP_CONTROL_OBJ_POOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACT_SERVER_LIST	Static Attribute	Private	☐	Type reference (TYPE)	TY_ACT_SERVER_LIST			20041112
2	CTRLOBJDEL	Instance attribute	Protected	☐	See coding			The delete list	19990503
3	CTRLOBJECT	Instance attribute	Protected	☐	See coding			One Ctrl Object	19990430
4	CTRLOBJPOOL	Instance attribute	Protected	☐	See coding			The object pool	19990430
5	FILL_LEVEL	Instance attribute	Public	☑	Type reference (TYPE)	I	0	Fill level of the pool	19990430

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CTRLOBJECT	Instance method	Public	Method	Add a new ctrl object to the pool	19990430
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	19990430
3	DELETE_CTRLOBJECT	Instance method	Public	Method	Delete specified ctrl object from pool	19990430
4	LOAD_FROM_DB	Instance method	Public	Method	Persistent object pool -> Object pool instance	19990430
5	MODIFY_CTRLOBJECT	Instance method	Public	Method	Modify an existing ctrl object from the user interface	19990504
6	PURGE_OBSOLETE	Instance method	Public	Method	Get rid of not valid or unecessary entries	19990510
7	RETURN_CTRLOBJECT	Instance method	Public	Method	Select a pool ctrl object by its key	19990430
8	SELECT_CTRLOBJECT_BY_IDX	Instance method	Public	Method	Select a pool ctrl object by its (arbitrary) index	19990430
9	UPDATE_DB	Instance method	Public	Method	Object pool -> object pool on data base	19990430

Events

Class CL_BP_CONTROL_OBJ_POOL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_ACT_SERVER_LIST	Private	See coding			20041112	TY_ACT_SERVER_LIST type standard table of msxxlist

Method Signatures

Method ADD_CTRLOBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPL_PARAMS	Call by reference	☐	Type reference (TYPE)	COBJ_DISPL		der Benutzer hat etwas Neues angelegt	19990430

#	Exception	Resumable	Description	Created on
1	CTRLTYPE_MISSING	☐	kein Steuerungstyp angegeben	19990430
2	INSERT_FAILED	☐	neues StrgObjekt nicht einfügbar, Schlüssel schon verwendet?	19990504
3	SERVERNAME_MISSING	☐	kein Servername angegeben	19990430

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_BP_CONTROL_OBJ_POOL has no parameter.
Method CONSTRUCTOR on class CL_BP_CONTROL_OBJ_POOL has no exception.

Method DELETE_CTRLOBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COBJ_KEY	Call by reference	☐	Type reference (TYPE)	COBJ_KEYTX		Schlüssel eines Steuerungsobjekts	19990430

#	Exception	Resumable	Description	Created on
1	INVALID_KEY	☐	ungültige Schlüsseleingabe	19990430
2	OBJECT_NOT_FOUND	☐	Objekt nicht gefunden	19990430

Method LOAD_FROM_DB Signature

Method LOAD_FROM_DB on class CL_BP_CONTROL_OBJ_POOL has no parameter.
Method LOAD_FROM_DB on class CL_BP_CONTROL_OBJ_POOL has no exception.

Method MODIFY_CTRLOBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPL_PARAMS	Call by reference	☐	Type reference (TYPE)	COBJ_DISPL		benutzerspezifische Daten	19990504

#	Exception	Resumable	Description	Created on
1	CTRLTYPE_MISSING	☐	Alle Steuerungsobjekte vorhanden	19990504
2	MODIFY_FAILED	☐	Eintrag im Pool kann nicht modifiziert werden	19990504
3	SERVERNAME_MISSING	☐	Kein Servername angegeben	19990504

Method PURGE_OBSOLETE Signature

Method PURGE_OBSOLETE on class CL_BP_CONTROL_OBJ_POOL has no parameter.

#	Exception	Resumable	Description	Created on
1	NO_SERVER_LIST	☐	keine Serverliste verfügbar, daher keine Bereinigung möglich	19990510

Method RETURN_CTRLOBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COBJ_KEY	Call by reference	☐	Type reference (TYPE)	COBJ_KEYTX		Schlüssel: Servername + Steuerobjektbeschreibung	19990430
2	Exporting	RETCTRLOBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_BP_CONTROL_OBJ		das angegebene Steuerungsobjekt	19990430

#	Exception	Resumable	Description	Created on
1	INVALID_KEY	☐	ungültige Schlüsseleingabe	19990430
2	OBJECT_NOT_FOUND	☐	Objekt nicht gefunden	19990430

Method SELECT_CTRLOBJECT_BY_IDX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IDX	Call by reference	☐	Type reference (TYPE)	SYINDEX	1	Index des auszuwählenden Eintrags	19990430
2	Exporting	RETCTRLOBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_BP_CONTROL_OBJ		ein Steuerungsobjekt des Pools	19990430

#	Exception	Resumable	Description	Created on
1	OBJECT_NOT_FOUND	☐	Objekt nicht gefunden	19990430

Method UPDATE_DB Signature

Method UPDATE_DB on class CL_BP_CONTROL_OBJ_POOL has no parameter.
Method UPDATE_DB on class CL_BP_CONTROL_OBJ_POOL has no exception.

History

Last changed by/on	SAP	20041228
SAP Release Created in