SAP ABAP Interface IF_FDT_SEARCH_TREE (FDT: Search Tree)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
⤷
SFDT_EXPRESSIONS (Package) BRFplus: Expressions
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FDT_SEARCH_TREE | FDT: Search Tree | 20051005 |
Properties
| Interface | IF_FDT_SEARCH_TREE | |
| Short Description | FDT: Search Tree |
General Data
| Package | SFDT_EXPRESSIONS | BRFplus: Expressions |
| Created | 20051005 | SAP |
| Last changed | 20110908 | 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_CONSTANTS | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | IF_FDT_ELEMENT | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 4 | IF_FDT_RANGE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 5 | IF_FDT_SEARCH_TREE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 6 | 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_EXPRESSION | FDT: Expression | 20051024 |
Friends
Interface IF_FDT_SEARCH_TREE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_EXTY_SEARCH_TREE | Constant | Public | Type reference (TYPE) | IF_FDT_TYPES=>ID | IF_FDT_CONSTANTS=>GC_EXTY_SEARCH_TREE | Expression Type "Search Tree" | 20080417 | |
| 2 | GC_OPTION_BETWEEN | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_BETWEEN | Is between ... and ... | 20090114 | |
| 3 | GC_OPTION_CONTAINS_ANY | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_ANY | Contains any | 20090114 | |
| 4 | GC_OPTION_CONTAINS_NOT_ANY | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_NOT_ANY | Does not contain any | 20090114 | |
| 5 | GC_OPTION_CONTAINS_NOT_ONLY | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_NOT_ONLY | Does not contain only | 20090114 | |
| 6 | GC_OPTION_CONTAINS_NO_STRING | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_NO_STRING | Does not contain string | 20090114 | |
| 7 | GC_OPTION_CONTAINS_ONLY | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_ONLY | Contains only | 20090114 | |
| 8 | GC_OPTION_CONTAINS_PATTERN | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_PATTERN | Matches pattern | 20090114 | |
| 9 | GC_OPTION_CONTAINS_STRING | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_CONTAINS_STRING | Contains string | 20090114 | |
| 10 | GC_OPTION_EQUAL | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_EQUAL | Is equal to | 20090114 | |
| 11 | GC_OPTION_GREATER | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_GREATER | Greater than | 20090114 | |
| 12 | GC_OPTION_GREATER_EQUAL | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_GREATER_EQUAL | Greater than or equal to | 20090114 | |
| 13 | GC_OPTION_INITIAL | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_INITIAL | Is initial | 20090114 | |
| 14 | GC_OPTION_LESS | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_LESS | Less than | 20090114 | |
| 15 | GC_OPTION_LESS_EQUAL | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_LESS_EQUAL | Less than or equal to | 20090114 | |
| 16 | GC_OPTION_NOT_BETWEEN | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_NOT_BETWEEN | Is not between ... and ... | 20090114 | |
| 17 | GC_OPTION_NOT_CONTAINS_PATTERN | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_NOT_CONTAINS_PATTERN | Does not match pattern | 20090114 | |
| 18 | GC_OPTION_NOT_EQUAL | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_NOT_EQUAL | Is not equal to | 20090114 | |
| 19 | GC_OPTION_NOT_INITIAL | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_NOT_INITIAL | Is not initial | 20090114 | |
| 20 | GC_OPTION_NOT_SUPPLIED | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_NOT_SUPPLIED | Is not supplied | 20090114 | |
| 21 | GC_OPTION_SUPPLIED | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>OPTION | IF_FDT_ELEMENT=>GC_OPTION_SUPPLIED | Is supplied | 20090114 | |
| 22 | GC_ROOT_NODE | Constant | Public | Type reference (TYPE) | NODE_ID | '0000000001' | Root Node ID (same in all trees) | 20090209 | |
| 23 | GC_SIGN_EXCLUDE | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>SIGN | IF_FDT_ELEMENT=>GC_SIGN_EXCLUDE | Range limit excluded | 20090114 | |
| 24 | GC_SIGN_INCLUDE | Constant | Public | Type reference (TYPE) | IF_FDT_RANGE=>SIGN | IF_FDT_ELEMENT=>GC_SIGN_INCLUDE | Range limit included | 20090114 | |
| 25 | MV_ACTION | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 26 | MV_CUSTOMIZING_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 27 | MV_EXPRESSION_TYPE_ID | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 28 | MV_ID | Instance attribute | Public | Attribute reference (LIKE) | 20051103 | ||||
| 29 | MV_LOCAL_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 30 | MV_MASTERDATA_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 31 | MV_OBJECT_TYPE | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 32 | MV_RULE | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 33 | MV_SYSTEM_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Create a new tree node | 20051005 | |
| 2 | Instance method | Public | Method | Delete a node including all his children | 20051005 | |
| 3 | Instance method | Public | Method | Get the children below a given node | 20051103 | |
| 4 | Instance method | Public | Method | Get properties of a node | 20051010 | |
| 5 | Instance method | Public | Method | Get the root node of the tree | 20051005 | |
| 6 | Instance method | Public | Method | Get properties of the tree | 20051103 | |
| 7 | Instance method | Public | Method | Get (sub-)tree structure | 20051005 | |
| 8 | Instance method | Public | Method | Relocate an existing node (with subnodes) within the tree | 20051005 | |
| 9 | Instance method | Public | Method | Set properties of a node | 20051010 | |
| 10 | Instance method | Public | Method | Set properties of the tree | 20051103 |
Events
Interface IF_FDT_SEARCH_TREE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | NODE_ID | Public | Type reference (TYPE) | FDT_NODE_ID | FDT: ID of a node in a tree | 20051010 | |
| 2 | SEQNR | Public | Type reference (TYPE) | FDT_SEQNR | FDT: Sequence number | 20051012 | |
| 3 | S_NODE_SEQUENCE | Public | See coding | 20051012 | BEGIN OF s_node_sequence,
seqnr TYPE seqnr,
node TYPE node_id,
END OF s_node_sequence
|
||
| 4 | S_PARAM_RANGE | Public | See coding | Range for Parameter | 20090114 | BEGIN OF s_param_range,
parameter_id TYPE if_fdt_types=>id,
ts_range TYPE if_fdt_range=>ts_range,
END OF s_param_range
|
|
| 5 | S_TREE_STRUCTURE | Public | See coding | 20051205 | BEGIN OF s_tree_structure,
parent TYPE node_id,
seqnr TYPE seqnr,
child TYPE node_id,
END OF s_tree_structure
|
||
| 6 | TS_NODE_SEQUENCE | Public | See coding | 20051012 | ts_node_sequence TYPE SORTED TABLE OF s_node_sequence
WITH UNIQUE KEY seqnr
|
||
| 7 | TS_TREE_STRUCTURE | Public | See coding | 20051205 | ts_tree_structure TYPE SORTED TABLE OF s_tree_structure
WITH UNIQUE KEY parent seqnr
|
Method Signatures
Method CREATE_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_NODE | Call by reference | Type reference (TYPE) | IF_FDT_SEARCH_TREE=>NODE_ID | FDT: Node of a Decision Tree | 20051010 | |||
| 2 | IR_RESULT | Call by reference | Object reference (TYPE REF TO) | DATA | Result value assigned to node (exclusive to result ID) | 20090114 | |||
| 3 | IS_RANGE | Call by reference | Type reference (TYPE) | S_PARAM_RANGE | Implicit Range (exclusive to condition) | 20090114 | |||
| 4 | IV_CONDITION | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of condition on this node | 20051013 | |||
| 5 | IV_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | FDT: ID of a node in a tree | 20051005 | |||
| 6 | IV_RESULT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of result in case this is a result node (leaf) | 20051013 | |||
| 7 | IV_SIBLING | Call by reference | Type reference (TYPE) | NODE_ID | ID of preceding sibling node | 20051005 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051005 |
Method DELETE_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Node ID | 20051005 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051005 |
Method GET_CHILDREN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ETS_CHILD | Call by reference | Type reference (TYPE) | TS_NODE_SEQUENCE | Children with sequence | 20051103 | |||
| 2 | IV_PARENT_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Parent node | 20051103 | |||
| 3 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20051103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051103 |
Method GET_NODE_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_RESULT | Call by reference | Object reference (TYPE REF TO) | DATA | Result value assigned to node (exclusive to result ID) | 20090114 | |||
| 2 | ES_RANGE | Call by reference | Type reference (TYPE) | S_PARAM_RANGE | Implicit Range (exclusive to condition) | 20090114 | |||
| 3 | EV_CONDITION | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of condition assigned to iv_node | 20051013 | |||
| 4 | EV_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | ID of the parent node | 20051010 | |||
| 5 | EV_RESULT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of result in case that iv_node is a leaf | 20051013 | |||
| 6 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | ID of a node in a tree | 20051010 | |||
| 7 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20051010 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Insufficient Configuration | 20051010 | ||
| 2 | FDT: Invalid Input | 20051010 |
Method GET_ROOT_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_ROOT_NODE | Value transfer | Type reference (TYPE) | NODE_ID | root node of the tree | 20051005 |
Method GET_ROOT_NODE on Interface IF_FDT_SEARCH_TREE has no exception.
Method GET_TREE_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ALLOW_NO_MATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE: Returns an exception when no match was found | 20090422 | |||
| 2 | EV_EXECUTES_ACTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE: Executes action | 20081027 | |||
| 3 | EV_MULTIPLE_MATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE: Return only first found; ABAP_TRUE: All matches | 20051103 | |||
| 4 | EV_ONLY_LEAF_RESULT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE: Results can only be defined at leaf node | 20090615 | |||
| 5 | EV_QUALIFIED_MATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE: Special algorithm for tree processing | 20090615 | |||
| 6 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20051103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Insufficient Configuration | 20070804 |
Method GET_TREE_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ETS_STRUCTURE | Call by reference | Type reference (TYPE) | TS_TREE_STRUCTURE | (sub-)tree structure | 20051205 | |||
| 2 | IV_PARENT_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Parent node to allow for sub-tree selection (default: root) | 20051005 | |||
| 3 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20051005 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051005 |
Method MOVE_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NEW_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | FDT: ID of a node in a tree | 20051005 | |||
| 2 | IV_NEW_SIBLING | Call by reference | Type reference (TYPE) | NODE_ID | ID of preceding sibling node | 20051005 | |||
| 3 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Node to be moved | 20051005 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051005 |
Method SET_NODE_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_RESULT | Call by reference | Object reference (TYPE REF TO) | DATA | Result value assigned to node (exclusive to result ID) | 20090114 | |||
| 2 | IS_RANGE | Call by reference | Type reference (TYPE) | S_PARAM_RANGE | Implicit Range (exclusive to condition) | 20090114 | |||
| 3 | IV_CONDITION | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of expression assigned to iv_node | 20051013 | |||
| 4 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | ID of a node in a tree | 20051010 | |||
| 5 | IV_RESULT | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of result in case that iv_node is a leaf | 20051013 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051010 |
Method SET_TREE_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ALLOW_NO_MATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | ABAP_FALSE: Returns an exception when no match was found | 20090422 | ||
| 2 | IV_EXECUTES_ACTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | ABAP_TRUE: Executes action | 20081027 | ||
| 3 | IV_MULTIPLE_MATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | ABAP_FALSE: Return only first found; ABAP_TRUE: All matches | 20051103 | ||
| 4 | IV_ONLY_LEAF_RESULT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | ABAP_TRUE: Results can only be defined at leaf node | 20090615 | ||
| 5 | IV_QUALIFIED_MATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | ABAP_TRUE: Special algorithm for tree processing | 20090615 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20051103 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 710 |