SAP ABAP Class CL_TUT_AGENT (Unit Test Class Agent)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ TR (Application Component) Treasury
     ⤷ FTR_UTILS_CORE (Package) Utilities: Treasury and Risk Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_OS_CA_COMMON	Superclass of the Object Services Class Actors	20130830

Properties

Class	CL_TUT_AGENT
Short Description	Unit Test Class Agent
Super Class	CL_OS_CA_COMMON	Superclass of the Object Services Class Actors
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	FTR_UTILS_CORE	Utilities: Treasury and Risk Management
Created	20130830	SAP
Last change	20131127	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	CL_TUT_TEST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	OSCON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	OSTYP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_TUT_AGENT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_TUT_TEST	☐	20130830	Treasury Unit Test Utility

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_OS_KEY_NAME	Constant	Protected	☐	Type reference (TYPE)	TABNAME	'OS_OID'	Key of OS Data	20130830
2	GT_FIELD_CHANGE	Static Attribute	Protected	☐	Type reference (TYPE)	TY_T_FIELDNAME		Field Names for Last Change Data	20130830
3	GT_FIELD_CREATE	Static Attribute	Protected	☐	Type reference (TYPE)	TY_T_FIELDNAME		Field Names for Creation Data	20130830
4	GT_FIELD_KEY	Static Attribute	Protected	☐	Type reference (TYPE)	TY_T_FIELDNAME		Possible Name of Key Fields	20130830
5	MO_AGENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_OS_CA_COMMON		Superclass of the Object Services Class Actors	20130830
6	MO_AGENT_TEMP	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_OS_CA_COMMON		Temporary Store for Real Agent	20130914
7	MO_LOCAL_AGENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_OS_CA_COMMON		Local Child of Agent	20130914
8	MO_TDC	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_APL_ECATT_TDC_API		Test Data Container Object	20130830
9	MR_O_OBJECT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Reference of Type 'TYP_OBJECT_REF'	20130830
10	MR_S_OS_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		OS Internal Data Structure	20130830
11	MR_T_DB_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		DB Data	20130830
12	MR_T_OBJECT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Reference of Type 'typ_object_ref_tab'	20130830
13	MR_T_OS_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Table of OS Internal Structure	20130830
14	MR_T_OS_DATA_CHANGED	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Changed Objects in OS Format	20130830
15	MR_T_OS_DATA_CREATED	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Created Objects in OS Format	20130830
16	MR_T_OS_DATA_UNCHANGED	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Unchanged Objects in OS Format	20130830
17	MT_FIELD_EXCL	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_FIELDNAME		Fields to be Excluded from Comparison	20130830
18	MV_AGENT_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	SEOCLSNAME		Agent Name	20130830
19	MV_CLASS_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	SEOCLSNAME		Class Name	20130830
20	MV_DB_KEY_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	TABNAME		Key of DB Data	20130830
21	MV_TDC_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ETOBJ_NAME		Test Data Container (for trace)	20130830
22	MV_VARIANT_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ETVAR_ID		Variant (for trace)	20130830

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CAST_GENERIC_2_SPECIFIC	Instance method	Protected	Method	converts objects to OS data format	20130830
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	Adds DB Data BKey and OID	20130830
3	CLEAR_FIELDS	Instance method	Protected	Method	release all instances	20130830
4	COLLECT_ACTUAL_DATA	Instance method	Public	Method	casts object references from generic to specific ones	20130830
5	COMPARE	Instance method	Public	Method	CLASS_CONSTRUCTOR	20130830
6	COMPARE_CHANGED	Instance method	Protected	Method	sets test data container to trace results	20130830
7	COMPARE_CREATED	Instance method	Protected	Method	compares changed instances	20130830
8	CONSTRUCTOR	Instance method	Protected	Constructor	creates representants for TDC objects	20130830
9	CONVERT_OBJECTS_2_OS_DATA	Instance method	Protected	Method	reads TDC and creates representants	20130830
10	CREATE_REPRESENTANTS	Instance method	Protected	Method	determines name of key component	20130830
11	DESTROY_INSTANCES	Instance method	Public	Method	clears the fields, if available in the structure	20130830
12	DETERMINE_KEY_NAME	Instance method	Protected	Method	maps data from DB into OS internal format	20130830
13	FIND_LOCAL_AGENT	Instance method	Protected	Method	finds a local child of the agent	20130914
14	GET_ALL_OBJECTS	Instance method	Public	Method	gets all objects	20130917
15	INTERPRET_EXPECTED_DATA	Instance method	Protected	Method	compares created instances	20130830
16	MAP_DATA_DB2OS	Instance method	Protected	Method	maps data from OS internal to DB format	20130830
17	MAP_DATA_OS2DB	Instance method	Protected	Method	read access to a TDC object	20130830
18	MAP_MERGE_IDENTIFIER	Instance method	Protected	Method	compares actual with expected data	20130830
19	ON_READ_ACCESS	Instance method	Protected	Event handling method	sets attributes of class	20130830
20	PRELOAD_OBJECTS_FROM_TDC	Instance method	Public	Method	collects actual data	20130830
21	RESET_AGENT	Instance method	Protected	Method	resets the agent	20130914
22	SET_AGENT	Instance method	Protected	Method	sets the local agent, if necessary	20130914
23	SET_ATTRIBUTES	Instance method	Protected	Method	splits expected data into created and changed ones	20130830
24	SET_TRACE_TDC	Instance method	Public	Method	CONSTRUCTOR	20130830

