SAP ABAP Interface IF_FOX3_UTILITY_OBJECT (Additional Functions for FOX Objects (Stateless))
Hierarchy
☛
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_UTILITY_OBJECT | Basis Class for Utility Objects (Stateless) | 20100514 |
Properties
| Interface | IF_FOX3_UTILITY_OBJECT | |
| Short Description | Additional Functions for FOX Objects (Stateless) |
General Data
| Package | FOX3 | Framework for hierarchy explosion |
| Created | 20100514 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | CL_FOX3_CONSTANTS | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Interface IF_FOX3_UTILITY_OBJECT has no interface.
Friends
Interface IF_FOX3_UTILITY_OBJECT has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_NO_VERSION | Constant | Public | Type reference (TYPE) | FOX3_OBJ_VERSION | CL_FOX3_CONSTANTS=>GC_NO_VERSION | Object Version | 20100514 | |
| 2 | GV_OBJECT_TYPE | Instance attribute | Public | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Type (Such As Material or BOM) | 20100514 | ||
| 3 | GV_OBJECT_TYPE_TEXT | Instance attribute | Public | Type reference (TYPE) | FOX3_OBJ_TYPE_EXT | Text for Object Type | 20100514 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Display Object | 20100514 | |
| 2 | Instance method | Public | Method | Output Language-Dependent Description | 20100514 | |
| 3 | Instance method | Public | Method | Determine FOX Object Keys from Technical Keys | 20100514 | |
| 4 | Instance method | Public | Method | Determine External Key for Internal Key | 20100514 | |
| 5 | Instance method | Public | Method | Input Help for Corresponding GUI with Key Return | 20100514 | |
| 6 | Instance method | Public | Method | Determine Internal Key for External Key | 20100514 | |
| 7 | Instance method | Public | Method | Mass Import of Adjacent Objects | 20100514 | |
| 8 | Instance method | Public | Method | Determine Technical Key from FOX Keys | 20100514 | |
| 9 | Instance method | Public | Method | Determine Technical Object Type from FOX Object Type | 20100514 | |
| 10 | Instance method | Public | Method | Find Adjacent Objects | 20100514 |
Events
Interface IF_FOX3_UTILITY_OBJECT has no event.
Types
Interface IF_FOX3_UTILITY_OBJECT has no local type.
Method Signatures
Method DISPLAY_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ECMORDGUID | Call by reference | Type reference (TYPE) | ECMORDGUID | GUID of a Change Order | 20100514 | |||
| 2 | IV_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY | Object Key (Such As Material or BOM) | 20100514 | |||
| 3 | IV_UI_TYPE | Call by reference | Type reference (TYPE) | FOX3_UI_TYPE | CL_FOX3_CONSTANTS=>GC_UI_WIN_GUI | Type of User Interface | 20100514 | ||
| 4 | IV_VALID_FROM | Call by reference | Type reference (TYPE) | SY-DATUM | Validity Date | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | The Object Could Not Be Displayed | 20100514 | ||
| 2 | Object Not Found | 20100514 | ||
| 3 | Requested User Interface Is Not Supported | 20100514 |
Method GET_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_OBJECT_DESCRIPTION | Call by reference | Type reference (TYPE) | FOX3_OBJECT_DESCRIPTION | Language-Dependent Short Text for an Object | 20100514 | |||
| 2 | IV_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY | Object Key (Such As Material or BOM) | 20100514 | |||
| 3 | IV_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | SY-LANGU | SAP R/3 System, Current Language | 20100514 |
Method GET_DESCRIPTION on Interface IF_FOX3_UTILITY_OBJECT has no exception.
Method GET_FOX_KEY_FROM_TECH_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_FOX_OBJECT_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_VAL_T | Key | 20100514 | |||
| 2 | IT_TECHNICAL_OBJECT_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_VAL_T | Key | 20100514 | |||
| 3 | IV_FOX_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Type (Such As Material or BOM) | 20100514 | |||
| 4 | IV_TECHNICAL_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Key (Such As Material or BOM) | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Key Conversion Failed | 20100514 |
Method GET_KEY_EXT_FROM_INT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_KEY_INT_EXT | Call by reference | Type reference (TYPE) | FOX3_KEY_INT_EXT_T | Key Sorted According to Internal Key | 20100514 | |||
| 2 | IV_FILL_OBJECT_DATA | Call by reference | Type reference (TYPE) | FLAG_X | Indicator | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Key Not Found | 20100514 | ||
| 2 | No Conversion | 20100514 |
Method GET_KEY_FROM_UI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY | Object Key (Such As Material or BOM) | 20100514 | |||
| 2 | EV_KEY_EXT | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_EXT | External Object Key (Such As Material or BOM) | 20100514 | |||
| 3 | EV_OBJ_VERSION | Call by reference | Type reference (TYPE) | FOX3_OBJ_VERSION | Object version | 20100514 | |||
| 4 | IV_CHANGEABLE | Call by reference | Type reference (TYPE) | FOX3_CHANGEABLE | Changeable | 20100514 | |||
| 5 | IV_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY | Object Key (Such As Material or BOM) | 20100514 | |||
| 6 | IV_KEY_EXT | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_EXT | External Object Key (Such As Material or BOM) | 20100514 | |||
| 7 | IV_OBJ_VERSION | Call by reference | Type reference (TYPE) | FOX3_OBJ_VERSION | Object version | 20100514 | |||
| 8 | IV_UI_TYPE | Call by reference | Type reference (TYPE) | FOX3_UI_TYPE | CL_FOX3_CONSTANTS=>GC_UI_WIN_GUI | Type of User Interface | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | No Object Determined | 20100514 | ||
| 2 | Input Help Canceled | 20100514 | ||
| 3 | Requested User Interface Is Not Supported | 20100514 |
Method GET_KEY_INT_FROM_EXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_KEY_EXT_INT | Call by reference | Type reference (TYPE) | FOX3_KEY_EXT_INT_T | Key Sorted According to External Key | 20100514 | |||
| 2 | IV_FILL_OBJECT_DATA | Call by reference | Type reference (TYPE) | FLAG_X | Indicator | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | At Least One Key Not Found | 20100514 | ||
| 2 | No Conversion | 20100514 |
Method GET_OBJECTS_TO_CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_OBJECTS_TO_CREATE | Call by reference | Type reference (TYPE) | FOX3_KEY_INT_EXT_T | Object and Link Color in FOX Cache | 20100514 |
Method GET_OBJECTS_TO_CREATE on Interface IF_FOX3_UTILITY_OBJECT has no exception.
Method GET_TECH_KEY_FROM_FOX_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_TECHNICAL_OBJECT_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_VAL_T | Key | 20100514 | |||
| 2 | IT_FOX_OBJECT_KEY | Call by reference | Type reference (TYPE) | FOX3_OBJ_KEY_VAL_T | Object Key (Such As Material or BOM) | 20100514 | |||
| 3 | IV_FOX_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Key (Such As Material or BOM) | 20100514 | |||
| 4 | IV_TECHNICAL_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Type (Such As Material or BOM) | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Key Conversion Failed | 20100514 |
Method GET_TECH_OBJ_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_TECHNICAL_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Type (Such As Material or BOM) | 20100514 | |||
| 2 | IV_CALLER_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Type (Such As Material or BOM) | 20100514 | |||
| 3 | IV_FOX_OBJECT_TYPE | Call by reference | Type reference (TYPE) | FOX3_OBJ_TYPE | Object Type (Such As Material or BOM) | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Type Conversion Not Possible | 20100514 |
Method LOOK_FOR_RELATED_OBJECTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RELATED_OBJECTS | Call by reference | Type reference (TYPE) | FOX3_LINKED_CACHE_OBJECT_T | Object and Link Color in FOX Cache | 20100514 | |||
| 2 | II_FACTORY | Call by reference | Object reference (TYPE REF TO) | IF_FOX3_STRUCT_OBJECT_FACTORY | Factory Interface for Structure Objects in FOX | 20100514 | |||
| 3 | II_OBJECT_FROM | Call by reference | Type reference (TYPE) | FOX3_CACHE_OBJECT | Object in FOX Cache | 20100514 | |||
| 4 | IT_LINKED_OBJ_TO | Call by reference | Type reference (TYPE) | FOX3_LINKED_OBJ_TO_T | Adjacent Objects | 20100514 | |||
| 5 | IT_PROFILE_EXTENSION | Call by reference | Type reference (TYPE) | FOX0_EXTENSION_T | Table for Profile Extensions | 20100514 | |||
| 6 | IV_IMPLEMENTATION | Call by reference | Type reference (TYPE) | FOX0_OBJECT_IMPLEMENTATION | FOX Object Implementation | 20100514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ignore Adjacent Objects | 20100514 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 640 |