SAP ABAP Interface IF_FDT_CATALOG (FDT: Catalog)
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_CATALOG | FDT: Catalog | 20060608 |
Properties
| Interface | IF_FDT_CATALOG | |
| Short Description | FDT: Catalog |
General Data
| Package | SFDT_CORE | BRFplus: Core |
| Created | 20060608 | SAP |
| Last changed | 20130531 | 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_CATALOG | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | IF_FDT_QUERY | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 4 | 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 | 20060608 |
Friends
Interface IF_FDT_CATALOG has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_NODE_TYPE_LEAF | Constant | Public | Type reference (TYPE) | NODE_TYPE | 'LE' | Node Type | 20060610 | |
| 2 | GC_NODE_TYPE_LINK | Constant | Public | Type reference (TYPE) | NODE_TYPE | 'LI' | Node Type | 20060610 | |
| 3 | GC_NODE_TYPE_STRUCTURE | Constant | Public | Type reference (TYPE) | NODE_TYPE | 'ST' | Node Type | 20060610 | |
| 4 | MV_CUSTOMIZING_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 5 | MV_ID | Instance attribute | Public | Attribute reference (LIKE) | 20060608 | ||||
| 6 | MV_LOCAL_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 7 | MV_MASTERDATA_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 8 | MV_OBJECT_TYPE | Instance attribute | Public | Attribute reference (LIKE) | 20071228 | ||||
| 9 | 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 | 20060608 | |
| 2 | Instance method | Public | Method | Delete a node including all his children | 20060608 | |
| 3 | Instance method | Public | Method | Get properties of the catalog | 20060610 | |
| 4 | Instance method | Public | Method | Get (sub-)catalog structure | 20060610 | |
| 5 | Instance method | Public | Method | Get the children below a given node | 20060608 | |
| 6 | Instance method | Public | Method | Get a node ID for a UUID | 20080112 | |
| 7 | Instance method | Public | Method | Get properties of a node | 20060610 | |
| 8 | Instance method | Public | Method | Returns the usages of the catalog (in catalog links) | 20071126 | |
| 9 | Instance method | Public | Method | Relocate an existing node (with subnodes) within the tree | 20060608 | |
| 10 | Instance method | Public | Method | Set properties of the catalog | 20060610 | |
| 11 | Instance method | Public | Method | Set properties of a node | 20060610 |
Events
Interface IF_FDT_CATALOG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | NODE_ID | Public | Type reference (TYPE) | FDT_NODE_ID | Node ID | 20060608 | |
| 2 | NODE_NAME | Public | Type reference (TYPE) | FDT_NODE_NAME | Node Name | 20070606 | |
| 3 | NODE_TYPE | Public | Type reference (TYPE) | FDT_NODE_TYPE | Node Type | 20060610 | |
| 4 | NODE_UUID | Public | Type reference (TYPE) | GUID_32 | Node UUID | 20080324 | |
| 5 | SEQNR | Public | Type reference (TYPE) | FDT_SEQNR | FDT: ID of a node in a tree | 20060608 | |
| 6 | S_ATTRIBUTE_VALUE | Public | See coding | Attribute value | 20060619 | BEGIN OF s_attribute_value,
id TYPE if_fdt_types=>id,
value TYPE string,
END OF s_attribute_value
|
|
| 7 | S_CATALOG_STRUCTURE | Public | See coding | Catalog structure element | 20060610 | BEGIN OF s_catalog_structure,
parent TYPE node_id,
seqnr TYPE seqnr,
node TYPE node_id,
node_type TYPE node_type,
node_name TYPE node_name,
node_exit_class TYPE classname,
node_uuid TYPE node_uuid,
node_bind_text TYPE abap_bool,
END OF s_catalog_structure
|
|
| 8 | S_LINK | Public | See coding | Link | 20060610 | BEGIN OF s_link,
catalog_id TYPE if_fdt_types=>id,
node TYPE node_id,
node_uuid TYPE node_uuid,
END OF s_link
|
|
| 9 | S_NODE_NAME | Public | See coding | OBSOLETE - DO NOT USE | 20070110 | BEGIN OF s_node_name,
langu TYPE langu,
name TYPE node_name,
END OF s_node_name
|
|
| 10 | S_NODE_SEQUENCE | Public | See coding | Node with sequence number | 20060608 | BEGIN OF s_node_sequence,
seqnr TYPE seqnr,
node TYPE node_id,
END OF s_node_sequence
|
|
| 11 | S_NODE_TEXT | Public | See coding | Node Text | 20080112 | BEGIN OF s_node_text,
langu TYPE langu,
text TYPE c LENGTH 30,
END OF s_node_text
|
|
| 12 | TS_ATTRIBUTE_VALUE | Public | See coding | Attribute values | 20060619 | ts_attribute_value TYPE SORTED TABLE OF s_attribute_value
WITH UNIQUE KEY id
|
|
| 13 | TS_CATALOG_STRUCTURE | Public | See coding | Catalog structure | 20060610 | ts_catalog_structure TYPE SORTED TABLE OF s_catalog_structure
WITH UNIQUE KEY parent seqnr
|
|
| 14 | TS_NODE_NAME | Public | See coding | OBSOLETE - DO NOT USE | 20070110 | ts_node_name TYPE SORTED TABLE OF s_node_name
WITH UNIQUE KEY langu
|
|
| 15 | TS_NODE_SEQUENCE | Public | See coding | List of nodes with sequence numbers | 20060608 | ts_node_sequence TYPE SORTED TABLE OF s_node_sequence
WITH UNIQUE KEY seqnr
|
|
| 16 | TS_NODE_TEXT | Public | See coding | Node Texts | 20080112 | ts_node_text TYPE SORTED TABLE OF s_node_text
WITH UNIQUE KEY langu
|
|
| 17 | TS_OBJECT_TYPE | Public | See coding | List of object types | 20060608 | ts_object_type TYPE SORTED TABLE OF if_fdt_types=>object_type
WITH UNIQUE DEFAULT KEY
|
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) | NODE_ID | New Node | 20060610 | |||
| 2 | IV_NODE_TYPE | Call by reference | Type reference (TYPE) | NODE_TYPE | IF_FDT_CATALOG=>GC_NODE_TYPE_STRUCTURE | Node Type | 20060620 | ||
| 3 | IV_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | Parent Node | 20060608 | |||
| 4 | IV_SIBLING | Call by reference | Type reference (TYPE) | NODE_ID | Sibling Node | 20060608 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060608 |
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 to be deleted | 20060608 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060608 |
Method GET_CATALOG_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ETS_LEAF_ATTRIBUTE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Attributes of a leaf | 20060618 | |||
| 2 | ETS_LINK_ATTRIBUTE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Attributes of a link | 20060619 | |||
| 3 | ETS_OBJECT_TYPE | Call by reference | Type reference (TYPE) | TS_OBJECT_TYPE | List of allowed object types | 20060610 | |||
| 4 | ETS_STRUCTURE_ATTRIBUTE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Attributes of a structure node | 20060618 | |||
| 5 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20060610 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060619 |
Method GET_CATALOG_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_CATALOG_STRUCTURE | Catalog structure | 20060610 | |||
| 2 | IV_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | Parent Node | 20060626 | |||
| 3 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20060610 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060610 |
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 | List of nodes with sequence number | 20060608 | |||
| 2 | IV_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | Parent Node | 20060626 | |||
| 3 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20060608 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060608 |
Method GET_NODE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_NODE_ID | Call by reference | Type reference (TYPE) | NODE_ID | Node ID | 20080112 | |||
| 2 | EV_UUID_UNKNOWN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE: not a UUID of the catalog | 20080112 | |||
| 3 | IV_NODE_UUID | Call by reference | Type reference (TYPE) | NODE_UUID | Node UUID | 20080112 | |||
| 4 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20080112 |
Method GET_NODE_ID on Interface IF_FDT_CATALOG has no exception.
Method GET_NODE_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_LINK | Call by reference | Type reference (TYPE) | S_LINK | Link | 20060610 | |||
| 2 | ETS_ATTRIBUTE_VALUE | Call by reference | Type reference (TYPE) | TS_ATTRIBUTE_VALUE | Attribute values | 20060619 | |||
| 3 | ETS_NODE_NAME | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>TS_NODE_NAME | OBSOLETE - DO NOT USE | 20080117 | |||
| 4 | ETS_NODE_TEXT | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>TS_NODE_TEXT | Node Texts(if not bound) | 20080112 | |||
| 5 | EV_NODE_BIND_TEXT | Call by reference | Type reference (TYPE) | ABAP_BOOL | True: Node Text is bound to object | 20110415 | |||
| 6 | EV_NODE_EXIT_CLASS | Call by reference | Type reference (TYPE) | CLASSNAME | Node exit classname (for texts) | 20080112 | |||
| 7 | EV_NODE_NAME | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>NODE_NAME | Node name | 20070110 | |||
| 8 | EV_NODE_TEXT | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>S_NODE_TEXT-TEXT | Node text (sy-langu, if not bound) | 20080117 | |||
| 9 | EV_NODE_TYPE | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>NODE_TYPE | Node Type | 20060610 | |||
| 10 | EV_NODE_UUID | Call by reference | Type reference (TYPE) | NODE_UUID | Node UUID | 20080112 | |||
| 11 | EV_OBJECT_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Object ID | 20060610 | |||
| 12 | EV_PARENT | Call by reference | Type reference (TYPE) | NODE_ID | Parent node | 20060610 | |||
| 13 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Node | 20060610 | |||
| 14 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20060610 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060610 |
Method GET_WHERE_USED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ETS_USAGE | Value transfer | Type reference (TYPE) | IF_FDT_TYPES=>TS_USAGE | Usages (Where-Used) | 20071126 | |||
| 2 | IS_OBJECT_CATEGORY_SEL | Call by reference | Type reference (TYPE) | IF_FDT_QUERY=>S_OBJECT_CATEGORY_SEL | Object categories | 20071126 | |||
| 3 | IV_INCL_MEMORY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | ABAP_TRUE: include unsaved changes | 20071126 |
Method GET_WHERE_USED on Interface IF_FDT_CATALOG has no exception.
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 | New Parent Node | 20060608 | |||
| 2 | IV_NEW_SIBLING | Call by reference | Type reference (TYPE) | NODE_ID | New Sibling Node | 20060608 | |||
| 3 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Node | 20060608 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060608 |
Method SET_CATALOG_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ITS_LEAF_ATTRIBUTE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Attributes of a leaf | 20060618 | |||
| 2 | ITS_LINK_ATTRIBUTE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Attributes of a link | 20060619 | |||
| 3 | ITS_OBJECT_TYPE | Call by reference | Type reference (TYPE) | TS_OBJECT_TYPE | List of allowed object types | 20060610 | |||
| 4 | ITS_STRUCTURE_ATTRIBUTE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_OBJECT_ID | Attributes of a structure node | 20060618 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060610 |
Method SET_NODE_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_LINK | Call by reference | Type reference (TYPE) | S_LINK | Link (only for leaf nodes), this or IV_OBJECT_ID | 20060610 | |||
| 2 | ITS_ATTRIBUTE_VALUE | Call by reference | Type reference (TYPE) | TS_ATTRIBUTE_VALUE | Attribute values | 20060619 | |||
| 3 | ITS_NODE_NAME | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>TS_NODE_NAME | OBSOLETE - DO NOT USE | 20070111 | |||
| 4 | ITS_NODE_TEXT | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>TS_NODE_TEXT | Node Texts(if not bound) | 20080112 | |||
| 5 | IV_NODE | Call by reference | Type reference (TYPE) | NODE_ID | Node | 20060610 | |||
| 6 | IV_NODE_BIND_TEXT | Call by reference | Type reference (TYPE) | ABAP_BOOL | True: binds the node text to object | 20110415 | |||
| 7 | IV_NODE_EXIT_CLASS | Call by reference | Type reference (TYPE) | CLASSNAME | Node exit classname (for texts) | 20080112 | |||
| 8 | IV_NODE_NAME | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>NODE_NAME | Node Name | 20070606 | |||
| 9 | IV_NODE_TEXT | Call by reference | Type reference (TYPE) | IF_FDT_CATALOG=>S_NODE_TEXT-TEXT | Node Text (sy-langu, if not bound) | 20080117 | |||
| 10 | IV_OBJECT_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Object ID (only for leaf nodes), this or IS_LINK | 20060610 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20060610 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 710 |