Events

Class CL_TUT_AGENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_T_FIELDNAME	Protected	See coding		Field Names	20130830	TY_T_FIELDNAME TYPE TABLE OF TABNAME WITH DEFAULT KEY
2	TY_T_OS_GUID	Protected	See coding		GUIDs (RAW16)	20130830	TY_T_OS_GUID TYPE STANDARD TABLE OF os_guid WITH DEFAULT KEY

Method Signatures

Method CAST_GENERIC_2_SPECIFIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Specific Object References	20130830
2	Exporting	ET_OS_OID	Call by reference	☐	Type reference (TYPE)	TY_T_OS_GUID		Table of GUIDs	20130830
3	Importing	IT_OBJECT	Call by reference	☐	Type reference (TYPE)	OSTYP_REF_TAB		Generiic Object References	20130830

Method CAST_GENERIC_2_SPECIFIC on class CL_TUT_AGENT has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_TUT_AGENT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_TUT_AGENT has no exception.

Method CLEAR_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_DATA	Call by reference	☐	Type reference (TYPE)	ANY		Structure with Data	20130830
2	Importing	IT_FIELDNAME	Call by reference	☐	Type reference (TYPE)	TY_T_FIELDNAME		Field Names	20130830

Method CLEAR_FIELDS on class CL_TUT_AGENT has no exception.

Method COLLECT_ACTUAL_DATA Signature

Method COLLECT_ACTUAL_DATA on class CL_TUT_AGENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TRBA_ROOT	☐		20130830

Method COMPARE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DB_DATA_EXP	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Expected Data	20130830

Method COMPARE on class CL_TUT_AGENT has no exception.

Method COMPARE_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CT_DATA_ACT	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Actual Data	20130830
2	Importing	CT_DATA_EXP	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Expected Data	20130830

Method COMPARE_CHANGED on class CL_TUT_AGENT has no exception.

Method COMPARE_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CT_DATA_ACT	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Actual Data	20130830
2	Importing	CT_DATA_EXP	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Expected Data	20130830

Method COMPARE_CREATED on class CL_TUT_AGENT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name of Persistent Class	20130830

Method CONSTRUCTOR on class CL_TUT_AGENT has no exception.

Method CONVERT_OBJECTS_2_OS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OS_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Objects in OS Internal Format	20130830
2	Importing	IT_OBJECT	Call by reference	☐	Type reference (TYPE)	OSTYP_REF_TAB		Objects	20130830

Method CONVERT_OBJECTS_2_OS_DATA on class CL_TUT_AGENT has no exception.

Method CREATE_REPRESENTANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OS_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Objects' Data in OS Format	20130830

Method CREATE_REPRESENTANTS on class CL_TUT_AGENT has no exception.

