SAP ABAP Class CL_APL_ECATT_FAVORITES (eCATT - User Favorites)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TWB-TST-ECA (Application Component) eCATT Extended Computer Aided Test Tool
     ⤷ SECATT_FAVORITES_APL (Package) eCATT - Favorites - Application Layer

Properties

Class	CL_APL_ECATT_FAVORITES
Short Description	eCATT - User Favorites
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SECATT_FAVORITES_APL	eCATT - Favorites - Application Layer
Created	20120710	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

Class CL_APL_ECATT_FAVORITES has no interface implemented.

Friends

Class CL_APL_ECATT_FAVORITES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AP_PERS_FAVORITES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_PERS_OBJECT_DATA		Personalization object data object	20120710
2	AP_PERS_LOG_HISTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_PERS_OBJECT_DATA		Personalization object data object	20120712
3	AP_PERS_OBJ_HISTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_PERS_OBJECT_DATA		Personalization object data object	20120712
4	A_UNAME	Instance attribute	Public	☑	Type reference (TYPE)	SYUNAME		User Name	20120712

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_FAVORITE	Instance method	Public	Method	Add Object to Favorites	20120726
2	ADD_FAVORITE_FOLDER	Instance method	Public	Method	Add Folder to Favorites	20121127
3	ADD_LOG_HISTORY	Instance method	Public	Method	Add Log to History (or Modify)	20120726
4	ADD_OBJ_HISTORY	Instance method	Private	Method	Add Object to Object History	20120726
5	CHECK_OBJECT_EXISTENCE	Instance method	Private	Method	Checks the existence of an eCATT Object	20120724
6	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120710
7	DEL_FAVORITE	Instance method	Public	Method	Deletes an Object from Favorites	20120726
8	DEL_FAVORITE_FOLDER	Instance method	Public	Method	Deletes Folder from Favorites	20121209
9	DEL_LOG_HISTORY	Instance method	Public	Method	Deletes an Object from Log History	20120726
10	DEL_OBJ_HISTORY	Instance method	Private	Method	Deletes an Object from Object History	20120726
11	GET_ACCESS_TYPE_ICON	Instance method	Private	Method	Get the Access Type Icon	20120724
12	GET_FAVORITES	Instance method	Public	Method	Returns an itab with the Favorites	20120712
13	GET_LOG_HISTORY	Instance method	Public	Method	Returns an itab with the Log History	20120724
14	GET_OBJECT_VERSION	Instance method	Private	Method	Get the Object Version	20120724
15	GET_OBJ_HISTORY	Instance method	Public	Method	Returns an itab with the Object History	20120712
16	GET_TYPE_ICON	Instance method	Private	Method	Get the icon of the Object type	20120710
17	IS_IN_FAVORITES	Instance method	Public	Method	Check if Object is in Favorites	20120710
18	MANAGE_OBJ_HISTORY	Instance method	Public	Method	Manage Object to History	20120724
19	MOVE_FAV_TO_FOLDER	Instance method	Public	Method	Move Object/Folder to Folder	20121128
20	READ_OBJ_DATA	Instance method	Private	Method	Read Object Data	20120710
21	RENAME_OBJECT	Instance method	Private	Method	Rename Object	20120807

Events

Class CL_APL_ECATT_FAVORITES has no event.

Types

Class CL_APL_ECATT_FAVORITES has no local type.

Method Signatures

Method ADD_FAVORITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IS_IN_FOLDER	Call by reference	☑	Type reference (TYPE)	ETOBJ_NAME		root Folder Name	20121127
2	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120726
3	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120726
4	Importing	I_OBJ_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120726
5	Importing	I_TOOLNAME	Call by reference	☑	Type reference (TYPE)	ETTOOLNAME		Name of Test Tool	20120731

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120726

Method ADD_FAVORITE_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_IN_FOLDER	Call by reference	☑	Type reference (TYPE)	ETOBJ_NAME		root Folder Name	20121127
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		Folder Name	20121127

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20121127

Method ADD_LOG_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOGID	Call by reference	☐	Type reference (TYPE)	ETLOG_ID		Current operation number	20120726
2	Importing	I_TDC_LNR	Call by reference	☑	Type reference (TYPE)	ETOBJ_LNR		Current Number of Object	20120731

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120726

Method ADD_OBJ_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_MODE	Call by reference	☐	Type reference (TYPE)	CHAR4	'SHOW'	Object Mode	20120726
2	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120726
3	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120726
4	Importing	I_OBJ_VERSION	Call by reference	☐	Type reference (TYPE)	ETOBJ_VER	1	eCATT Object Version	20120726

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120726

Method CHECK_OBJECT_EXISTENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120724
2	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120724
3	Importing	I_OBJ_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120724

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120724

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_UNAME	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20120712

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL_FAVORITES	☐	Exception Class for eCATT Favorites	20120712

Method DEL_FAVORITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120726
2	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120726
3	Importing	I_OBJ_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120726

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120726

Method DEL_FAVORITE_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20121209

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20121209

