SAP ABAP Class CL_AXT_RULE_DIRECTOR (AXT Rule Director Class)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-EEW (Application Component) Easy Enhancement Workbench
     ⤷ AXT_MODEL (Package) Application Extensibility Tool: Model

Properties

Class	CL_AXT_RULE_DIRECTOR
Short Description	AXT Rule Director Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	AXT_MODEL	Application Extensibility Tool: Model
Created	20090922	SAP
Last change	20110908	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_AXT_RULE_DIRECTOR has no interface implemented.

Friends

Class CL_AXT_RULE_DIRECTOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_GUID_AXT_RUN_RULE	Constant	Public	☐	Type reference (TYPE)	AXT_GUID	'801CC41742B81DDEAE80BF2DECE64ADC'	AXT_RUN_RULE entries	20091013
2	GC_PARAM_APP_ID	Constant	Public	☐	Type reference (TYPE)	CHAR30	'APP_ID'	30 Characters	20091001
3	GC_PARAM_APP_NAME	Constant	Public	☐	Type reference (TYPE)	CHAR30	'APP_NAME'	30 Characters	20091002
4	GC_PARAM_RULE_EXEC_EVENT_TYPE	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_EXEC_EVENT_TYPE'	30 Characters	20091127
5	GC_PARAM_RULE_ID	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_ID'	30 Characters	20091001
6	GC_PARAM_RULE_OBJ_NAME	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_OBJ_NAME'	30 Characters	20091001
7	GC_PARAM_RULE_OBJ_TYPE	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_OBJ_TYPE'	30 Characters	20091001
8	GC_PARAM_RULE_PARAM_MAP_FROM	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_PARAM_MAP_FROM'	30 Characters	20091001
9	GC_PARAM_RULE_PARAM_MAP_TO	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_PARAM_MAP_TO'	30 Characters	20091001
10	GC_PARAM_RULE_PARAM_X_REF_ID	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_PARAM_X_REF_ID'	30 Characters	20091202
11	GC_PARAM_RULE_PARAM_X_RESULT	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_PARAM_X_RESULT'	30 Characters	20091001
12	GC_PARAM_RULE_TYPE	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_TYPE'	30 Characters	20091001
13	GC_PART_TYPE_APP_DEF	Constant	Public	☐	Type reference (TYPE)	CHAR30	'APP_DEF'	30 Characters	20091002
14	GC_PART_TYPE_RULE	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE'	30 Characters	20091001
15	GC_PART_TYPE_RULE_DIRECTOR	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_DIRECTOR'	30 Characters	20090924
16	GC_PART_TYPE_RULE_MAPPER	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_MAPPER'	30 Characters	20091002
17	GC_PART_TYPE_RULE_PARAM_MAP	Constant	Public	☐	Type reference (TYPE)	CHAR30	'RULE_PARAM_MAP'	30 Characters	20091001
18	MO_OWNER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_AXT_RULE_DIRECTOR_CALLBACK		Callback interface for rule director to extension	20090924
19	MT_APP_DEF	Instance attribute	Private	☐	See coding				20091002
20	MT_RULE_DEF	Instance attribute	Private	☐	See coding				20090924
21	MT_RULE_MAPPER	Instance attribute	Private	☐	See coding				20091002
22	MV_BO	Instance attribute	Public	☑	Type reference (TYPE)	AXT_BO		Enhanced Object	20091027
23	MV_BO_PART	Instance attribute	Public	☑	Type reference (TYPE)	AXT_BO_PART		Part of Enhanced Object	20091027
24	MV_UI_OBJ_TYPE	Instance attribute	Public	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		Object Types	20091029

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_GEN_CATALOGUE	Instance method	Public	Method		20090924
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090924
3	COPY	Instance method	Public	Method		20090924
4	CREATE_RULE_HANDLER	Instance method	Public	Method	Create rule handler to test in design time (Not Used)	20090925
5	DELETE_REMAINING	Instance method	Public	Method	Only applicable to all rule builder	20090928
6	DEREGISTER_HANDLER	Instance method	Private	Method		20100414
7	DESERIALIZE	Instance method	Public	Method		20090924
8	GET_BOL_OBJS_AND_UI_OBJ_TYPES	Instance method	Public	Method		20091027
9	GET_FIELD_LIST	Instance method	Public	Method		20091028
10	GET_NEW_BOL_OBJECT_ACCESS	Instance method	Public	Method		20100525
11	GET_RULE_BUILDER	Instance method	Public	Method		20090922
12	GET_RULE_DEF_BY_FIELD	Instance method	Public	Method		20091029
13	GET_RULE_MAPPER	Instance method	Public	Method		20091029
14	IS_LOCKED	Instance method	Public	Method		20100309
15	LOCK	Instance method	Public	Method	Only applicable to all rule builder	20090928
16	MARK_RULE_TO_BE_DELETED	Instance method	Public	Method		20091119
17	ON_DATATYPE_CHANGED	Instance method	Private	Event handling method		20091119
18	ON_FIELD_DELETED	Instance method	Private	Event handling method		20100301
19	ON_FIELD_ID_CHANGED	Instance method	Private	Event handling method		20091119
20	ON_RULE_CHANGED	Instance method	Private	Event handling method		20091103
21	ON_X_TRANSIENT_CHANGED	Instance method	Private	Event handling method		20091117
22	REFRESH	Instance method	Public	Method		20101216
23	REGISTER_HANDLER	Instance method	Private	Method		20100414
24	REGISTER_HANDLER_FOR_RULE	Instance method	Private	Method		20100414
25	SAVE	Instance method	Public	Method	Only applicable to all rule builder	20090928
26	SERIALIZE	Instance method	Public	Method		20090924
27	SET_CONTEXT_ATTRIBUTES	Instance method	Public	Method		20091029
28	UNLOCK	Instance method	Public	Method	Only applicable to all rule builder	20090928
29	VALIDATE	Instance method	Public	Method		20100212

