SAP ABAP Interface IF_FOX3_STRUCT_OBJECT_FACTORY (Factory Interface for Structure Objects in FOX)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-MDG-DRF (Application Component) Data Replication Framework
⤷
FOX3 (Package) Framework for hierarchy explosion
SAP_BS_FND (Software Component) SAP Business Suite Foundation⤷
CA-MDG-DRF (Application Component) Data Replication Framework⤷
FOX3 (Package) Framework for hierarchy explosion
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FOX3_STRUCT_OBJECT_FACTORY | Factory for Instances of FOX Objects | 20100514 |
Properties
| Interface | IF_FOX3_STRUCT_OBJECT_FACTORY | |
| Short Description | Factory Interface for Structure Objects in FOX |
General Data
| Package | FOX3 | Framework for hierarchy explosion |
| Created | 20100514 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_FOX3_MSG_PARAMETER | Parameters for FOX Messages | 20100514 |
Friends
Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GI_ANCHOR | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_FACTORY_ANCHOR | Anchor to Hang Additional Functionality on Factory | 20100514 | ||
| 2 | GI_COMPONENT_PROVIDER | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_COMPONENT_PROVIDER | Interface for Dependent Components | 20100514 | ||
| 3 | GI_MESSAGE | Instance attribute | Public | Object reference (TYPE REF TO) | IF_PTU_MESSAGE | Collect Messages | 20100514 | ||
| 4 | GI_OBJECT_DATA2 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_OBJECT_DATA | Object Interface for Object Data Management | 20100514 | ||
| 5 | GI_OBJECT_STACK | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_OBJECT_STACK | Interface for Object Stack | 20100514 | ||
| 6 | GI_PARAMETERS | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_PARAMETERS | Parameters for Explosion | 20100514 | ||
| 7 | GI_PARAMETERS2 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_PARAMETERS | Explosion Parameters, Extended | 20100514 | ||
| 8 | GI_TIMING | Instance attribute | Public | Object reference (TYPE REF TO) | IF_PTU_TIMING | Log the Time Information | 20100514 | ||
| 9 | GI_VALIDITY_CONTROLLER2 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_VALIDITY_CONTROLLER | Validity Interface for FOX Objects | 20100514 | ||
| 10 | GI_VALIDITY_DATA2 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FOX3_VAL_DATA_MANAGER | Validity Management and Display | 20100514 | ||
| 11 | GO_EXCLUDED_LINK_TYPES_TABLE | Instance attribute | Public | Object reference (TYPE REF TO) | CL_FOX3_LINK_TYPES_TABLE | Save Optimized Internal Table | 20100514 | ||
| 12 | GO_INCLUDED_LINK_TYPES_TABLE | Instance attribute | Public | Object reference (TYPE REF TO) | CL_FOX3_LINK_TYPES_TABLE | Save Optimized Internal Table | 20100514 | ||
| 13 | GS_MSG_PARAMETERS | Instance attribute | Public | Attribute reference (LIKE) | 20100514 | ||||
| 14 | GV_REQUEST_ID | Instance attribute | Public | Type reference (TYPE) | FOX3_REQUEST_ID | FOX Request ID | 20100514 | ||
| 15 | GV_STRUCT_ID | Instance attribute | Public | Type reference (TYPE) | FOX3_STRUCT_DB_ID | Database ID of a FOX Cache | 20100514 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_ANCHOR |
Instance method | Public | Method | Enter Anchor of Assigned Package | 20100514 |
| 2 | CALLBACK_DONT_EXPLODE_OBJECT |
Instance method | Public | Method | Callback for Event OBJECT_CREATED: Do Not Explode Further | 20100514 |
| 3 | CALLBACK_OBJECT_NOT_RELEVANT |
Instance method | Public | Method | Callback for Event OBJECT_CREATED: Ignore | 20100514 |
| 4 | CREATE_STRUCT_OBJECT |
Instance method | Public | Method | Create New Instance or Return Existing Instance If Found | 20100514 |
| 5 | GET_KEY_EXT |
Instance method | Public | Method | Output External Key | 20100514 |
| 6 | GET_OBJECT_VALIDITY |
Instance method | Public | Method | Issue Object Status | 20100514 |
| 7 | SET_KEY_EXT |
Instance method | Public | Method | Set External Key | 20100514 |
| 8 | SET_OBJECT_VALIDITY |
Instance method | Public | Method | Set Object Status | 20100514 |
| 9 | SIMULATE_CONSTRUCTION |
Instance method | Public | Method | Utility Method for the Mass Reading of Objects | 20100514 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | FACTORY_CONSTRUCTED | Instance Event (0) |
Public (2) |
Factory Instance Formed -> Initialize Other Components | 20100514 |
| 2 | FACTORY_DELETED | Instance Event (0) |
Public (2) |
Deleting Factory | 20100514 |
| 3 | LOOKING_FOR_RELATED_OBJECTS | Instance Event (0) |
Public (2) |
Find Linked Objects | 20100514 |
| 4 | OBJECT_CREATED | Instance Event (0) |
Public (2) |
New Object Instance Formed | 20100514 |
| 5 | OBJECT_DELETED | Instance Event (0) |
Public (2) |
Deleting Object Instance | 20100514 |
Types
Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no local type.
Method Signatures
Method ADD_ANCHOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
II_ANCHOR | Call by reference | Object reference (TYPE REF TO) | IF_FOX3_FACTORY_ANCHOR | Anchor to Hang Additional Functionality on Factory | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ANCHOR_ALREADY_SET |
A Second Anchor Was Delivered | 20100514 |
Method CALLBACK_DONT_EXPLODE_OBJECT Signature
Method CALLBACK_DONT_EXPLODE_OBJECT on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | WRONG_CALL |
Do Not Call Up Method As Call Back to Event | 20100514 |
Method CALLBACK_OBJECT_NOT_RELEVANT Signature
Method CALLBACK_OBJECT_NOT_RELEVANT on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | WRONG_CALL |
Do Not Call Up Method As Call Back to Event | 20100514 |
Method CREATE_STRUCT_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EO_OBJECT | Call by reference | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 | ||
| 2 | Importing |
ID_OBJECT_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | Object-Specific Data | 20100514 | ||
| 3 | Importing |
IS_OBJECT_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJECT_KEY_S | Generic Object Key for Factory | 20100514 | ||
| 4 | Importing |
IT_TABLE_INFO | Call by reference | Type reference (TYPE) | FOX3_TABLE_INFO_T | Table Information | 20100514 | ||
| 5 | Importing |
IV_KEY_EXT | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_EXT | External Key (for IBase and ALE) | 20100514 | ||
| 6 | Importing |
IV_OBJ_VERSION | Call by reference | Type reference (TYPE) | FOX3_OBJ_VERSION | Object Version | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NO_RELEVANT_OBJECT |
Object Completed As a Result of Parameter or Similar | 20100514 |
Method GET_KEY_EXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_OBJ_KEY_EXT | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_EXT_S | External Key and Object Version | 20100514 | ||
| 2 | Importing |
II_INSTANCE | Call by reference | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 |
Method GET_KEY_EXT on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no exception.
Method GET_OBJECT_VALIDITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_VALIDITY | Call by reference | Type reference (TYPE) | FOX3_OBJECT_VALIDITY_S | Validity Attributes for Object | 20100514 | ||
| 2 | Importing |
II_INSTANCE | Call by reference | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 |
Method GET_OBJECT_VALIDITY on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no exception.
Method SET_KEY_EXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
II_INSTANCE | Call by reference | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 | ||
| 2 | Importing |
IS_OBJ_KEY_EXT | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_EXT_S | External Key and Object Version | 20100514 |
Method SET_KEY_EXT on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no exception.
Method SET_OBJECT_VALIDITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
II_INSTANCE | Call by reference | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 | ||
| 2 | Importing |
IS_VALIDITY | Call by reference | Type reference (TYPE) | FOX3_OBJECT_VALIDITY_S | Validity Attributes for Object | 20100514 |
Method SET_OBJECT_VALIDITY on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no exception.
Method SIMULATE_CONSTRUCTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_TO_BE_CONSTRUCTED | Call by reference | Type reference (TYPE) | FOX3_OBJECT_KEY_T | Generic Object Key for Factory | 20100514 | ||
| 2 | Importing |
IT_REQUESTED | Call by reference | Type reference (TYPE) | FOX3_OBJECT_KEY_T | Generic Object Key for Factory | 20100514 |
Method SIMULATE_CONSTRUCTION on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no exception.
Event Signatures
Event FACTORY_CONSTRUCTED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | II_PERSISTENCE_CONTROLLER | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_FOX3_PERSISTENCE_CONTROLLER | Control of Persistence | 20100514 |
Event FACTORY_DELETED Signature
Event FACTORY_DELETED on Interface IF_FOX3_STRUCT_OBJECT_FACTORY has no parameter.
Event LOOKING_FOR_RELATED_OBJECTS Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | II_OBJECT | Exporting | Value transfer | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 | ||
| 2 | IT_LINKED_OBJ_TO | Exporting | Value transfer | Type reference (TYPE) | FOX3_LINKED_OBJ_TO_T | Adjacent Objects | 20100514 |
Event OBJECT_CREATED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_OBJECT_KEY | Exporting | Value transfer | Type reference (TYPE) | FOX3_OBJECT_KEY_S | Generic Object Key for Factory | 20100514 |
Event OBJECT_DELETED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | II_OBJECT | Exporting | Value transfer | Type reference (TYPE) | FOX3_OBJECT | Return Object for FOX Caller | 20100514 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
