SAP ABAP Interface IF_FDT_RULESET (FDT: Ruleset)
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 - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_FDT_RULESET FDT: Ruleset 20060810
Properties
Interface IF_FDT_RULESET  
Short Description FDT: Ruleset    
General Data
Package SFDT_CORE   BRFplus: Core 
Created 20060810   SAP 
Last changed 20140121   SAP 
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_RANGE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_FDT_TYPES Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_FDT_ADMIN_DATA FDT: Administrative Data 20060911
Friends
Interface IF_FDT_RULESET has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_CHANGE_MODE_INSERT Constant Public Type reference (TYPE) IF_FDT_RULESET=>CHANGE_MODE 'I' Insert 20080902
2 GC_CHANGE_MODE_UPDATE Constant Public Type reference (TYPE) IF_FDT_RULESET=>CHANGE_MODE SPACE Update (Default) 20080902
3 GC_NO_RESTART Constant Public Type reference (TYPE) FDT_RESTART_OPTION ' ' Restart Option: No Restart (Default) 20090925
4 GC_RESTART_AFTER_EXIT Constant Public Type reference (TYPE) FDT_RESTART_OPTION '2' Restart Option: Restart After Exit Condition 20090925
5 GC_RESTART_BEFORE_EXIT Constant Public Type reference (TYPE) FDT_RESTART_OPTION '1' Restart Option: Restart Before Exit Condition - Recheck 20090925
6 GC_RS_MAX_RULE Constant Public Type reference (TYPE) I 255 Maximum number of rules 20130406
7 GC_RS_MAX_VARIABLE Constant Public Type reference (TYPE) I 255 Maximum number of variables 20130406
8 GC_RS_PRIORITY_HIGHEST Constant Public Type reference (TYPE) PRIORITY 01 Ruleset Priority (01=first, 99=last, 00=undef.) 20100710
9 GC_RS_PRIORITY_LOWEST Constant Public Type reference (TYPE) PRIORITY 99 Ruleset Priority (01=first, 99=last, 00=undef.) 20100710
10 GC_RS_PRIORITY_NONE Constant Public Type reference (TYPE) PRIORITY 00 Ruleset Priority (01=first, 99=last, 00=undef.) 20100710
11 GC_SWITCH_OFF Constant Public Type reference (TYPE) IF_FDT_RULESET=>SWITCH ABAP_FALSE Switch is Off (Disabled) 20080902
12 GC_SWITCH_ON Constant Public Type reference (TYPE) IF_FDT_RULESET=>SWITCH ABAP_TRUE Switch is On (Enabled) 20080902
13 MV_CUSTOMIZING_OBJECT Instance attribute Public Attribute reference (LIKE) 20071228
14 MV_ID Instance attribute Public Attribute reference (LIKE) 20071228
15 MV_LOCAL_OBJECT Instance attribute Public Attribute reference (LIKE) 20071228
16 MV_MASTERDATA_OBJECT Instance attribute Public Attribute reference (LIKE) 20071228
17 MV_OBJECT_TYPE Instance attribute Public Attribute reference (LIKE) 20071228
18 MV_SYSTEM_OBJECT Instance attribute Public Attribute reference (LIKE) 20071228
Methods
# Method Level Visibility Method type Description Created on
1 ADD_RULE Instance method Public Method Add rule(s) 20060810
2 DELETE_RULE Instance method Public Method Delete rule(s) 20060810
3 GET_FUNCTION_RESTRICTION Instance method Public Method Get the function restriction 20060810
4 GET_RULES Instance method Public Method Get rules 20060810
5 GET_RULESET_CONDITION Instance method Public Method Get the condition for the complete rule set 20060810
6 GET_RULESET_INITIALIZATIONS Instance method Public Method Gets the ruleset variable initializations 20080924
7 GET_RULESET_PRIORITY Instance method Public Method Get ruleset priority 20080627
8 GET_RULESET_SWITCH Instance method Public Method Get the switch for the complete rule set 20060913
9 GET_RULESET_VARIABLES Instance method Public Method Get ruleset variables 20080902
10 SET_FUNCTION_RESTRICTION Instance method Public Method Set the function restriction 20060810
11 SET_RULES Instance method Public Method Set rules 20060810
12 SET_RULESET_CONDITION Instance method Public Method Set the condition for the complete rule set 20060810
13 SET_RULESET_INITIALIZATIONS Instance method Public Method Sets the ruleset variable initializations 20080924
14 SET_RULESET_PRIORITY Instance method Public Method Set ruleset priority 20080627
15 SET_RULESET_SWITCH Instance method Public Method Set the switch for the complete rule set 20060913
16 SET_RULESET_VARIABLES Instance method Public Method Set ruleset variables 20080902
Events
Interface IF_FDT_RULESET has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 CHANGE_MODE Public Type reference (TYPE) FDT_CHANGE_MODE Change Mode (Update, Insert) 20080902
2 POSITION Public Type reference (TYPE) FDT_RLST_1000-POS Position (in the ruleset) 20060810
3 PRIORITY Public Type reference (TYPE) FDT_INC_RLST_0000_DATA-PRIORITY Ruleset Priority (01=first, 99=last, 00=undef.) 20080624
4 RESTART_OPTION Public Type reference (TYPE) FDT_RESTART_OPTION Restart Option 20090925
5 SWITCH Public Type reference (TYPE) ABAP_BOOL Switch (on/off) 20060810
6 S_INIT_EXPR Public See coding Expression (Initialization) 20081202 BEGIN OF s_init_expr, position TYPE n LENGTH 3, change_mode TYPE change_mode, id TYPE if_fdt_types=>id, END OF s_init_expr
7 S_RULE Public See coding Rule 20060810 BEGIN OF s_rule, position TYPE if_fdt_ruleset=>position, function_id TYPE if_fdt_types=>id, condition_id TYPE if_fdt_types=>id, cond_range TYPE if_fdt_range=>s_param_range, valid_from TYPE if_fdt_types=>timestamp, valid_to TYPE if_fdt_types=>timestamp, rule_id TYPE if_fdt_types=>id, switch TYPE if_fdt_ruleset=>switch, exit_ruleset TYPE abap_bool, "to exit the ruleset when condition is true restart_option type RESTART_OPTION, "restart option for exit conditions. END OF s_rule
8 S_RULES_INTERVALS Public See coding 20090401 BEGIN OF s_rules_intervals, * Header. ruleset_id TYPE if_fdt_types=>id, rule_id TYPE if_fdt_types=>id, valid_from TYPE s_rule-valid_from, valid_to TYPE s_rule-valid_to, END OF s_rules_intervals
9 S_VARIABLE Public See coding Variable 20080902 BEGIN OF s_variable, position TYPE n LENGTH 3, data_object_id TYPE if_fdt_types=>id, END OF s_variable
10 TS_INIT_EXPR Public See coding Expressions (Initialization) 20081202 ts_init_expr TYPE SORTED TABLE OF s_init_expr WITH UNIQUE KEY position
11 TS_RULE Public See coding Rules 20060810 ts_rule TYPE SORTED TABLE OF s_rule WITH UNIQUE KEY position
12 TS_RULES_INTERVALS Public See coding 20090401 ts_rules_intervals TYPE SORTED TABLE OF s_rules_intervals WITH UNIQUE KEY ruleset_id rule_id valid_from
13 TS_VARIABLE Public See coding Variables 20080902 ts_variable TYPE SORTED TABLE OF s_variable WITH UNIQUE KEY position
Method Signatures

