SAP ABAP Class CL_FDT_WORKLIST (FDT: Worklist)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
     ⤷ SFDT_CORE (Package) BRFplus: Core

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FDT_WORKLIST	FDT: Worklist	20050822

Properties

Class	CL_FDT_WORKLIST
Short Description	FDT: Worklist
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SFDT_CORE	BRFplus: Core
Created	20050822	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)
2	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_FDT_WORKLIST	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FDT_WORKLIST	☐	☐	FDT: Worklist	20050822

Friends

#	Friend	Modeled only	Created on	Description
1	CL_FDT_UNITTEST_HELPERS	☐	20070827	Toolset for global unit tests

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_FDT_WORKLIST			20050822
2	GTH_CHANGED_OBJECT	Static Attribute	Public	☑	Type reference (TYPE)	TH_OREF			20080118
3	GTH_NOT_YET_CALCULATED_USAGES	Static Attribute	Private	☐	Type reference (TYPE)	TH_OREF			20080306
4	GTH_UNSAVED_OBJECTS	Static Attribute	Public	☑	Type reference (TYPE)	IF_FDT_TYPES=>TH_OBJECT_ID		Object IDs as hashed table	20080307
5	GTH_UNSAVED_USAGES	Static Attribute	Private	☐	Type reference (TYPE)	TH_USED_ID			20080307
6	GTH_UNSAVED_USING_IDS	Static Attribute	Private	☐	Type reference (TYPE)	TH_USING_ID			20080307
7	GV_MASS_OP	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		Currently only for recursion handling	20090506

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_INSTANCE	Static method	Public	Method		20051024
2	GET_OBJECT_SET_RELATIONS	Static method	Protected	Method		20060407
3	GET_SUB_TREE_RECURSIVE	Static method	Private	Method		20060407
4	GET_UNSAVED_DELETED	Static method	Public	Method	Get list of unsaved deleted objects	20071230
5	GET_UNSAVED_OBJECTS	Static method	Public	Method	Get list of unsaved objects	20061020
6	GET_UNSAVED_USAGES	Static method	Public	Method	Get usages of an object in changed unsaved objects	20061020
7	IS_APPLICATION_ID_VALID	Instance method	Private	Method		20050915
8	IS_OBJECT_TYPE_VALID	Instance method	Private	Method		20050915
9	IS_USER_VALID	Instance method	Private	Method		20050915
10	RECALCULATE_UNSAVED_USAGES	Static method	Private	Method		20080306
11	REGISTER_OBJECT	Instance method	Public	Method	Register a changed object at the worklist	20061020
12	SET_FAILURE	Instance method	Private	Method	Set failed ID and update corresponding entry of ID_MESSAGE	20111122
13	SET_FAILURES	Instance method	Private	Method	Set failed IDs and enrich ID_MESSAGE	20111122
14	UNREGISTER_OBJECT	Instance method	Public	Method	Unregister an object at the worklist after save or rollback	20061020

Events

#	Event	Type	Visibility	Description	Created on
1	OBJECT_CHANGED	Instance Event (0)	Public (2)	Object has changed	20121105
2	OBJECT_CHANGES_DISCARD	Instance Event (0)	Public (2)	Object changes were discarded	20121114
3	OBJECT_SAVED	Instance Event (0)	Public (2)	The object was saved	20121114

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_ID_STACK	Protected	See coding			20060407	BEGIN OF s_id_stack, id TYPE if_fdt_types=>id, level TYPE i, END OF s_id_stack
2	S_REF_ID_SET	Protected	See coding			20060407	BEGIN OF s_ref_id_set, id TYPE if_fdt_types=>id, * internal/external to ID set is_external TYPE abap_bool, "message0000218151 * Processing Information. counter TYPE i, level TYPE i, was_referenced_int TYPE abap_bool, has_ext_reference TYPE abap_bool, has_self_reference TYPE abap_bool, * ID Meta Data. name TYPE if_fdt_types=>name, object_type TYPE if_fdt_types=>object_type, data_object_type TYPE if_fdt_types=>data_object_type, element_type TYPE if_fdt_types=>element_type, expression_type TYPE if_fdt_types=>id, * Internal/External referenced Objects. ts_int_ref_objects TYPE if_fdt_types=>ts_usage, ts_ext_ref_objects TYPE if_fdt_types=>ts_usage, th_id_stack TYPE th_id_stack, END OF s_ref_id_set
3	S_USED_ID	Private	See coding			20080306	BEGIN OF s_used_id, used_id TYPE if_fdt_types=>id, th_using TYPE th_using, END OF s_used_id
4	S_USING_ID	Private	See coding			20080306	BEGIN OF s_using_id, using_id TYPE if_fdt_types=>id, th_used TYPE if_fdt_types=>th_object_id, END OF s_using_id
5	TH_ID_STACK	Protected	See coding			20060407	th_id_stack TYPE HASHED TABLE OF s_id_stack WITH UNIQUE KEY id
6	TH_OREF	Public	See coding			20080118	th_oref TYPE HASHED TABLE OF REF TO if_fdt_admin_data WITH UNIQUE KEY table_line
7	TH_REF_ID_SET	Protected	See coding			20060407	th_ref_id_set TYPE HASHED TABLE OF s_ref_id_set WITH UNIQUE KEY id
8	TH_USED_ID	Private	See coding			20080306	th_used_id TYPE HASHED TABLE OF s_used_id WITH UNIQUE KEY used_id
9	TH_USING	Private	See coding			20080307	th_using TYPE HASHED TABLE OF if_fdt_types=>s_usage WITH UNIQUE KEY id
10	TH_USING_ID	Private	See coding			20080306	th_using_id TYPE HASHED TABLE OF s_using_id WITH UNIQUE KEY using_id

