SAP ABAP Class CB_OS_EX_TREE_01 (Base Agent OS: Examples Tree 01)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ABA-LA-OBS (Application Component) Object Services
⤷
SOS_EXAMPLES (Package) Object Services: Examples
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_OS_CA_COMMON | Superclass of the Object Services Class Actors | 20001212 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CA_OS_EX_TREE_01 | Agent OS: Examples Tree 01 | 20001212 |
Properties
| Class | CB_OS_EX_TREE_01 | |
| Short Description | Base Agent OS: Examples Tree 01 | |
| Super Class | CL_OS_CA_COMMON | Superclass of the Object Services Class Actors |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 11 | Factory for Persistent Class |
| Package | SOS_EXAMPLES | Object Services: Examples |
| Created | 20001212 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CB_OS_EX_TREE_01 has no forward declaration.
Interfaces
Class CB_OS_EX_TREE_01 has no interface implemented.
Friends
Class CB_OS_EX_TREE_01 has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | Type reference (TYPE) | TYP_SPECIAL_OBJECT_INFO | Current Class-Specific Object Data | 20001212 | |||
| 2 | Instance attribute | Protected | Type reference (TYPE) | OSTYP_RT_MAP_ATT_INFO_SRT_TAB | Query: Mapping Metadata for Attributes | 20040915 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | TYP_SPECIAL_BKEY_TAB | Class-Specific: Search Table Business Keys | 20001212 | |||
| 4 | Instance attribute | Protected | Type reference (TYPE) | TYP_SPECIAL_OBJECT_INFO_TAB | Class-Specific Object Data | 20001212 | |||
| 5 | Instance attribute | Protected | Type reference (TYPE) | TYP_SPECIAL_OID_TAB | Class-Specific: Search Table OIDs | 20001212 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Generate New Persistent Object with Key | 20001212 | |
| 2 | Instance method | Public | Method | Generate Transient Object with Key | 20001212 | |
| 3 | Instance method | Public | Method | Deletes Persistent Object with Key | 20001212 | |
| 4 | Instance method | Public | Method | Get Persistent Object with Key | 20001212 | |
| 5 | Instance method | Public | Method | Get Transient Object with Key | 20001212 | |
| 6 | Instance method | Protected | Method | Extracts BKey and OID from Database Data | 20001212 | |
| 7 | Instance method | Protected | Method | Reads Persistent Attributes from Object | 20001212 | |
| 8 | Instance method | Protected | Method | Initializes Metadata Table for Attributes | 20040915 | |
| 9 | Instance method | Protected | Method | Reads Identified Object Data from the DB Based on a Filter | 20040915 | |
| 10 | Instance method | Protected | Method | Reads Object Data Identified Using OID from Database | 20001212 | |
| 11 | Instance method | Protected | Method | Reads Object Data Identified Using Bus. Key from Database | 20001212 | |
| 12 | Instance method | Protected | Method | Adds DB Data BKey and OID | 20001212 | |
| 13 | Instance method | Protected | Method | Saves Object Data in Database | 20001212 | |
| 14 | Instance method | Protected | Method | Serializes Business Key | 20001212 | |
| 15 | Instance method | Protected | Method | Sets Persistent Attributes of an Object | 20001212 | |
| 16 | Instance method | Protected | Method | Checks and Sets Persistent Attributes | 20001212 | |
| 17 | Instance method | Protected | Method | Generate New Wrapper Object and Administration Entry | 20001212 | |
| 18 | Instance method | Protected | Method | Deletes Persistent Object from Database | 20001212 | |
| 19 | Instance method | Protected | Method | Loads and Sets Persistent Attributes | 20001212 |
Events
Class CB_OS_EX_TREE_01 has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TYP_BUSINESS_KEY | Protected | See coding | Business Key | 20001212 | begin of TYP_BUSINESS_KEY ,
ID type CHAR30 ,
end of TYP_BUSINESS_KEY
|
|
| 2 | TYP_BUSINESS_KEY_TAB | Protected | See coding | TYP_BUSINESS_KEY | Table Type Object Reference | 20001212 | TYP_BUSINESS_KEY_TAB type standard table of
TYP_BUSINESS_KEY with non-unique default key
|
| 3 | TYP_DB_DATA | Protected | See coding | Line-Type Persistent Object Data | 20001212 | begin of TYP_DB_DATA ,
ID type CHAR30 ,
ROOT_OID type TYP_OID ,
ROOT_CLS type TYP_OID ,
OS_OID type TYP_OID ,
end of TYP_DB_DATA
|
|
| 4 | TYP_DB_DATA_TAB | Protected | See coding | TYP_DB_DATA | Table-Type Persistent Object Data | 20001212 | TYP_DB_DATA_TAB type standard table of
TYP_DB_DATA with non-unique default key
|
| 5 | TYP_DB_DELETE_TAB | Protected | See coding | TYP_SPECIAL_OBJECT_INFO | Table Type Identifiers to Delete | 20001212 | TYP_DB_DELETE_TAB type standard table of
TYP_SPECIAL_OBJECT_INFO with non-unique default key
|
| 6 | TYP_LPORU | Protected | Type reference (TYPE) | SIBFLPORU | Local Persistent Object Identifier Type | 20001212 | |
| 7 | TYP_OBJECT_REF | Protected | Object reference (TYPE REF TO) | CL_OS_EX_TREE_01 | Type of Managed Object | 20001212 | |
| 8 | TYP_OBJECT_REF_TAB | Protected | See coding | TYP_OBJECT_REF | Table Type Object Reference | 20001212 | TYP_OBJECT_REF_TAB type standard table of
TYP_OBJECT_REF with non-unique default key
|
| 9 | TYP_OID | Protected | Type reference (TYPE) | OS_GUID | Type of Generic Object Identifier | 20001212 | |
| 10 | TYP_OID_TAB | Protected | See coding | TYP_OID | Table Type Object Identifier | 20001212 | TYP_OID_TAB type standard table of
TYP_OID with non-unique default key
|
| 11 | TYP_SPECIAL_BKEY_TAB | Protected | See coding | TYP_SPECIAL_OBJECT_INFO | Table Type Search Table Business Keys | 20001212 | TYP_SPECIAL_BKEY_TAB type sorted table of
TYP_SPECIAL_OBJECT_INFO with unique key
BUSINESS_KEY
|
| 12 | TYP_SPECIAL_OBJECT_INFO | Protected | See coding | Line Type Class-Specific Object Data | 20001212 | begin of TYP_SPECIAL_OBJECT_INFO ,
OBJECT_ID type TYP_INTERNAL_OID ,
ID_STATUS type TYP_ID_STATUS ,
BUSINESS_KEY type TYP_BUSINESS_KEY ,
OID type TYP_OID ,
end of TYP_SPECIAL_OBJECT_INFO
|
|
| 13 | TYP_SPECIAL_OBJECT_INFO_TAB | Protected | See coding | TYP_SPECIAL_OBJECT_INFO | Table Type Class-Specific Object Data | 20001212 | TYP_SPECIAL_OBJECT_INFO_TAB type sorted table of
TYP_SPECIAL_OBJECT_INFO with unique key
OBJECT_ID
|
| 14 | TYP_SPECIAL_OID_TAB | Protected | See coding | TYP_SPECIAL_OBJECT_INFO | Table Type Search Table OIDs | 20001212 | TYP_SPECIAL_OID_TAB type sorted table of
TYP_SPECIAL_OBJECT_INFO with unique key
OID
|
| 15 | TYP_TYPE | Protected | Type reference (TYPE) | OS_GUID | Category of Type Identifier | 20010306 | |
Method Signatures
Method CREATE_PERSISTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CHAR30 | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | I_ROOT | Call by reference | Object reference (TYPE REF TO) | CL_OS_EX_NODE_01 | Persistentes Attribut | 20010306 | |||
| 3 | RESULT | Value transfer | Object reference (TYPE REF TO) | CL_OS_EX_TREE_01 | Neu erzeugtes persistentes Objekt | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method CREATE_TRANSIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CHAR30 | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | I_ROOT | Call by reference | Object reference (TYPE REF TO) | CL_OS_EX_NODE_01 | Persistentes Attribut | 20010306 | |||
| 3 | RESULT | Value transfer | Object reference (TYPE REF TO) | CL_OS_EX_TREE_01 | Neu erzeugtes transientes Objekt | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method DELETE_PERSISTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CHAR30 | Betriebswirtschaftlicher Schlüssel | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method GET_PERSISTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CHAR30 | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | RESULT | Value transfer | Object reference (TYPE REF TO) | CL_OS_EX_TREE_01 | Persistentes Objekt | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method GET_TRANSIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CHAR30 | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | RESULT | Value transfer | Object reference (TYPE REF TO) | CL_OS_EX_TREE_01 | Transientes Objekt | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method MAP_EXTRACT_IDENTIFIER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_BUSINESS_KEY | Value transfer | Type reference (TYPE) | TYP_BUSINESS_KEY | aus DB-Daten extrahierte betriebswirtsch. Schlüssel | 20001212 | |||
| 2 | E_OID | Value transfer | Type reference (TYPE) | TYP_OID | aus DB-Daten extrahierte OID | 20001212 | |||
| 3 | I_DB_DATA | Call by reference | Type reference (TYPE) | TYP_DB_DATA | Von der DB gelesene Objektdaten | 20001212 |
Method MAP_EXTRACT_IDENTIFIER on class CB_OS_EX_TREE_01 has no exception.
Method MAP_GET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_OBJECT_DATA_TAB | Value transfer | Type reference (TYPE) | TYP_DB_DATA_TAB | ausgelesene Objektdaten | 20001212 | |||
| 2 | I_OBJECT_REF_TAB | Call by reference | Type reference (TYPE) | TYP_OBJECT_REF_TAB | Liste der betroffenen Objekte | 20001212 |
Method MAP_GET_ATTRIBUTES on class CB_OS_EX_TREE_01 has no exception.
Method MAP_INITIALIZE_METADATA Signature
Method MAP_INITIALIZE_METADATA on class CB_OS_EX_TREE_01 has no parameter.
Method MAP_INITIALIZE_METADATA on class CB_OS_EX_TREE_01 has no exception.
Method MAP_LOAD_FROM_DATABASE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ORDER_BY_CLAUSE | Call by reference | Type reference (TYPE) | STRING | Order-By-Klausel | 20040915 | |||
| 2 | I_SUBCLASSES | Call by reference | Type reference (TYPE) | OS_BOOLEAN | OSCON_FALSE | Laden von Unterklassen-Instanzen | 20040915 | ||
| 3 | I_UPTO | Call by reference | Type reference (TYPE) | I | 0 | max. Anzahl von Instanzen | 20040915 | ||
| 4 | I_WHERE_CLAUSE | Call by reference | Type reference (TYPE) | STRING | Where-Klausel | 20040915 | |||
| 5 | PAR1 | Call by reference | Type reference (TYPE) | ANY | Erster Parameter für Query-Ausführung | 20040915 | |||
| 6 | PAR2 | Call by reference | Type reference (TYPE) | ANY | Zweiter Parameter für Query-Ausführung | 20040915 | |||
| 7 | PAR3 | Call by reference | Type reference (TYPE) | ANY | Dritter Parameter für Query-Ausführung | 20040915 | |||
| 8 | RESULT | Value transfer | Type reference (TYPE) | TYP_DB_DATA_TAB | von DB gelesene Objektdaten | 20040915 |
Method MAP_LOAD_FROM_DATABASE on class CB_OS_EX_TREE_01 has no exception.
Method MAP_LOAD_FROM_DATABASE_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OID_TAB | Call by reference | Type reference (TYPE) | TYP_OID_TAB | OIDs der zu ladenden Daten | 20001212 | |||
| 2 | RESULT | Value transfer | Type reference (TYPE) | TYP_DB_DATA_TAB | von DB gelesene Objektdaten | 20001212 |
Method MAP_LOAD_FROM_DATABASE_GUID on class CB_OS_EX_TREE_01 has no exception.
Method MAP_LOAD_FROM_DATABASE_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BUSINESS_KEY_TAB | Call by reference | Type reference (TYPE) | TYP_BUSINESS_KEY_TAB | Betriebswirt. Schlüssel der zu ladenden Daten | 20001212 | |||
| 2 | RESULT | Value transfer | Type reference (TYPE) | TYP_DB_DATA_TAB | von DB gelesene Objektdaten | 20001212 |
Method MAP_LOAD_FROM_DATABASE_KEY on class CB_OS_EX_TREE_01 has no exception.
Method MAP_MERGE_IDENTIFIER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_DB_DATA_TAB | Call by reference | Type reference (TYPE) | TYP_DB_DATA_TAB | Objektdaten, in die Identifikatoren zu mischen sind | 20001212 | |||
| 2 | I_BUSINESS_KEY_TAB | Call by reference | Type reference (TYPE) | TYP_BUSINESS_KEY_TAB | Liste von betriebswirtsch. Schlüsseln | 20001212 | |||
| 3 | I_OID_TAB | Call by reference | Type reference (TYPE) | TYP_OID_TAB | Liste von OIDs | 20001212 |
Method MAP_MERGE_IDENTIFIER on class CB_OS_EX_TREE_01 has no exception.
Method MAP_SAVE_TO_DATABASE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DELETES | Call by reference | Type reference (TYPE) | TYP_DB_DELETE_TAB | Schlüssel der zu löschenden Daten | 20001212 | |||
| 2 | I_INSERTS | Call by reference | Type reference (TYPE) | TYP_DB_DATA_TAB | Neu anzulegende Daten | 20001212 | |||
| 3 | I_UPDATES | Call by reference | Type reference (TYPE) | TYP_DB_DATA_TAB | Zu ändernde Daten | 20001212 |
Method MAP_SAVE_TO_DATABASE on class CB_OS_EX_TREE_01 has no exception.
Method MAP_SERIALIZE_BKEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BUSINESS_KEY | Call by reference | Type reference (TYPE) | TYP_BUSINESS_KEY | Business Key | 20001212 | |||
| 2 | RESULT | Value transfer | Type reference (TYPE) | STRING | Business Key als String | 20001212 |
Method MAP_SERIALIZE_BKEY on class CB_OS_EX_TREE_01 has no exception.
Method MAP_SET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJECT_DATA | Call by reference | Type reference (TYPE) | TYP_DB_DATA | zu setzende Objektdaten | 20001212 | |||
| 2 | I_OBJECT_REF | Call by reference | Type reference (TYPE) | TYP_OBJECT_REF | Betroffenes Objekt | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method PM_CHECK_AND_SET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BUSINESS_KEY | Call by reference | Type reference (TYPE) | TYP_BUSINESS_KEY | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | I_ID_PROVIDED | Call by reference | Type reference (TYPE) | TYP_ID_STATUS | 0 | Mit welchen Identifikatoren wurde geladen und geprüft | 20001212 | ||
| 3 | I_OBJECT_DATA | Call by reference | Type reference (TYPE) | TYP_DB_DATA | Von DB geladene Daten | 20001212 | |||
| 4 | I_OID | Call by reference | Type reference (TYPE) | TYP_OID | allgemeiner Objektidentifikator | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
Method PM_CREATE_REPRESENTANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BUSINESS_KEY | Call by reference | Type reference (TYPE) | TYP_BUSINESS_KEY | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | I_OID | Call by reference | Type reference (TYPE) | TYP_OID | allgemeiner Objektidentifikator | 20001212 | |||
| 3 | RESULT | Value transfer | Type reference (TYPE) | TYP_OBJECT_REF | Neu erzeugtes Hüllenobjekt | 20001212 |
Method PM_CREATE_REPRESENTANT on class CB_OS_EX_TREE_01 has no exception.
Method PM_DELETE_PERSISTENT Signature
Method PM_DELETE_PERSISTENT on class CB_OS_EX_TREE_01 has no parameter.
Method PM_DELETE_PERSISTENT on class CB_OS_EX_TREE_01 has no exception.
Method PM_LOAD_AND_SET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BUSINESS_KEY | Call by reference | Type reference (TYPE) | TYP_BUSINESS_KEY | Betriebswirtschaftlicher Schlüssel | 20001212 | |||
| 2 | I_OID | Call by reference | Type reference (TYPE) | TYP_OID | allgemeiner Objektidentifikator | 20001212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object Services Exception | 20010306 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 610 |