SAP ABAP Class CL_ARSCENARIO (Archiving Scenario (Obsolete))

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-FS-ARE (Application Component) Archiving Engine
     ⤷ ARFA_ARCHIVING_FACTORY_API (Package) Programming Interface for Factory

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ARSCENARIO	Archiving Scenario	20051006

Properties

Class	CL_ARSCENARIO
Short Description	Archiving Scenario (Obsolete)
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	ARFA_ARCHIVING_FACTORY_API	Programming Interface for Factory
Created	20051006	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)
2	ARFA	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ARSCENARIO	☐	☐	Archiving Scenario	20051006

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ARFACTORY	☐	20051006	Factory Class for Archiving Scenario

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ARCHOBJ	Instance attribute	Private	☐	Type reference (TYPE)	CHAR10		Character Field Length = 10	20051006
2	FLG_NEW	Instance attribute	Private	☐	Type reference (TYPE)	OS_BOOLEAN		'X': New Scenario	20051125
3	REF_ADK_ACCESS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AR_ADK_ACCESS		Access to ADK Data	20051010
4	REF_DBMNGR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AREN_CHANGEBUFFER		Change Buffer	20051008
5	REF_LOCKMNGR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AREN_SCENARIO_LOCK_MANAGER		Lock Management for Archiving Scenarios	20051008
6	TAH_PROPS_SET	Instance attribute	Private	☐	Type reference (TYPE)	TYP_TAH_PROPS		Properties that have already been set	20051125

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DB_ENTRIES	Instance method	Private	Method	Consistency Check	20051006
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20051006
3	CONV_DBDATA_TO_PROP	Instance method	Private	Method	Convert DB Format to Property Format	20051006
4	CONV_PROP_TO_DBDATA	Instance method	Private	Method	Convert Property Format to DB Format	20051006
5	DERIVE_ADK_FROM_AREN	Instance method	Private	Method	Derive ADK Data from Engine Data	20051010
6	ENSURE_WRITE_LOCK	Instance method	Private	Method	Secure Exclusive Lock	20051011
7	FILL_PROPERTIES	Instance method	Private	Method	Populate Properties	20051125
8	GET_ADK_DATA_FROM_PARAMS	Instance method	Private	Method	Get ADK Data from Overall Structure	20051010
9	GET_AREN_DATA_FROM_PARAMS	Instance method	Private	Method	Get Archiving Engine Data from Overall Structure	20051010
10	GET_CURRENT_PARAMS	Instance method	Private	Method	Get Current Parameter Buffer	20051010
11	GET_DEFAULT_PARAMS	Instance method	Private	Method	Get Standard Values	20051125
12	GET_RELATED_SHARED_DATA	Instance method	Private	Method	Get entry for archiving object that is also used elsewhere	20051130
13	INIT_AREN_ARCHOBJ_DATA	Instance method	Private	Method	Initialize object-specific part of archiving engine param.	20051130
14	INIT_AREN_DATA	Instance method	Private	Method	Initialize Archiving Engine Parameters	20051125
15	PREPARE_DELETE	Instance method	Private	Method	Prepare to Delete a Scenario	20051130
16	SET_ADK_DATA_IN_PARAMS	Instance method	Private	Method	Set ADK Data in Overall Structure	20051010
17	SET_AREN_DATA_IN_PARAMS	Instance method	Private	Method	Set Archiving Engine Data in Complete Structure	20051010
18	S_IS_EXISTING_IN_DB	Static method	Public	Method	Checks Whether Scenario Exists in Database	20051006
19	UNDO_SAVE	Instance method	Private	Method	Undo Database Changes	20051006

Events

Class CL_ARSCENARIO has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_TAH_PROPS	Private	See coding			20051125	typ_tah_props TYPE HASHED TABLE OF char30 WITH UNIQUE KEY table_line

Method Signatures

Method CHECK_DB_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_CONSISTENT	Call by reference	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20051006
2	Exporting	E_TAB_MESSAGES	Call by reference	☐	Type reference (TYPE)	TYP_T_MESSAGE		Meldungen	20051006
3	Importing	I_ARCHOBJ	Call by reference	☐	Type reference (TYPE)	CHAR10		Characterfeld der Länge 10	20051006

Method CHECK_DB_ENTRIES on class CL_ARSCENARIO has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ARCHOBJ	Call by reference	☐	Type reference (TYPE)	CHAR10		Characterfeld der Länge 10	20051006
2	Importing	I_FLG_NEW_OBJ	Call by reference	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20051006

Method CONSTRUCTOR on class CL_ARSCENARIO has no exception.

Method CONV_DBDATA_TO_PROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ASPECT	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20051006
2	Importing	I_STR_SCENARIO_DBDATA	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051006
3	Returning	R_TAB_SCENARIO_PROP	Value transfer	☐	Type reference (TYPE)	AREN_TAB_PROPERTIES		Eigenschaften im Format Schlüssel <-> Wert	20051006