Method DESTROY_INSTANCES Signature

Method DESTROY_INSTANCES on class CL_TUT_AGENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TRBA_ROOT	☐		20130830

Method DETERMINE_KEY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY		Data Structure	20130830
2	Returning	RV_KEY_NAME	Value transfer	☐	Type reference (TYPE)	TABNAME		Name of Key Field	20130830

Method DETERMINE_KEY_NAME on class CL_TUT_AGENT has no exception.

Method FIND_LOCAL_AGENT Signature

Method FIND_LOCAL_AGENT on class CL_TUT_AGENT has no parameter.
Method FIND_LOCAL_AGENT on class CL_TUT_AGENT has no exception.

Method GET_ALL_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Objects	20130917

Method GET_ALL_OBJECTS on class CL_TUT_AGENT has no exception.

Method INTERPRET_EXPECTED_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DATA_BEFORE	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Before Image	20130830
2	Exporting	ET_DATA_CHANGED	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Changed Objects	20130830
3	Exporting	ET_DATA_CREATED	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Created Objects	20130830
4	Importing	IT_DATA_AFTER	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		After Image	20130830

Method INTERPRET_EXPECTED_DATA on class CL_TUT_AGENT has no exception.

Method MAP_DATA_DB2OS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OS_GUID	Call by reference	☐	Type reference (TYPE)	TY_T_OS_GUID		Object Keys	20130830
2	Exporting	ET_OS_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Data in OS Internal Format	20130830
3	Importing	IT_DB_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Data in DB Format	20130830

Method MAP_DATA_DB2OS on class CL_TUT_AGENT has no exception.

Method MAP_DATA_OS2DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DB_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Data in DB Format	20130830
2	Importing	IT_OS_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Data in OS Internal Format	20130830
3	Importing	IV_FLG_CREATED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Map Created Data	20130830

Method MAP_DATA_OS2DB on class CL_TUT_AGENT has no exception.

Method MAP_MERGE_IDENTIFIER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_DB_DATA_TAB	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Object Data in Which Identifiers Are to Be Mixed	20130830
2	Importing	I_OID_TAB	Call by reference	☐	Type reference (TYPE)	TY_T_OS_GUID		List of OIDs	20130830

Method MAP_MERGE_IDENTIFIER on class CL_TUT_AGENT has no exception.

Method ON_READ_ACCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Value transfer	☐	Attribute reference (LIKE)				20130830

Method ON_READ_ACCESS on class CL_TUT_AGENT has no exception.

Method PRELOAD_OBJECTS_FROM_TDC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DB_GUID	Call by reference	☐	Type reference (TYPE)	CL_TUT_TEST=>TY_T_OS_OID		Desired Subset of Object Keys	20130830
2	Importing	IV_TDC_ID	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		TDC Representing DB Image	20130830
3	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	ETVAR_ID		Variant Representing DB Image	20130830

#	Exception	Resumable	Description	Created on
1	CX_ECATT	☐		20130830
2	CX_TRBA_ROOT	☐		20130830

Method RESET_AGENT Signature

Method RESET_AGENT on class CL_TUT_AGENT has no parameter.
Method RESET_AGENT on class CL_TUT_AGENT has no exception.

Method SET_AGENT Signature

Method SET_AGENT on class CL_TUT_AGENT has no parameter.
Method SET_AGENT on class CL_TUT_AGENT has no exception.

Method SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_OBJECT_INFO	Call by reference	☐	Attribute reference (LIKE)	CURRENT_OBJECT_INFO		Object Info	20130830
2	Importing	IV_OS_OID	Call by reference	☐	Type reference (TYPE)	OS_GUID		Globally Unique Identifier	20130830

Method SET_ATTRIBUTES on class CL_TUT_AGENT has no exception.

Method SET_TRACE_TDC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_TDC	Call by reference	☐	Object reference (TYPE REF TO)	CL_APL_ECATT_TDC_API		Test Data Container Access Class	20130830
2	Importing	IV_TDC_ID	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		Test Data Container	20130830
3	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	ETVAR_ID		Variant Name	20130830

Method SET_TRACE_TDC on class CL_TUT_AGENT has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in