SAP ABAP Class CL_RSARCH_REQUEST (Archiving Request)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-DST (Application Component) Data Staging
     ⤷ RSARCH (Package) BW Archiving

Properties

Class	CL_RSARCH_REQUEST
Short Description	Archiving Request
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class	RSARCH
Program status
Category	0
Package	RSARCH	BW Archiving
Created	20010606	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RSARH	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RSDRD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSARCH_REQUEST has no interface implemented.

Friends

Class CL_RSARCH_REQUEST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_NOTECORR_796026	Constant	Public	☐	Type reference (TYPE)	RSARCHREQ-OBJECT	'NOTE796026'	BW Archiving: Request-ID	20050228
2	C_REQCORR_796026	Constant	Public	☐	Type reference (TYPE)	RSARCHREQ-REQUID	'ARCH_DECIMALSNOCONVTJ19K019017'	BW Archiving: Request-ID	20050228
3	N_REQUID	Instance attribute	Public	☑	Type reference (TYPE)	RSREQUID		Request ID	20010817
4	N_T_RANGE	Instance attribute	Public	☑	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range List	20010606
5	P_LOCKID	Instance attribute	Private	☐	Type reference (TYPE)	RSENQ_LOCKID		Lock ID for the lock manager	20010717
6	P_SID	Instance attribute	Private	☐	Type reference (TYPE)	I		Object List	20010606
7	P_S_REQ	Instance attribute	Private	☐	Type reference (TYPE)	RSARCHREQ		BW Data Manager: Request Selections	20010606
8	P_TS_VERIFIED_FILES	Instance attribute	Private	☐	Type reference (TYPE)	LTY_TS_VERIFIED_FILES			20010606
9	P_T_OBJ	Static Attribute	Private	☐	Type reference (TYPE)	LTY_T_OBJ		Object List	20010606
10	P_T_RANGE_DB	Instance attribute	Private	☐	Type reference (TYPE)	RSDRI_T_RANGE		Abstract Selection	20010606

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_VERIFIED_FILE	Instance method	Public	Method		20010606
2	ASSIGN_DOCUMENT	Instance method	Public	Method		20010606
3	CHECK_REQSTAT_FOR_COMPLETION	Instance method	Public	Method	Determine Status Of Selective Deletion Of Archived Data	20010607
4	CHECK_REQSTAT_FOR_DELETE	Instance method	Public	Method	Determine Status Of Selective Deletion Of Archived Data	20010607
5	CHECK_REQSTAT_FOR_VERIFICATION	Instance method	Public	Method	Determine Status	20010607
6	CHECK_REQSTAT_FOR_WRITE	Instance method	Public	Method	secure status for opening first archive file	20010607
7	CHECK_SESSION_FOR_CURR_CONV	Static method	Public	Method	Check in archiving run if currency translation is necessary	20050228
8	CLEAR_T_RANGE	Instance method	Public	Method	Delete Request Selections	20010606
9	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010606
10	FACTORY	Static method	Public	Method	Factory	20010606
11	GET_ALL	Static method	Public	Method	Factory	20020129
12	GET_COUNT_RECORDS	Instance method	Public	Method		20030804
13	GET_DOCUMENT	Instance method	Public	Method	Archiving Session	20010717
14	GET_FILES	Instance method	Public	Method		20010606
15	GET_REQSTAT	Instance method	Public	Method		20010606
16	GET_THX_SEL	Instance method	Public	Method		20010607
17	GET_T_RANGE	Instance method	Public	Method		20010606
18	READ_FROM_DB	Instance method	Public	Method	Read Request Characteristics In The Database	20010606
19	SET_FILE_CONFIRMED	Instance method	Public	Method		20010718
20	SET_REQSTAT	Instance method	Public	Method	Set Request Status	20010606
21	SET_SID	Instance method	Private	Method		20010606
22	SET_T_RANGE	Instance method	Public	Method		20010606
23	SET_WRITE_STATISTICS	Instance method	Public	Method		20010809
24	WRITE_TO_DB	Instance method	Public	Method		20010606

