SAP ABAP Class /UI2/CL_CATALOG_REMOTE (UI2: Remote Catalog)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/SERVICES_PB_CAT_PROV_700 (Package) Catalog Provider
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | /UI2/CL_CATALOG | UI2: Catalog (abstract) | 20140121 |
Properties
| Class | /UI2/CL_CATALOG_REMOTE | |
| Short Description | UI2: Remote Catalog | |
| Super Class | /UI2/CL_CATALOG | UI2: Catalog (abstract) |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /UI2/SERVICES_PB_CAT_PROV_700 | Catalog Provider |
| Created | 20140121 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 3 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 4 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 5 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /UI2/CL_CATALOG_REMOTE has no interface implemented.
Friends
Class /UI2/CL_CATALOG_REMOTE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | STRING | 'REMOTE' | Type | 20140122 | ||
| 2 | Static Attribute | Public | Type reference (TYPE) | CHAR30 | '/UI2/REMOTE_CATALOG' | Web Dynpro: Component Name | 20140123 | ||
| 3 | Instance attribute | Private | Object reference (TYPE REF TO) | /UI2/CL_CHIP_CATALOG_FILTER | Selections in the CHIP Catalog | 20140121 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | /UI2/S_EDM_PB_CATALOG | EDM structure: Entity Catalog | 20140123 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | /UI2/S_EDM_PB_PAGE | EDM structure: Entity Page | 20140121 | |||
| 6 | Instance attribute | Private | Type reference (TYPE) | /UI2/IF_CATALOG=>TP_T_CHIP | 20140121 | ||||
| 7 | Static Attribute | Private | See coding | 20140121 | |||||
| 8 | Static Attribute | Private | Type reference (TYPE) | TP_T_CHIP_INFO | Single-Character Flag | 20140121 | |||
| 9 | Instance attribute | Private | Type reference (TYPE) | /UI2/IF_EDM_MP_PAGEBUILDER=>TP_T_PAGE_GADGET_USAGE | 20140121 | ||||
| 10 | Instance attribute | Private | Type reference (TYPE) | TP_T_WD_USAGE | Single-Character Flag | 20140121 | |||
| 11 | Instance attribute | Private | Object reference (TYPE REF TO) | /UI2/CX_CHIP_CATALOG_CORE | Error Class for CHIP Catalog | 20140121 | |||
| 12 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | 20140502 | ||||
| 13 | Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | 20140121 | ||||
| 14 | Instance attribute | Private | Object reference (TYPE REF TO) | /UI2/IF_WD_CFG_TOOL_COCU | TYPE REF TO | 20140123 | |||
| 15 | Instance attribute | Private | Object reference (TYPE REF TO) | /UI2/IF_WD_CFG_TOOL_COMP | API configuration component | 20140123 | |||
| 16 | Instance attribute | Private | Object reference (TYPE REF TO) | /UI2/CL_WD_CFG_FACTORY | Factory class for configuration API | 20140123 | |||
| 17 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | 20140121 | ||||
| 18 | Instance attribute | Private | Type reference (TYPE) | /UI2/IF_WD_CFG_TOOL_BASE=>MESSAGES | 20140502 | ||||
| 19 | Instance attribute | Protected | Type reference (TYPE) | STRING | 20140121 | ||||
| 20 | Instance attribute | Protected | Type reference (TYPE) | STRING | 20140121 | ||||
| 21 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | 20140121 | ||||
| 22 | Instance attribute | Private | Object reference (TYPE REF TO) | /UI2/IF_WD_CFG_TOOL | EDM Persistency: WD Tool | 20140121 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | 20140121 | ||
| 2 | Instance method | Private | Method | Get WD-Config API | 20140123 | |
| 3 | Instance method | Private | Method | Get Key-Tab | 20140123 | |
| 4 | Instance method | Private | Event handling method | 20140502 | ||
| 5 | Instance method | Private | Event handling method | 20140502 | ||
| 6 | Instance method | Public | Method | 20140123 | ||
| 7 | Instance method | Private | Method | 20140121 | ||
| 8 | Instance method | Private | Method | 20140121 | ||
| 9 | Instance method | Private | Method | 20140121 | ||
| 10 | Instance method | Private | Method | 20140121 | ||
| 11 | Instance method | Private | Method | 20140121 |
Events
Class /UI2/CL_CATALOG_REMOTE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TP_T_CHIP_INFO | Private | See coding | 20140121 | TP_T_CHIP_INFO type HASHED TABLE OF /ui2/cl_chip_catalog=>tp_s_chip_info
with UNIQUE KEY chip_name
|
||
| 2 | TP_T_WD_USAGE | Private | See coding | 20140121 | TP_T_WD_USAGE type HASHED TABLE OF /UI2/S_EDM_PB_GADGET_USAGE
with UNIQUE key usage_id
|
||
| 3 | T_CHIP_FILTER | Public | See coding | 20140121 | BEGIN OF t_chip_filter,
filter TYPE REF TO /ui2/cl_chip_catalog_filter,
chip_info TYPE /ui2/cl_chip_catalog=>tp_t_chip_infos,
END OF t_chip_filter
|
Method Signatures
Method GET_CHIP_ID_WO_SCOPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHIP_ID | Call by reference | Type reference (TYPE) | STRING | 20140121 | ||||
| 2 | CHIP_ID_WO_SCOPE | Value transfer | Type reference (TYPE) | STRING | 20140121 |
Method GET_CHIP_ID_WO_SCOPE on class /UI2/CL_CATALOG_REMOTE has no exception.
Method GET_CONFIG_API Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CATALOG_ID | Call by reference | Type reference (TYPE) | STRING | 20140123 | ||||
| 2 | E_COCU_API | Call by reference | Object reference (TYPE REF TO) | /UI2/IF_WD_CFG_TOOL_COCU | API Configuration Component Customizing | 20140124 | |||
| 3 | E_COMP_API | Call by reference | Object reference (TYPE REF TO) | /UI2/IF_WD_CFG_TOOL_COMP | API configuration component | 20140123 | |||
| 4 | E_COMP_FACTORY | Call by reference | Object reference (TYPE REF TO) | /UI2/CL_WD_CFG_FACTORY | Factory class for configuration API | 20140123 | |||
| 5 | READ_ONLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | 20140826 | |||
| 6 | SCOPE | Call by reference | Type reference (TYPE) | STRING | 20140123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | UI2 Exception for data provider | 20140123 | ||
| 2 | Exceptions of Configuration-API | 20140123 |
Method GET_KEY_TAB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CATALOG_ID | Call by reference | Type reference (TYPE) | STRING | 20140123 | ||||
| 2 | KEY_TAB | Call by reference | Type reference (TYPE) | /UI2/T_EDM_NVP | EDM: Name Value Pair (Structure) | 20140123 |
Method GET_KEY_TAB on class /UI2/CL_CATALOG_REMOTE has no exception.
Method ON_ACTION_CANCELLED Signature
Method ON_ACTION_CANCELLED on class /UI2/CL_CATALOG_REMOTE has no parameter.
Method ON_ACTION_CANCELLED on class /UI2/CL_CATALOG_REMOTE has no exception.
Method ON_MESSAGES_SENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MESSAGES | Call by reference | Attribute reference (LIKE) | 20140502 |
Method ON_MESSAGES_SENT on class /UI2/CL_CATALOG_REMOTE has no exception.
Method SET_CATALOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CATALOG | Call by reference | Type reference (TYPE) | /UI2/S_EDM_PB_CATALOG | EDM structure: Entity Catalog | 20140123 | |||
| 2 | NEW | Call by reference | Type reference (TYPE) | WDY_BOOLEAN | Supplement for True Boolean Type: 'X' == True '' == False | 20140128 | |||
| 3 | SCOPE | Call by reference | Type reference (TYPE) | STRING | 20140128 | ||||
| 4 | UPDATE | Call by reference | Type reference (TYPE) | WDY_BOOLEAN | Supplement for True Boolean Type: 'X' == True '' == False | 20140826 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | UI2 Exception for data provider | 20140129 | ||
| 2 | Exceptions of Configuration-API | 20140128 | ||
| 3 | Exception Class of Personalization | 20140128 |
Method _COMPARE_FILTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILTER_1 | Value transfer | Object reference (TYPE REF TO) | /UI2/CL_CHIP_CATALOG_FILTER | Selections in the CHIP Catalog | 20140121 | |||
| 2 | FILTER_2 | Value transfer | Object reference (TYPE REF TO) | /UI2/CL_CHIP_CATALOG_FILTER | Selections in the CHIP Catalog | 20140121 | |||
| 3 | RV_IS_EQUAL | Value transfer | Type reference (TYPE) | /UI2/BOOLEAN | Boolean | 20140121 |
Method _COMPARE_FILTER on class /UI2/CL_CATALOG_REMOTE has no exception.
Method _GET_CHIP_INFOS Signature
Method _GET_CHIP_INFOS on class /UI2/CL_CATALOG_REMOTE has no parameter.
Method _GET_CHIP_INFOS on class /UI2/CL_CATALOG_REMOTE has no exception.
Method _GET_FILTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILTER | Value transfer | Object reference (TYPE REF TO) | /UI2/CL_CHIP_CATALOG_FILTER | Selections in the CHIP Catalog | 20140121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | UI2 Exception for data provider | 20140121 |
Method _GET_INSTANCES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | INSTANCES | Value transfer | Type reference (TYPE) | /UI2/IF_EDM_MP_PAGEBUILDER=>TP_T_PAGE_GADGET_USAGE | 20140121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | UI2 Exception for data provider | 20140121 |
Method _GET_WD_CONFIG_DATA Signature
Method _GET_WD_CONFIG_DATA on class /UI2/CL_CATALOG_REMOTE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | UI2 Exception for data provider | 20140121 |
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |