SAP ABAP Class CL_IWP_PATH (Path of an Audit Package)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ BC-ILM-RW (Application Component) Retention Warehouse
     ⤷ IWP_BASIC (Package) ILM Workpackage: Basic Functions

Properties

Class	CL_IWP_PATH
Short Description	Path of an Audit Package
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	IWP_BASIC	ILM Workpackage: Basic Functions
Created	20071105	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ARC_DAS_CON_AUDIT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_IWP_PATH has no interface implemented.

Friends

Class CL_IWP_PATH has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_LOAD_STAT	Constant	Public	☐	See coding			Domain values of iwp_load_stat	20080109
2	MR_ILMSESSION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ARC_DAS_CON_AUDIT		Reference to CL_ARC_DAS_CON_AUDIT	20071127
3	MR_WP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_IWP_WORK_PACKAGE		Reference to an audit package	20071106
4	MS_DATAREQ	Instance attribute	Private	☐	Type reference (TYPE)	TY_DATAREQ_INFO			20071128
5	MS_PATH	Instance attribute	Private	☐	Type reference (TYPE)	TY_BUF_PATH		Path of an audit package	20071106
6	MT_ARURI	Instance attribute	Private	☐	Type reference (TYPE)	TT_BUF_URI		Archive uris of the path	20071106
7	MT_PATH_STRC	Instance attribute	Private	☐	Type reference (TYPE)	TT_BUF_PTH_STRC		Structures of the path	20071106

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_NTAB_INFO	Instance method	Private	Method	Build nametab info	20071128
2	CHECK_ARURI_LOAD_STATUS	Instance method	Public	Method	Check ARURI Load status for given URI : Use in data prov lyr	20120725
3	CHECK_STR_LOAD_STATUS	Instance method	Public	Method	Check load status for input str : Use in data prov lyr	20120724
4	CLOSE	Instance method	Public	Method	Closes the Access to Archive after OPEN4READ	20071105
5	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20071105
6	DELETE	Instance method	Public	Method	Delete a path	20071106
7	GET_ARURI	Instance method	Public	Method	Get all Archive uris of a path	20071106
8	GET_DATA	Instance method	Public	Method	Get Data for a certain structure	20071106
9	GET_DATA_OF_OBJECT	Instance method	Private	Method	Get data of an archive object	20071128
10	GET_DETAIL	Instance method	Public	Method	Returns details of a path	20071106
11	GET_NEXT_DATA	Instance method	Public	Method	Returns Data after a Path was opened with OPEN4READ	20071106
12	GET_NEXT_OBJECT	Instance method	Private	Method	Get next archive object	20071106
13	GET_STRUCTURES	Instance method	Public	Method	Returns structures of a path	20071106
14	OPEN4READ	Instance method	Public	Method	Open the connection to retrieve data	20071106
15	SAVE	Instance method	Public	Method	Return all changes for db update	20071106
16	SET_LOAD_STATUS_ARURI	Instance method	Public	Method	Set status of Data load for a certain archive uri	20080107
17	SET_LOAD_STATUS_STRUC	Instance method	Public	Method	Set status of Data load for a certain structure	20080107
18	SET_MARKFLAG	Instance method	Public	Method	Mark or unmark structures	20071106

Events

Class CL_IWP_PATH has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_BUF_PTH_STRC	Private	See coding		table type for buffering structures of a path	20071105	tt_buf_pth_strc TYPE TABLE OF ty_buf_pth_strc
2	TT_BUF_URI	Private	See coding		table type for buffering URIs	20071105	tt_buf_uri TYPE TABLE OF ty_buf_uri
3	TY_BUF_PATH	Private	See coding		type for buffering path	20071105	BEGIN OF ty_buf_path, db TYPE iwp_wp_path, changed_typ TYPE iwp_changed_typ. TYPES: END OF ty_buf_path
4	TY_BUF_PTH_STRC	Private	See coding		type for buffering a structure of a path	20071105	BEGIN OF ty_buf_pth_strc, db TYPE iwp_wp_pth_strc, changed_typ TYPE iwp_changed_typ. TYPES: END OF ty_buf_pth_strc
5	TY_BUF_URI	Private	See coding		type for buffering URI	20071105	BEGIN OF ty_buf_uri, db TYPE iwp_wp_uri, changed_typ TYPE iwp_changed_typ. TYPES: END OF ty_buf_uri
6	TY_DATAREQ_INFO	Private	See coding			20071128	BEGIN OF ty_datareq_info, aruri TYPE string, obj_cnt TYPE i, structures TYPE iwp_t_struc, ntab_info TYPE CL_ARC_DAS_CON_AUDIT=>TT_NAMETAB_INFO, object_data TYPE CL_ARC_DAS_CON_AUDIT=>TT_OBJECT_DATA, eof type boolean, END OF ty_datareq_info
7	TY_SO_LOAD_STAT	Public	See coding		type range of iwp_load_stat	20080107	TY_SO_LOAD_STAT type range of iwp_load_stat

Method Signatures

Method BUILD_NTAB_INFO Signature

Method BUILD_NTAB_INFO on class CL_IWP_PATH has no parameter.
Method BUILD_NTAB_INFO on class CL_IWP_PATH has no exception.

Method CHECK_ARURI_LOAD_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SO_LOAD_STAT	Call by reference	☐	Type reference (TYPE)	TY_SO_LOAD_STAT		Only check for not loaded status	20120725
2	Importing	IV_ARURI	Call by reference	☐	Type reference (TYPE)	STRING			20120725
3	Returning	RV_LOAD_TO_BI	Value transfer	☐	Type reference (TYPE)	CHAR1		'X' : Already Loaded, space : not yet loaded	20120725

Method CHECK_ARURI_LOAD_STATUS on class CL_IWP_PATH has no exception.

Method CHECK_STR_LOAD_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SO_LOAD_STAT	Call by reference	☐	Type reference (TYPE)	TY_SO_LOAD_STAT		Only check for not loaded status	20120724
2	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	IWP_STRUC		Table Name	20120724
3	Returning	RV_LOAD_TO_BI	Value transfer	☐	Type reference (TYPE)	CHAR1		'X',Load to BI otherwise already loaded	20120724

Method CHECK_STR_LOAD_STATUS on class CL_IWP_PATH has no exception.

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUBRC	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Return value	20071105

Method CLOSE on class CL_IWP_PATH has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_WORK_PACKAGE	Call by reference	☐	Object reference (TYPE REF TO)	CL_IWP_WORK_PACKAGE		Work Package	20071106
2	Importing	IS_PATH_HEADER	Call by reference	☐	Type reference (TYPE)	IWP_WP_PATH		Pathes of a Work Package	20071106
3	Importing	IT_ARURI	Call by reference	☐	Type reference (TYPE)	IWP_T_WP_URI		Table of uris of a path	20071106
4	Importing	IT_PTH_STRC	Call by reference	☐	Type reference (TYPE)	IWP_T_WP_PTH_STRC		Table of structures of pathes	20071106
5	Importing	IV_CHANGED_TYP	Call by reference	☐	Type reference (TYPE)	IWP_CHANGED_TYP	SPACE	Checkbox	20071106

Method CONSTRUCTOR on class CL_IWP_PATH has no exception.

Method DELETE Signature

Method DELETE on class CL_IWP_PATH has no parameter.
Method DELETE on class CL_IWP_PATH has no exception.

Method GET_ARURI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ARURI	Call by reference	☐	Type reference (TYPE)	IWP_T_ARURI		Table of archive uris of cl_iwp_path	20071106

Method GET_ARURI on class CL_IWP_PATH has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_REF2DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Return reference to table entries	20071106
2	Exporting	ET_STRUC_METDAT	Call by reference	☐	Type reference (TYPE)	IWP_T_STRCMETDAT		Table of metadata of a structure	20071106
3	Importing	IT_SO_LOAD_STAT	Call by reference	☑	Type reference (TYPE)	TY_SO_LOAD_STAT		Status of the Data Load	20080107
4	Importing	IT_STRUC_METDAT	Call by reference	☑	Type reference (TYPE)	IWP_T_STRCMETDAT		Table of metadata of a structure	20071106
5	Importing	IV_MAX_ENTRIES	Call by reference	☐	Type reference (TYPE)	INT4	100	Maximum entries to be retrieved; 0 = all	20071106
6	Importing	IV_ONLY_MARKED	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20080107
7	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	IWP_STRUC		Structure	20071106

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	error occured	20071220

Method GET_DATA_OF_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	CL_ARC_DAS_CON_AUDIT=>TT_OBJECT_DATA			20071128
2	Exporting	EV_EOF	Call by reference	☐	Type reference (TYPE)	BOOLEAN		End of file reached	20071128

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	error ocured	20071220

Method GET_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_PATH_HEADER	Call by reference	☐	Type reference (TYPE)	IWP_S_PATH		Details of a cl_iwp_path instance	20071106
2	Exporting	EV_AGGR_LOAD_STATUS	Call by reference	☐	Type reference (TYPE)	IWP_AGGR_LOAD_STAT		Aggregated Status of the Data Load	20080109

Method GET_DETAIL on class CL_IWP_PATH has no exception.

Method GET_NEXT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_REF2DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Return reference to table entries	20071106
2	Exporting	EV_EOO	Call by reference	☐	Type reference (TYPE)	BOOLEAN		end of objects	20071106
3	Exporting	EV_NEWOBJ	Call by reference	☐	Type reference (TYPE)	BOOLEAN		flag for new object	20071106
4	Exporting	EV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	IWP_STRUC		Structure	20071106

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20110412

Method GET_NEXT_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EOF	Value transfer	☐	Type reference (TYPE)	BOOLEAN		End of file reached	20071106

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	error occured	20071220

Method GET_STRUCTURES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PTH_STRC	Call by reference	☐	Type reference (TYPE)	IWP_T_PTH_STRC		Table of pathes with all structures	20071108
2	Importing	IT_PTH_STRC	Call by reference	☑	Type reference (TYPE)	IWP_T_PTH_STRC		Table of pathes with all structures	20071108
3	Importing	IV_ONLY_MARKED	Call by reference	☐	Type reference (TYPE)	XFELD	SPACE		20071106

Method GET_STRUCTURES on class CL_IWP_PATH has no exception.

Method OPEN4READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUBRC	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		0=ok;4=no data access required; 8=data access failed	20071106
2	Importing	IT_SO_LOAD_STAT	Call by reference	☑	Type reference (TYPE)	TY_SO_LOAD_STAT		type range of iwp_load_stat	20080107
3	Importing	IT_STRUCTURES	Call by reference	☑	Type reference (TYPE)	IWP_T_STRUC		Tables of structures	20071106
4	Importing	IV_ARURI	Call by reference	☐	Type reference (TYPE)	STRING			20071106
5	Importing	IV_ONLY_MARKED	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20080107

Method OPEN4READ on class CL_IWP_PATH has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_PATH_HEADER	Call by reference	☐	Type reference (TYPE)	IWP_WP_PATH		Pathes of a Work Package	20071106
2	Exporting	ES_PATH_HEADER_DEL	Call by reference	☐	Type reference (TYPE)	IWP_WP_PATH		Pathes of a Work Package	20071106
3	Exporting	ET_ARURI	Call by reference	☐	Type reference (TYPE)	IWP_T_WP_URI		Table of uris of a path	20071106
4	Exporting	ET_ARURI_DEL	Call by reference	☐	Type reference (TYPE)	IWP_T_WP_URI		Table of uris of a path	20071106
5	Exporting	ET_PTH_STRC	Call by reference	☐	Type reference (TYPE)	IWP_T_WP_PTH_STRC		Table of structures of pathes	20071106
6	Exporting	ET_PTH_STRC_DEL	Call by reference	☐	Type reference (TYPE)	IWP_T_WP_PTH_STRC		Table of structures of pathes	20071106

Method SAVE on class CL_IWP_PATH has no exception.

Method SET_LOAD_STATUS_ARURI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ARURI	Call by reference	☐	Type reference (TYPE)	IWP_S_ARURI		Archive uris of a path	20080107
2	Importing	IV_LOAD_STAT	Call by reference	☐	Type reference (TYPE)	IWP_LOAD_STAT		Status of the Data Load	20080107

#	Exception	Resumable	Description	Created on
1	ARURI_NOT_FOUND	☐	Pathid and/or structure not found	20080107

Method SET_LOAD_STATUS_STRUC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOAD_STAT	Call by reference	☐	Type reference (TYPE)	IWP_LOAD_STAT		Status of the Data Load	20080107
2	Importing	IV_PATHID	Call by reference	☐	Type reference (TYPE)	IWP_PATH_ID		Path Identifier	20080107
3	Importing	IV_STRUC	Call by reference	☐	Type reference (TYPE)	IWP_STRUC		Structure	20080107

#	Exception	Resumable	Description	Created on
1	PTH_STRUC_NOT_FOUND	☐	Pathid and/or structure not found	20080107

Method SET_MARKFLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PTH_STRC	Call by reference	☐	Type reference (TYPE)	IWP_T_PTH_STRC		Table of pathes with all structures	20071213

Method SET_MARKFLAG on class CL_IWP_PATH has no exception.

History

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