Events

Class CL_RSARCH_REQUEST has no event.

Types

Class CL_RSARCH_REQUEST has no local type.

Method Signatures

Method ADD_VERIFIED_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ARCHIV_KEY	Call by reference	☐	Type reference (TYPE)	ARKEY		Key for Archive File	20010606
2	Importing	I_COUNT_OBJECTS	Call by reference	☐	Type reference (TYPE)	I		No. of Data Objects	20010627
3	Importing	I_COUNT_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Number of Records	20010627

Method ADD_VERIFIED_FILE on class CL_RSARCH_REQUEST has no exception.

Method ASSIGN_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENT	Call by reference	☐	Type reference (TYPE)	ADMI_RUN_D		Archiving Session Number	20010606

#	Exception	Resumable	Description	Created on
1	REJECTED	☐		20010606

Method CHECK_REQSTAT_FOR_COMPLETION Signature

Method CHECK_REQSTAT_FOR_COMPLETION on class CL_RSARCH_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	ALREADY_COMPLETED	☐	Data already deleted	20010607
2	WRONG_STATE	☐		20010607

Method CHECK_REQSTAT_FOR_DELETE Signature

Method CHECK_REQSTAT_FOR_DELETE on class CL_RSARCH_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	ALREADY_DELETED	☐	Data Already Deleted	20010607
2	VERIFICATION_ERROR	☐		20010809
3	WRONG_STATE	☐		20010607

Method CHECK_REQSTAT_FOR_VERIFICATION Signature

Method CHECK_REQSTAT_FOR_VERIFICATION on class CL_RSARCH_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	ALREADY_VERIFIED	☐	Data Already Verified	20010607
2	WRONG_STATE	☐	Verification Not Permitted Under Current Status	20010607

Method CHECK_REQSTAT_FOR_WRITE Signature

Method CHECK_REQSTAT_FOR_WRITE on class CL_RSARCH_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	WRONG_STATE	☐		20010607

Method CHECK_SESSION_FOR_CURR_CONV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SESSION	Call by reference	☐	Type reference (TYPE)	ADMI_RUN_D		Nummer eines Archivierungslaufs	20050228
2	Returning	R_CONV	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20050228

Method CHECK_SESSION_FOR_CURR_CONV on class CL_RSARCH_REQUEST has no exception.

Method CLEAR_T_RANGE Signature

Method CLEAR_T_RANGE on class CL_RSARCH_REQUEST has no parameter.
Method CLEAR_T_RANGE on class CL_RSARCH_REQUEST has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENT	Call by reference	☑	Type reference (TYPE)	ADMI_RUN_D		Archiving Session Number	20020123
2	Importing	I_OBJECT	Call by reference	☑	Type reference (TYPE)	ARCH_OBJ-OBJECT		Archiving Object	20010606
3	Importing	I_REQUID	Call by reference	☑	Type reference (TYPE)	RSARCHREQUID		BW Archiving: Request-ID	20010606
4	Importing	I_T_RANGE	Call by reference	☑	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range Liste	20010606

#	Exception	Resumable	Description	Created on
1	CREATE_FAILED	☐		20010606
2	NOT_FOUND	☐		20010606

Method FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENT	Call by reference	☑	Type reference (TYPE)	ADMI_RUN_D		Archiving Session Number	20020123
2	Importing	I_OBJECT	Call by reference	☑	Type reference (TYPE)	ARCH_OBJ-OBJECT		Archiving Object	20010606
3	Importing	I_REQUID	Call by reference	☑	Type reference (TYPE)	RSARCHREQUID		BW Archiving: Request-ID	20010606
4	Importing	I_T_RANGE	Call by reference	☑	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range Liste	20010606
5	Returning	R_R_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSARCH_REQUEST		Archiving Request	20010606