Events

Class CL_AXT_RULE_DIRECTOR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_APP_DEF	Private	See coding			20091002	BEGIN OF ty_app_def, app_id TYPE axt_guid, name TYPE axt_name, END OF ty_app_def
2	TY_RULE_DEF	Private	See coding			20090924	BEGIN OF ty_rule_def, app_id TYPE axt_guid, id TYPE axt_guid, builder TYPE REF TO if_axt_rule_builder, event_type TYPE axt_rule_event_type, tbd TYPE axt_boolean, "To be deleted END OF ty_rule_def
3	TY_RULE_MAPPER	Private	See coding			20091002	BEGIN OF ty_rule_mapper, mapper TYPE REF TO if_axt_rule_mapper, object_name TYPE axt_name, rule_id TYPE axt_guid, END OF ty_rule_mapper

Method Signatures

Method BUILD_GEN_CATALOGUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CATALOGUE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AXT_CATALOGUE		Catalogue holding elements to generate	20090924

#	Exception	Resumable	Description	Created on
1	CX_AXT_OPERATION_FAILED	☐	Operation error	20090924

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OWNER	Call by reference	☐	Object reference (TYPE REF TO)	IF_AXT_RULE_DIRECTOR_CALLBACK		Callback interface for rule director to extension	20090924

Method CONSTRUCTOR on class CL_AXT_RULE_DIRECTOR has no exception.

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_AXT_RULE_DIRECTOR		AXT Rule Director Class	20090924

Method COPY on class CL_AXT_RULE_DIRECTOR has no exception.

Method CREATE_RULE_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	AXT_NAME		Name	20090925
2	Importing	IV_RULE_ID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20090925
3	Importing	IV_RULE_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	AXT_RULE_OBJ_TYPE		Object Type	20090925
4	Importing	IV_RULE_TYPE	Call by reference	☐	Type reference (TYPE)	AXT_RULE_TYPE		Rule Type	20090925
5	Importing	IV_TRACE_MODE	Call by reference	☑	Type reference (TYPE)	AXT_RULE_TRACE_MODE		Rule Trace Mode	20091019
6	Returning	RO_RULE_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	IF_AXT_RULE_HANDLER			20090925

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_NOT_FOUND	☐	Data not found error	20090925

Method DELETE_REMAINING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20090928

#	Exception	Resumable	Description	Created on
1	CX_AXT_OPERATION_FAILED	☐	Operation error	20090928

Method DEREGISTER_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DIRECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_AXT_RULE_DIRECTOR		AXT Rule Director Class	20100414

Method DEREGISTER_HANDLER on class CL_AXT_RULE_DIRECTOR has no exception.

Method DESERIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PART	Call by reference	☐	Object reference (TYPE REF TO)	CL_AXT_EXTENSION_PART		XML Like part of an extension	20090924

Method DESERIALIZE on class CL_AXT_RULE_DIRECTOR has no exception.