Method Signatures

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_WORKLIST	Value transfer	☐	Object reference (TYPE REF TO)	IF_FDT_WORKLIST			20051024

Method GET_INSTANCE on class CL_FDT_WORKLIST has no exception.

Method GET_OBJECT_SET_RELATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CTH_REF_ID_SET	Call by reference	☐	Type reference (TYPE)	TH_REF_ID_SET			20060407
2	Exporting	ET_OBJECT_ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST~T_OBJECT_ID			20060808
3	Exporting	ET_OBJECT_ID_EXPRESSION_TYPE	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST~T_OBJECT_ID			20060808
4	Exporting	ET_OBJECT_ID_SEQUENCE	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST~T_OBJECT_ID			20060407
5	Importing	IV_FULL_INFORMATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060407
6	Importing	IV_RELATE_BY_USAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060407

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20060407

Method GET_SUB_TREE_RECURSIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_REF_ID_SET	Call by reference	☐	Type reference (TYPE)	S_REF_ID_SET			20060407
2	Changing	CTH_ID_STACK	Call by reference	☐	Type reference (TYPE)	TH_ID_STACK			20060407
3	Changing	CTH_REF_ID_SET	Call by reference	☐	Type reference (TYPE)	TH_REF_ID_SET			20060407
4	Changing	CT_MESSAGE	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>T_MESSAGE		Messages	20080318
5	Changing	CT_OBJECT_ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST~T_OBJECT_ID			20060808
6	Changing	CT_OBJECT_ID_EXPRESSION_TYPE	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST~T_OBJECT_ID			20060808
7	Changing	CT_OBJECT_ID_SEQUENCE	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST~T_OBJECT_ID			20060407
8	Changing	CV_COUNTER	Call by reference	☐	Type reference (TYPE)	I			20060407
9	Changing	CV_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20060407
10	Exporting	EV_SELF_REFERENCED_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID			20070313
11	Importing	IV_FULL_INFORMATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060407
12	Importing	IV_REFERENCING_ID	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>ID		Universal Unique Identifier	20070919
13	Importing	IV_RELATE_BY_USAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060407

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20060407

Method GET_UNSAVED_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_DELETED	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		List of deleted objects	20071230
2	Exporting	ETS_MARKED_DELETED	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		List of marked for deleted objects	20071230

Method GET_UNSAVED_DELETED on class CL_FDT_WORKLIST has no exception.

Method GET_UNSAVED_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RTH_OBJECT	Value transfer	☐	Type reference (TYPE)	TH_OREF		List of unsaved object references	20080118

Method GET_UNSAVED_OBJECTS on class CL_FDT_WORKLIST has no exception.

Method GET_UNSAVED_USAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETH_UNSAVED_USING_OBJECTS	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TH_OBJECT_ID		Unsaved using objects NEEDED for deleting obsolete DB usages	20080307
2	Exporting	ETS_DELETED	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		List of deleted objects	20070904
3	Exporting	ETS_MARKED_DELETED	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		List of marked for deleted objects	20070904
4	Exporting	ETS_USAGE	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_USAGE		List of unsaved usages of iv_id	20070904
5	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID of object for which we look for usages	20061020

Method GET_UNSAVED_USAGES on class CL_FDT_WORKLIST has no exception.

Method IS_APPLICATION_ID_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID			20050915
2	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050915

Method IS_APPLICATION_ID_VALID on class CL_FDT_WORKLIST has no exception.

Method IS_OBJECT_TYPE_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>OBJECT_TYPE			20050915
2	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050915

Method IS_OBJECT_TYPE_VALID on class CL_FDT_WORKLIST has no exception.

Method IS_USER_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME		Benutzername	20050915
2	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050915

Method IS_USER_VALID on class CL_FDT_WORKLIST has no exception.

Method RECALCULATE_UNSAVED_USAGES Signature

Method RECALCULATE_UNSAVED_USAGES on class CL_FDT_WORKLIST has no parameter.
Method RECALCULATE_UNSAVED_USAGES on class CL_FDT_WORKLIST has no exception.

Method REGISTER_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_ADMIN_DATA		changed FDT object	20061020

Method REGISTER_OBJECT on class CL_FDT_WORKLIST has no exception.

Method SET_FAILURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CTH_ID_MESSAGE	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST=>TH_ID_MESSAGE			20111122
2	Changing	CTS_FAILURE	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		Object IDs as sorted table	20111122
3	Importing	IT_MESSAGE	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>T_MESSAGE		Messages	20111122
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		Universal Unique Identifier	20111122

Method SET_FAILURE on class CL_FDT_WORKLIST has no exception.

Method SET_FAILURES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CTH_ID_MESSAGE	Call by reference	☐	Type reference (TYPE)	IF_FDT_WORKLIST=>TH_ID_MESSAGE			20111122
2	Changing	CTS_FAILURE	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		Object IDs as sorted table	20111122
3	Importing	ITS_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>TS_OBJECT_ID		Object IDs as sorted table	20111122
4	Importing	IT_MESSAGE	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>T_MESSAGE		Messages	20111122

Method SET_FAILURES on class CL_FDT_WORKLIST has no exception.

Method UNREGISTER_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_ADMIN_DATA		FDT object	20061020
2	Importing	IV_CHANGE_DISCARDED	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		True: Unregister due to discard	20121114

Method UNREGISTER_OBJECT on class CL_FDT_WORKLIST has no exception.

Event Signatures

Event OBJECT_CHANGED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IO_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	IF_FDT_ADMIN_DATA		Changed object	20121105

Event OBJECT_CHANGES_DISCARD Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IO_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	IF_FDT_ADMIN_DATA		Object, which changes were discarded	20121114

Event OBJECT_SAVED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IO_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	IF_FDT_ADMIN_DATA		Object	20121114

History

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