SAP ABAP Class CL_ARFA_API_SCENARIO (Archiving Scenario)

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	20060912

Properties

Class	CL_ARFA_API_SCENARIO
Short Description	Archiving Scenario
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	20060912	SAP
Last change	20130531	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

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

Friends

Class CL_ARFA_API_SCENARIO has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	REF_ADK_ACCESS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AR_ADK_ACCESS		Access to ADK Data	20060912
2	REF_LOCKMNGR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AREN_SCENARIO_LOCK_MANAGER		Lock Management for Archiving Scenarios	20060912
3	REF_SCENARIO	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ARFA_SCENARIO		Archiving Scenario	20060912
4	SCENARIO	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060912
5	SCENARIO_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	TYP_AR_SCENARIOTYPE		Set this to 1 Only during Creation 'Delete Only' Scenario	20120802
6	STR_AREN	Instance attribute	Private	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Configuration Data of Archiving Engine for Archiving Object	20060912

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DB_ENTRIES	Instance method	Private	Method	Consistency Check	20060912
2	DERIVE_ADK_FROM_AREN	Instance method	Private	Method	Derive ADK Data from Engine Data	20060912
3	ENSURE_WRITE_LOCK	Instance method	Private	Method	Secure Exclusive Lock	20060912
4	GET_CONFIG	Instance method	Private	Method	Get Current Configuration (Scenario + ADK Part)	20060912
5	GET_DEFAULT_SCENARIO_CONFIG	Instance method	Private	Method	Get Default Settings for Scenario	20060912
6	GET_SCENARIO_CONFIG	Instance method	Private	Method	Get Configuration of Scenario	20060912
7	IS_NEW	Instance method	Public	Method	Checks if Scenario Is New	20060912
8	PROPS_TO_CONFIG	Instance method	Private	Method	Convert Property Format to DB Format	20060912
9	SET_SCENARIO_CONFIG	Instance method	Private	Method	Set Scenario Configuration	20060912
10	S_CREATE	Static method	Public	Method		20060912
11	_INIT_SCENARIO_CONFIG	Instance method	Private	Method	Scenario Configuration or Initialization	20070227

Events

Class CL_ARFA_API_SCENARIO has no event.

Types

Class CL_ARFA_API_SCENARIO has no local type.

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)	CHAR1			20060912
2	Exporting	E_TAB_MESSAGES	Call by reference	☐	Type reference (TYPE)	TYP_T_MESSAGE		Meldungen	20060912

Method CHECK_DB_ENTRIES on class CL_ARFA_API_SCENARIO 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	20060912
2	Importing	I_STR_AREN	Call by reference	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Konfigurationsdaten der Archiving Engine zu Archiv.Objekt	20060912

Method DERIVE_ADK_FROM_AREN on class CL_ARFA_API_SCENARIO has no exception.

Method ENSURE_WRITE_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_RC	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20060912
2	Exporting	E_TAB_MESSAGES	Call by reference	☐	Type reference (TYPE)	TYP_T_MESSAGE		Meldungen	20060912

Method ENSURE_WRITE_LOCK on class CL_ARFA_API_SCENARIO has no exception.

Method GET_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_STR_CONFIG	Call by reference	☐	Type reference (TYPE)	AREN_STR_PARAMS		Parameter des Archivierungsszenarios im internen DB-Format	20060912

Method GET_CONFIG on class CL_ARFA_API_SCENARIO has no exception.

Method GET_DEFAULT_SCENARIO_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_STR_AREN_DATA	Call by reference	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Konfigurationsdaten der Archiving Engine zu Archiv.Objekt	20060912

Method GET_DEFAULT_SCENARIO_CONFIG on class CL_ARFA_API_SCENARIO has no exception.

Method GET_SCENARIO_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_STR_AREN_DATA	Call by reference	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Konfigurationsdaten der Archiving Engine zu Archiv.Objekt	20060912

Method GET_SCENARIO_CONFIG on class CL_ARFA_API_SCENARIO has no exception.

Method IS_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FLG_TRUE	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20060912

Method IS_NEW on class CL_ARFA_API_SCENARIO has no exception.

Method PROPS_TO_CONFIG Signature

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

Method PROPS_TO_CONFIG on class CL_ARFA_API_SCENARIO has no exception.

Method SET_SCENARIO_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STR_AREN_DATA	Call by reference	☐	Type reference (TYPE)	AREN_STR_ARCHENGINE_DATA		Konfigurationsdaten der Archiving Engine zu Archiv.Objekt	20060912

Method SET_SCENARIO_CONFIG on class CL_ARFA_API_SCENARIO has no exception.

Method S_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCENARIO	Call by reference	☐	Type reference (TYPE)	CHAR10		Archivierungsszenario	20060912
2	Importing	I_SCENARIO_TYPE	Call by reference	☐	Type reference (TYPE)	TYP_AR_SCENARIOTYPE		Use only when creating delete scenario	20120802
3	Returning	R_REF_SCENARIO	Value transfer	☐	Object reference (TYPE REF TO)	CL_ARFA_API_SCENARIO		Archivierungsszenario	20060912

Method S_CREATE on class CL_ARFA_API_SCENARIO has no exception.

Method _INIT_SCENARIO_CONFIG Signature

Method _INIT_SCENARIO_CONFIG on class CL_ARFA_API_SCENARIO has no parameter.
Method _INIT_SCENARIO_CONFIG on class CL_ARFA_API_SCENARIO has no exception.

History

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