Method GET_BOL_OBJS_AND_UI_OBJ_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BOL_OBJECTS	Call by reference	☐	Type reference (TYPE)	AXTT_BOL_OBJECT_WITH_PARENT		List of names	20091027
2	Exporting	ET_UI_OBJECT_TYPES	Call by reference	☐	Type reference (TYPE)	BSP_DLCT_OBJECT_TYPE		Object Type	20091027
3	Importing	IV_TABLE_ID	Call by reference	☑	Type reference (TYPE)	AXT_TABLE_ID		Table ID	20100823
4	Importing	IV_UI_OBJECT	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20100303

Method GET_BOL_OBJS_AND_UI_OBJ_TYPES on class CL_AXT_RULE_DIRECTOR has no exception.

Method GET_FIELD_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TABLE_ID	Call by reference	☑	Type reference (TYPE)	AXT_TABLE_ID		Table ID	20100823
2	Returning	RT_FIELD_LIST	Value transfer	☐	Type reference (TYPE)	AXTT_RULE_FIELD_LIST		Field list for rules	20091028

Method GET_FIELD_LIST on class CL_AXT_RULE_DIRECTOR has no exception.

Method GET_NEW_BOL_OBJECT_ACCESS Signature

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

Method GET_NEW_BOL_OBJECT_ACCESS on class CL_AXT_RULE_DIRECTOR has no exception.

Method GET_RULE_BUILDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APP_ID	Call by reference	☑	Type reference (TYPE)	AXT_GUID		GUID	20091029
2	Importing	IV_APP_NAME	Call by reference	☑	Type reference (TYPE)	AXT_NAME		Name	20091029
3	Importing	IV_EXECUTION_CONTEXT	Call by reference	☑	Type reference (TYPE)	AXT_NAME		Name	20091029
4	Importing	IV_EXEC_EVENT_TYPE	Call by reference	☑	Type reference (TYPE)	AXT_RULE_EVENT_TYPE		Rule Event Type	20091117
5	Importing	IV_LOAD_FROM_BUFFER	Call by reference	☐	Type reference (TYPE)	AXT_BOOLEAN	ABAP_FALSE	Boolean	20091117
6	Importing	IV_RULE_ID	Call by reference	☑	Type reference (TYPE)	AXT_GUID		GUID	20090924
7	Importing	IV_RULE_NAME	Call by reference	☑	Type reference (TYPE)	AXT_NAME		Name	20091029
8	Importing	IV_RULE_TYPE	Call by reference	☑	Type reference (TYPE)	AXT_RULE_TYPE			20091029
9	Returning	RO_RULE_BUILDER	Value transfer	☐	Object reference (TYPE REF TO)	IF_AXT_RULE_BUILDER		AXT Rule Builder	20090922

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_INVALID	☐	Data invalid error	20091029

Method GET_RULE_DEF_BY_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_APP_ID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20091029
2	Exporting	EV_RULE_ID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20091029
3	Exporting	EV_RULE_TYPE	Call by reference	☐	Type reference (TYPE)	AXT_RULE_TYPE		Rule Type	20091029
4	Importing	IV_FIELD_ID	Call by reference	☐	Type reference (TYPE)	AXT_FIELD_ID		Field ID	20091029
5	Importing	IV_OBJECT_NAME	Call by reference	☑	Type reference (TYPE)	AXT_OBJECT_NAME			20091208

Method GET_RULE_DEF_BY_FIELD on class CL_AXT_RULE_DIRECTOR has no exception.

Method GET_RULE_MAPPER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	AXT_NAME		Name	20091029
2	Importing	IV_RULE_ID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20091029
3	Importing	IV_RULE_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	AXT_RULE_OBJ_TYPE		Rule Object Type	20091029
4	Importing	IV_RULE_TYPE	Call by reference	☑	Type reference (TYPE)	AXT_RULE_TYPE		Rule Type	20091029
5	Returning	RO_RULE_MAPPER	Value transfer	☐	Object reference (TYPE REF TO)	IF_AXT_RULE_MAPPER		AXT Rule Mapper	20091029

Method GET_RULE_MAPPER on class CL_AXT_RULE_DIRECTOR has no exception.

Method IS_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOCKED	Value transfer	☐	Type reference (TYPE)	AXT_BOOLEAN		Boolean	20100309

Method IS_LOCKED on class CL_AXT_RULE_DIRECTOR has no exception.

Method LOCK Signature

