SAP ABAP Class CL_CI_OBJS_COLLECTOR (Administration for General Object Collectors)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-ATF (Application Component) ABAP Test Frameworks ( ATC, CheckMan, Code Inspector)
     ⤷ S_CODE_INSPECTOR (Package) ABAP Source Code Analysis

Properties

Class	CL_CI_OBJS_COLLECTOR
Short Description	Administration for General Object Collectors
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_CODE_INSPECTOR	ABAP Source Code Analysis
Created	20020523	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CI_OBJS_COLLECTOR has no forward declaration.

Interfaces

Class CL_CI_OBJS_COLLECTOR has no interface implemented.

Friends

Class CL_CI_OBJS_COLLECTOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLASS_NAMES	Static Attribute	Private	☐	Type reference (TYPE)	SCI_COLS		Code Inspector: Names of Test Classes	20020809
2	C_FALSE	Constant	Private	☐	Type reference (TYPE)	FLAG	' '	CHAR01 Data Element for SYST	20020809
3	C_GENERAL	Constant	Private	☐	Type reference (TYPE)	SCI_GROUP	'GENERAL'	Code Inspector: User Group	20020813
4	C_TRUE	Constant	Private	☐	Type reference (TYPE)	FLAG	'X'	CHAR01 Data Element for SYST	20020809
5	LIST	Instance attribute	Public	☐	Type reference (TYPE)	SCI_TABCOLL		Code Inspector: Table with References to Collectors	20020809
6	SELECTED_COLL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CI_COLLECTOR_ROOT		Code Inspector: Administration of Object Collectors	20030117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_COLLECTOR	Static method	Public	Method	Add New Collector	20020523
2	CHECK_ATTRIBUTES	Instance method	Public	Method	Check the Attributes	20020809
3	CHECK_COLLECTOR	Static method	Private	Method	Test if Collector can be used	20070425
4	CLASS_SYNTAX_CHECK	Static method	Private	Method	Syntax Check for Collector Classes	20020528
5	COLLECT	Instance method	Public	Method	Start Collector	20020809
6	GET_COLLECTORS	Static method	Public	Method	Gets List of Collectors	20020523
7	GET_GROUPS	Instance method	Public	Method	Returns groups to which the active collections belong	20020813
8	GET_INITIAL_LIST	Static method	Public	Method	Get Initial Collector List	20020812
9	GET_LIST	Static method	Public	Method	Gets Collector List from Variant	20020809
10	GET_SUB_CLASSES	Static method	Private	Method	Gets Subclasses for CL_CI_COLLECTOR_ROOT	20021002
11	GET_VARIANT	Instance method	Public	Method	Get Variant	20020809
12	READ_NAMES	Static method	Private	Method	Get Collector Classes	20020527
13	REMOVE_COLLECTOR	Static method	Public	Method	Remove Collector	20020523
14	SET_SELECTED	Instance method	Public	Method	Set Selected Property	20020812

Events

Class CL_CI_OBJS_COLLECTOR has no event.

Types

Class CL_CI_OBJS_COLLECTOR has no local type.

Method Signatures

Method ADD_COLLECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_NAME	Call by reference	☐	Type reference (TYPE)	SYCHAR30		Name des Kollektors	20020527

#	Exception	Resumable	Description	Created on
1	COLLECTOR_ALREADY_EXISTS	☐	Kollektor ist schon eingefügt	20020527
2	INVALID_CLASS_NAME	☐	Falscher oder ungültiger Kollektor-Klassen-Name	20020527
3	NOT_AUTHORIZED	☐	fehlende Berechtigung	20040203
4	TRANSPORT_ERROR	☐	Fehler beim Einfügen in Transport-Auftrag	20020527

Method CHECK_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_RESULT	Value transfer	☐	Type reference (TYPE)	FLAG		allgemeines flag	20020809

Method CHECK_ATTRIBUTES on class CL_CI_OBJS_COLLECTOR has no exception.

Method CHECK_COLLECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_OK	Value transfer	☐	Type reference (TYPE)	SYCHAR01			20070425
2	Importing	P_TEST_NAME	Call by reference	☐	Type reference (TYPE)	C			20070425

Method CHECK_COLLECTOR on class CL_CI_OBJS_COLLECTOR has no exception.

Method CLASS_SYNTAX_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_CLASS	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Objekttypname	20020528
2	Returning	P_RESULT	Value transfer	☐	Type reference (TYPE)	FLAG		allgemeines flag	20020528