Method CONV_DBDATA_TO_PROP on class CL_ARSCENARIO has no exception.

Method CONV_PROP_TO_DBDATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_SCENARIO_PROP	Call by reference	☐	Type reference (TYPE)	AREN_TAB_PROPERTIES		Eigenschaften im Format Schlüssel <-> Wert	20051006
2	Returning	R_STR_SCENARIO_DBDATA	Value transfer	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051006

Method CONV_PROP_TO_DBDATA on class CL_ARSCENARIO has no exception.

Method DERIVE_ADK_FROM_AREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_STR_ADK	Call by reference	☐	Type reference (TYPE)	AREN_STR_ADK_DATA		ADK-Konfiguration zu Archivierungsobjekt	20051010
2	Importing	I_STR_AREN	Call by reference	☐	Type reference (TYPE)	L_TYP_STR_OBJECT			20051010

Method DERIVE_ADK_FROM_AREN on class CL_ARSCENARIO has no exception.

Method ENSURE_WRITE_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RC	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20051011

Method ENSURE_WRITE_LOCK on class CL_ARSCENARIO has no exception.

Method FILL_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TAB_PROPS	Call by reference	☐	Type reference (TYPE)	AREN_TAB_PROPERTIES		Eigenschaften im Format Schlüssel <-> Wert	20051125
2	Importing	I_STR_PARAMS	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051125

Method FILL_PROPERTIES on class CL_ARSCENARIO has no exception.

Method GET_ADK_DATA_FROM_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STR_PARAM	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051010
2	Returning	R_STR_ADK	Value transfer	☐	Type reference (TYPE)	AREN_STR_ADK_DATA		ADK-Konfiguration zu Archivierungsobjekt	20051010

Method GET_ADK_DATA_FROM_PARAMS on class CL_ARSCENARIO has no exception.

Method GET_AREN_DATA_FROM_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STR_PARAM	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051010
2	Returning	R_STR_AREN	Value transfer	☐	Type reference (TYPE)	L_TYP_STR_OBJECT			20051010

Method GET_AREN_DATA_FROM_PARAMS on class CL_ARSCENARIO has no exception.

Method GET_CURRENT_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STR_PARAM	Value transfer	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051010

Method GET_CURRENT_PARAMS on class CL_ARSCENARIO has no exception.

Method GET_DEFAULT_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ASPECT	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20051125
2	Returning	R_STR_DEFAULTS	Value transfer	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051125

Method GET_DEFAULT_PARAMS on class CL_ARSCENARIO has no exception.

Method GET_RELATED_SHARED_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STR_AREN	Call by reference	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Konfigurationsdaten der Archiving Engine zu Archiv.Objekt	20051130
2	Returning	R_STR_SHARED	Value transfer	☐	Type reference (TYPE)	TYP_STR_SHARED_DATA			20051130

Method GET_RELATED_SHARED_DATA on class CL_ARSCENARIO has no exception.

Method INIT_AREN_ARCHOBJ_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STR_DEFAULTS	Value transfer	☐	Type reference (TYPE)	TYP_STR_ARCHOBJ_DATA			20051130

Method INIT_AREN_ARCHOBJ_DATA on class CL_ARSCENARIO has no exception.

Method INIT_AREN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STR_DEFAULTS	Value transfer	☐	Type reference (TYPE)	L_TYP_STR_OBJECT			20051125

Method INIT_AREN_DATA on class CL_ARSCENARIO has no exception.

Method PREPARE_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STR_DATA_AFTER_DEL	Value transfer	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Konfigurationsdaten der Archiving Engine zu Archiv.Objekt	20051130

Method PREPARE_DELETE on class CL_ARSCENARIO has no exception.

Method SET_ADK_DATA_IN_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_STR_PARAM	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051010
2	Importing	I_STR_ADK	Call by reference	☐	Type reference (TYPE)	AREN_STR_ADK_DATA		ADK-Konfiguration zu Archivierungsobjekt	20051010

Method SET_ADK_DATA_IN_PARAMS on class CL_ARSCENARIO has no exception.

Method SET_AREN_DATA_IN_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_STR_PARAM	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20051010
2	Importing	I_STR_AREN	Call by reference	☐	Type reference (TYPE)	L_TYP_STR_OBJECT			20051010

Method SET_AREN_DATA_IN_PARAMS on class CL_ARSCENARIO has no exception.

Method S_IS_EXISTING_IN_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ARCHOBJ	Call by reference	☐	Type reference (TYPE)	CHAR10		Characterfeld der Länge 10	20051006
2	Returning	R_FLG_EXISTS	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20051006

Method S_IS_EXISTING_IN_DB on class CL_ARSCENARIO has no exception.

Method UNDO_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ARCHOBJ	Call by reference	☐	Type reference (TYPE)	CHAR10		Characterfeld der Länge 10	20051006

#	Exception	Resumable	Description	Created on
1	CX_ARSCENARIO_NOT_FOUND	☐		20051006

History

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