Method LOCK on class CL_AXT_RULE_DIRECTOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_AXT_LOCK_FAILED	☐	Lock failed error	20090928

Method MARK_RULE_TO_BE_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DELETE	Call by reference	☐	Type reference (TYPE)	AXT_BOOLEAN	ABAP_TRUE	Boolean	20091119
2	Importing	IV_RULE_ID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20091119

Method MARK_RULE_TO_BE_DELETED on class CL_AXT_RULE_DIRECTOR has no exception.

Method ON_DATATYPE_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_ID	Value transfer	☐	Attribute reference (LIKE)				20091119
2	Importing	IV_OBJECT_NAME	Value transfer	☑	Attribute reference (LIKE)			Table ID	20100916

Method ON_DATATYPE_CHANGED on class CL_AXT_RULE_DIRECTOR has no exception.

Method ON_FIELD_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_ID	Value transfer	☐	Attribute reference (LIKE)				20100301
2	Importing	IV_OBJECT_NAME	Value transfer	☑	Attribute reference (LIKE)			Table ID	20100916

Method ON_FIELD_DELETED on class CL_AXT_RULE_DIRECTOR has no exception.

Method ON_FIELD_ID_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NEW	Value transfer	☐	Attribute reference (LIKE)				20091119
2	Importing	IV_OBJECT_NAME	Value transfer	☑	Attribute reference (LIKE)			Table ID	20100916
3	Importing	IV_OLD	Value transfer	☐	Attribute reference (LIKE)				20091119
4	Importing	IV_X_REF_FIELD	Value transfer	☐	Attribute reference (LIKE)				20100114

Method ON_FIELD_ID_CHANGED on class CL_AXT_RULE_DIRECTOR has no exception.

Method ON_RULE_CHANGED Signature

Method ON_RULE_CHANGED on class CL_AXT_RULE_DIRECTOR has no parameter.
Method ON_RULE_CHANGED on class CL_AXT_RULE_DIRECTOR has no exception.

Method ON_X_TRANSIENT_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_ID	Value transfer	☐	Attribute reference (LIKE)				20091117
2	Importing	IV_OBJECT_NAME	Value transfer	☑	Attribute reference (LIKE)			Table ID	20100916
3	Importing	IV_X_TRANSIENT	Value transfer	☐	Attribute reference (LIKE)				20091117

Method ON_X_TRANSIENT_CHANGED on class CL_AXT_RULE_DIRECTOR has no exception.

Method REFRESH Signature

Method REFRESH on class CL_AXT_RULE_DIRECTOR has no parameter.
Method REFRESH on class CL_AXT_RULE_DIRECTOR has no exception.

Method REGISTER_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DIRECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_AXT_RULE_DIRECTOR		AXT Rule Director Class	20100414

Method REGISTER_HANDLER on class CL_AXT_RULE_DIRECTOR has no exception.

Method REGISTER_HANDLER_FOR_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DIRECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_AXT_RULE_DIRECTOR		AXT Rule Director Class	20100414

Method REGISTER_HANDLER_FOR_RULE on class CL_AXT_RULE_DIRECTOR has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package	20090928
2	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20090928

#	Exception	Resumable	Description	Created on
1	CX_AXT_OPERATION_FAILED	☐	Operation error	20090928

Method SERIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_PART	Value transfer	☐	Object reference (TYPE REF TO)	CL_AXT_EXTENSION_PART		XML Like part of an extension	20091009

Method SERIALIZE on class CL_AXT_RULE_DIRECTOR has no exception.

Method SET_CONTEXT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BO	Call by reference	☑	Type reference (TYPE)	AXT_BO		Enhanced Object	20091029
2	Importing	IV_BO_PART	Call by reference	☑	Type reference (TYPE)	AXT_BO_PART		Part of Enhanced Object	20091029
3	Importing	IV_UI_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		Object Types	20091029

Method SET_CONTEXT_ATTRIBUTES on class CL_AXT_RULE_DIRECTOR has no exception.

Method UNLOCK Signature

Method UNLOCK on class CL_AXT_RULE_DIRECTOR has no parameter.
Method UNLOCK on class CL_AXT_RULE_DIRECTOR has no exception.

Method VALIDATE Signature

Method VALIDATE on class CL_AXT_RULE_DIRECTOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_AXT_OPERATION_FAILED	☐	Operation error	20100212

History

Last changed by/on	SAP	20110908
SAP Release Created in	701