Method DEL_LOG_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOGID	Call by reference	☐	Type reference (TYPE)	ETLOG_ID		Current operation number	20120726
2	Importing	I_TDC_LNR	Call by reference	☑	Type reference (TYPE)	ETOBJ_LNR		Current Number of Object	20120801

Method DEL_LOG_HISTORY on class CL_APL_ECATT_FAVORITES has no exception.

Method DEL_OBJ_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_ACCESS_TYPE	Call by reference	☑	Type reference (TYPE)	ETFAV_ACCESS_TYPE		Access Type (to delete)	20120727
2	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120726
3	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120726
4	Importing	I_OBJ_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120726

Method DEL_OBJ_HISTORY on class CL_APL_ECATT_FAVORITES has no exception.

Method GET_ACCESS_TYPE_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACCESS_TYPE	Call by reference	☐	Type reference (TYPE)	ETFAV_ACCESS_TYPE		Access Type	20120724
2	Returning	R_ICON	Value transfer	☐	Type reference (TYPE)	ETFAV_ACCESS_TYPE_ICON		Access Type Icon	20120724

Method GET_ACCESS_TYPE_ICON on class CL_APL_ECATT_FAVORITES has no exception.

Method GET_FAVORITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OBJS	Call by reference	☐	Type reference (TYPE)	ETFAV_UI_OBJ_TT		eCATT Table Type of ETFAV_UI_OBJ	20120712
2	Importing	IT_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETFAV_OBJ_TYPE_TT		List of object types	20120712
3	Importing	IV_WITH_FOLDERS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20121127

Method GET_FAVORITES on class CL_APL_ECATT_FAVORITES has no exception.

Method GET_LOG_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_LOGS	Call by reference	☐	Type reference (TYPE)	ETFAV_UI_LOG_TT		eCATT Table Type of ETFAV_UI_LOG	20120724

Method GET_LOG_HISTORY on class CL_APL_ECATT_FAVORITES has no exception.

Method GET_OBJECT_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120724
2	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120724
3	Returning	R_OBJ_VERSION	Value transfer	☐	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120724

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120724

Method GET_OBJ_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OBJS	Call by reference	☐	Type reference (TYPE)	ETFAV_UI_OBJ_TT		eCATT Table Type of ETFAV_UI_OBJ	20120712
2	Importing	IT_ACCESS_TYPE	Call by reference	☐	Type reference (TYPE)	ETFAV_ACCESS_TYPE_TT		eCATT Table Type of ETFAV_ACCESS_TYPE	20120724
3	Importing	IT_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETFAV_OBJ_TYPE_TT		List of object types	20120712

Method GET_OBJ_HISTORY on class CL_APL_ECATT_FAVORITES has no exception.

Method GET_TYPE_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ECATT_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120710
2	Returning	R_ICON	Value transfer	☐	Type reference (TYPE)	ETFAV_OBJ_TYPE_ICON		eCATT object type icon	20120710

Method GET_TYPE_ICON on class CL_APL_ECATT_FAVORITES has no exception.

Method IS_IN_FAVORITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120710
2	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120710
3	Importing	I_OBJ_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120710
4	Returning	R_IS_IN_FAVORITES	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Flag, if eCATT Object is in Favorites	20120816

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120726

Method MANAGE_OBJ_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_ACCESS_TYPE	Call by reference	☑	Type reference (TYPE)	ETFAV_ACCESS_TYPE		Access Type (to delete)	20120727
2	Importing	I_OBJ_MODE	Call by reference	☐	Type reference (TYPE)	ETFAV_OBJ_MODE		Object Mode	20120724
3	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120724
4	Importing	I_OBJ_NEW_NAME	Call by reference	☑	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120724
5	Importing	I_OBJ_NEW_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120724
6	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120724
7	Importing	I_OBJ_VERSION	Call by reference	☑	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120724

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120724

Method MOVE_FAV_TO_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FOLDER	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		Folder name	20121128
2	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20121128
3	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20121128
4	Importing	I_OBJ_VERSION	Call by reference	☐	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20121128

Method MOVE_FAV_TO_FOLDER on class CL_APL_ECATT_FAVORITES has no exception.

Method READ_OBJ_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_OBJ_DATA	Call by reference	☐	Type reference (TYPE)	ETFAV_UI_OBJ		eCATT Structure for Favorites	20120710
2	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120710
3	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120710
4	Importing	I_OBJ_VERSION	Call by reference	☐	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120710

Method READ_OBJ_DATA on class CL_APL_ECATT_FAVORITES has no exception.

Method RENAME_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120807
2	Importing	I_OBJ_NEW_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Object	20120807
3	Importing	I_OBJ_NEW_VERSION	Call by reference	☐	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120807
4	Importing	I_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Object Type (Test Data, Script, Configuration, etc.)	20120807
5	Importing	I_OBJ_VERSION	Call by reference	☐	Type reference (TYPE)	ETOBJ_VER		eCATT Object Version	20120807

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basis Class for eCATT Middleware Exceptions	20120807

History

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