Method ADD_RULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RULE Call by reference Type reference (TYPE) IF_FDT_RULESET=>S_RULE Rule 20060810
2 Importing ITS_RULE Call by reference Type reference (TYPE) IF_FDT_RULESET=>TS_RULE Rules 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method DELETE_RULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_DELETION_COUNT Call by reference Type reference (TYPE) I Numbers of deleted rules 20060811
2 Exporting EV_NO_DELETION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE: nothing was deleted 20060811
3 Exporting EV_PARTIAL_DELETION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE: only some rules were deleted 20060811
4 Importing IS_RULE Call by reference Type reference (TYPE) IF_FDT_RULESET=>S_RULE Rule 20060810
5 Importing ITS_RULE Call by reference Type reference (TYPE) IF_FDT_RULESET=>TS_RULE Rules 20060810

Method DELETE_RULE on Interface IF_FDT_RULESET has no exception.

Method GET_FUNCTION_RESTRICTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_FUNCTION_ID Call by reference Type reference (TYPE) IF_FDT_TYPES=>ID Function ID 20060810
2 Exporting EV_NO_FUNCTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE: no function was set 20060810
3 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method GET_RULES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20060810
2 Returning RTS_RULE Value transfer Type reference (TYPE) IF_FDT_RULESET=>TS_RULE Rules 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method GET_RULESET_CONDITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_CONDITION_RANGE Call by reference Type reference (TYPE) IF_FDT_RANGE=>S_PARAM_RANGE 20090918
2 Exporting EV_CONDITION_ID Call by reference Type reference (TYPE) IF_FDT_TYPES=>ID Condition ID 20060810
3 Exporting EV_NO_CONDITION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE: no condition was set 20060810
4 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method GET_RULESET_INITIALIZATIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ETS_EXPRESSION Call by reference Type reference (TYPE) TS_INIT_EXPR Expressions (Initialization) 20081202
2 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20080924

Method GET_RULESET_INITIALIZATIONS on Interface IF_FDT_RULESET has no exception.

Method GET_RULESET_PRIORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20080627
2 Returning RV_PRIORITY Value transfer Type reference (TYPE) PRIORITY Priority 20080627
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20080627

Method GET_RULESET_SWITCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20060913
2 Returning RV_SWITCH Value transfer Type reference (TYPE) SWITCH Switch (see constants) 20060913
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060913

Method GET_RULESET_VARIABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) IF_FDT_TYPES=>TIMESTAMP Time Stamp (active version) 20080902
2 Returning RTS_VARIABLE Value transfer Type reference (TYPE) TS_VARIABLE Variables 20080923
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20080902

Method SET_FUNCTION_RESTRICTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FUNCTION_ID Call by reference Type reference (TYPE) IF_FDT_TYPES=>ID Function ID 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method SET_RULES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ITS_RULE Call by reference Type reference (TYPE) IF_FDT_RULESET=>TS_RULE Rules 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method SET_RULESET_CONDITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_CONDITION_RANGE Call by reference Type reference (TYPE) IF_FDT_RANGE=>S_PARAM_RANGE 20090918
2 Importing IV_CONDITION_ID Call by reference Type reference (TYPE) IF_FDT_TYPES=>ID Condition ID 20060810
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060810

Method SET_RULESET_INITIALIZATIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ITS_EXPRESSION Call by reference Type reference (TYPE) TS_INIT_EXPR Expressions (Initialization) 20081202
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20081209

Method SET_RULESET_PRIORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_PRIORITY Call by reference Type reference (TYPE) PRIORITY Priority 20080627
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20080627

Method SET_RULESET_SWITCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SWITCH Call by reference Type reference (TYPE) SWITCH Switch (see constants) 20060913
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20060913

Method SET_RULESET_VARIABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ITS_VARIABLE Call by reference Type reference (TYPE) TS_VARIABLE Variables 20080902
# Exception Resumable Description Created on
1 CX_FDT_INPUT FDT: Invalid Input 20080902
History
Last changed by/on SAP  20140121 
SAP Release Created in 710