#	Exception	Resumable	Description	Created on
1	INVALID_INPUT	☐	Invalid Entry	20010606
2	INVALID_OBJECT	☐	Invalid object	20010606
3	NOT_FOUND	☐	Not Found	20010606

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJECT	Call by reference	☑	Type reference (TYPE)	ARCH_OBJ-OBJECT		Archiving Object	20020129
2	Returning	R_TR_REQUEST	Value transfer	☐	Type reference (TYPE)	RSARCH_TR_REQUEST		Archiving Requests	20020129

#	Exception	Resumable	Description	Created on
1	INVALID_INPUT	☐	Invalid Entry	20020129
2	INVALID_OBJECT	☐	Invalid object	20020129
3	NOT_FOUND	☐	Not Found	20020129

Method GET_COUNT_RECORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_COUNT_RECORDS	Value transfer	☐	Type reference (TYPE)	I			20030804

Method GET_COUNT_RECORDS on class CL_RSARCH_REQUEST has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_DOCUMENT	Value transfer	☐	Type reference (TYPE)	ADMI_RUN_D		Archiving Session Number	20010717

Method GET_DOCUMENT on class CL_RSARCH_REQUEST has no exception.

Method GET_FILES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_ARCHIV_KEYS	Value transfer	☐	Type reference (TYPE)	RSARCH_T_ARKEY			20010627

Method GET_FILES on class CL_RSARCH_REQUEST has no exception.

Method GET_REQSTAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REQSTAT	Value transfer	☐	Type reference (TYPE)	RSARCHREQSTAT		BW Archiving: Archiving Request Status	20010606

Method GET_REQSTAT on class CL_RSARCH_REQUEST has no exception.

Method GET_THX_SEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_THX_SEL	Value transfer	☐	Type reference (TYPE)	RSDRD_THX_SEL			20010607

Method GET_THX_SEL on class CL_RSARCH_REQUEST has no exception.

Method GET_T_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_RANGE	Value transfer	☐	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range Liste	20010606

Method GET_T_RANGE on class CL_RSARCH_REQUEST has no exception.

Method READ_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_WITH_DB_LOCK	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20010606

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20010606

Method SET_FILE_CONFIRMED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ARCHIV_KEY	Call by reference	☐	Type reference (TYPE)	ARKEY		Key for Archive File	20010718
2	Importing	I_DELETE_FROM_DB	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20010718
3	Returning	R_COUNT_RECORDS	Value transfer	☐	Type reference (TYPE)	I		Number of records	20030804

Method SET_FILE_CONFIRMED on class CL_RSARCH_REQUEST has no exception.

Method SET_REQSTAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REQSTAT	Call by reference	☐	Type reference (TYPE)	RSARCHREQSTAT		BW Archiving: Archiving Request Status	20010606

#	Exception	Resumable	Description	Created on
1	REJECTED	☐		20010606

Method SET_SID Signature

Method SET_SID on class CL_RSARCH_REQUEST has no parameter.
Method SET_SID on class CL_RSARCH_REQUEST has no exception.

Method SET_T_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_T_RANGE	Call by reference	☑	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range Liste	20010606

Method SET_T_RANGE on class CL_RSARCH_REQUEST has no exception.

Method SET_WRITE_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COUNT_DATA_OBJECTS	Call by reference	☐	Type reference (TYPE)	I			20010809
2	Importing	I_COUNT_FILES	Call by reference	☐	Type reference (TYPE)	I			20010809
3	Importing	I_COUNT_RECORDS	Call by reference	☐	Type reference (TYPE)	I			20010809

Method SET_WRITE_STATISTICS on class CL_RSARCH_REQUEST has no exception.

Method WRITE_TO_DB Signature

Method WRITE_TO_DB on class CL_RSARCH_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	WRITE_ERROR	☐		20010606

History

Last changed by/on	SAP	20130531
SAP Release Created in	30A