Method CLASS_SYNTAX_CHECK on class CL_CI_OBJS_COLLECTOR has no exception.

Method COLLECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_COLL	Call by reference	☐	Type reference (TYPE)	SCISCOLL		Code Inspector: Objekt-Menge von allg. Objekt-Kollektor	20020809
2	Exporting	P_OBJLIST	Call by reference	☐	Type reference (TYPE)	SCIT_OBJS		Code Inspector: Tabellentyp für Objekte	20020809

#	Exception	Resumable	Description	Created on
1	COLLECTOR_ERROR	☐	Fehler bei Ausführung des Kollektors	20030120
2	INVALID_INPUT	☐	Fehler bei Eingabeparameter für Kollektor	20030120
3	MISSING_COLLECTOR	☐	Es wurde kein Kollektor übergeben	20030120

Method GET_COLLECTORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ACTIVE_COLLECTORS	Call by reference	☑	Type reference (TYPE)	FLAG			20020523
2	Exporting	P_COLLECTORS	Call by reference	☐	Type reference (TYPE)	SCI_ACTCOLS		Code Inspector: Liste aller möglichen Tests	20020812

Method GET_COLLECTORS on class CL_CI_OBJS_COLLECTOR has no exception.

Method GET_GROUPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_GROUPS	Value transfer	☐	Type reference (TYPE)	SCI_GROUPS		Code Inspector: Benutzergruppen	20020813

Method GET_GROUPS on class CL_CI_OBJS_COLLECTOR has no exception.

Method GET_INITIAL_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CI_OBJS_COLLECTOR		Verwaltung für allgemeine Objektkollektoren	20020812

Method GET_INITIAL_LIST on class CL_CI_OBJS_COLLECTOR has no exception.

Method GET_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CI_OBJS_COLLECTOR		Verwaltung für allgemeine Objektkollektoren	20020809
2	Importing	P_VARIANT	Call by reference	☐	Type reference (TYPE)	SCI_COLLVAR		Code Inspector: Kollektorvariante	20020809

#	Exception	Resumable	Description	Created on
1	INVALID_VERSION	☐	Die Attribute passen nicht zur Kollektorversion	20020809

Method GET_SUB_CLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ACT_NAMES	Call by reference	☐	Type reference (TYPE)	SCI_COLS		Tabellentyp für Kollektorklassen	20021002
2	Changing	P_COLLECTORS	Call by reference	☐	Type reference (TYPE)	SCI_ACTCOLS		Code Inspector: Liste aller möglichen Kollektoren	20021002
3	Importing	P_SUPER_CLASS	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Objekttypname	20021002

Method GET_SUB_CLASSES on class CL_CI_OBJS_COLLECTOR has no exception.

Method GET_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_VARIANT	Call by reference	☐	Type reference (TYPE)	SCI_COLLVAR		Code Inspector: Testvariante	20020809

Method GET_VARIANT on class CL_CI_OBJS_COLLECTOR has no exception.

Method READ_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_CLASS_NAMES	Call by reference	☐	Type reference (TYPE)	SCI_COLS		Code Inspector: Namen von Kollektorklassen	20020527

Method READ_NAMES on class CL_CI_OBJS_COLLECTOR has no exception.

Method REMOVE_COLLECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_NAME	Call by reference	☐	Type reference (TYPE)	SYCHAR30		Name des Kollektors	20020527

#	Exception	Resumable	Description	Created on
1	COLLECTOR_NOT_EXISTS	☐	Kollektor existiert nicht	20020527
2	INVALID_CLASS_NAME	☐	Ungültiger Klassenname	20020527
3	NOT_AUTHORIZED	☐	fehlende Berechtigung	20040203
4	TRANSPORT_ERROR	☐	Transportfehler	20020527

Method SET_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_ENABLE_MULTIPLE_CHOICE	Call by reference	☑	Type reference (TYPE)	FLAG		CHAR01-Datenelement fuer SYST	20030117
2	Importing	P_REF_COLLECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_CI_COLLECTOR_ROOT		Interface für allgemeine Objektkollektoren	20020812
3	Importing	P_SELECT	Call by reference	☐	Type reference (TYPE)	FLAG		CHAR01-Datenelement fuer SYST	20020812

#	Exception	Resumable	Description	Created on
1	MISSING_COLLECTOR	☐	Es wurde kein Kollektor übergeben	20030120

History

Last changed by/on	SAP	20131127
SAP Release Created in	640