SAP ABAP Interface /UI2/IF_CATALOG (UI2:Catalog)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/ABAP_PAGE_BUILDER (Package) UI2: ABAP Pagebuilder
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-INT-BE (Application Component) Backend Enablement⤷
/UI2/ABAP_PAGE_BUILDER (Package) UI2: ABAP Pagebuilder
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_CATALOG | UI2: Catalog (abstract) | 20130617 |
Properties
| Interface | /UI2/IF_CATALOG | |
| Short Description | UI2:Catalog |
General Data
| Package | /UI2/ABAP_PAGE_BUILDER | UI2: ABAP Pagebuilder |
| Created | 20130416 | SAP |
| Last changed | 20141121 | |
| 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) |
Interfaces
Interface /UI2/IF_CATALOG has no interface.
Friends
Interface /UI2/IF_CATALOG has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ID | Instance attribute | Public | Type reference (TYPE) | STRING | 20130613 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLONE |
Instance method | Public | Method | create clone | 20140203 |
| 2 | EXISTS |
Instance method | Public | Method | Check: Does catalog exist? | 20140128 |
| 3 | GET_BASE_URL |
Instance method | Public | Method | Property 'baseUrl' of oData catalog entity | 20140116 |
| 4 | GET_CATALOG_ID |
Instance method | Public | Method | Property 'id' of oData catalog entity | 20130618 |
| 5 | GET_CHIP |
Instance method | Public | Method | Metadata of a single CHIP contained in the Catalog | 20130910 |
| 6 | GET_CHIPS |
Instance method | Public | Method | Metadata of CHIPs contained in the Catalog | 20130701 |
| 7 | GET_CHIP_COUNT |
Instance method | Public | Method | Number of CHIPs in Catalog | 20140630 |
| 8 | GET_CHIP_REF |
Instance method | Public | Method | CHIP Object | 20131108 |
| 9 | GET_DOMAIN_ID |
Instance method | Public | Method | Property 'domainId' of oData catalog entity | 20140205 |
| 10 | GET_OUTDATED |
Instance method | Public | Method | Property 'outdated' of oData catalog_entity | 20140205 |
| 11 | GET_REMOTE_ID |
Instance method | Public | Method | Property 'remoteId' of oData catalog entity | 20130618 |
| 12 | GET_REMOTE_TYPE |
Instance method | Public | Method | Property 'remoteType' of oData catalog entity | 20140127 |
| 13 | GET_SYSTEM_ALIAS |
Instance method | Public | Method | Property 'baseUrl' of oData catalog entity | 20140205 |
| 14 | GET_TITLE |
Instance method | Public | Method | Property 'title' of oData catalog entity | 20130617 |
| 15 | GET_TYPE |
Instance method | Public | Method | Property 'type' of oData catalog entity | 20130618 |
| 16 | INIT |
Instance method | Public | Method | perform initial actions | 20130618 |
| 17 | IS_REMOTE |
Instance method | Public | Method | Flag: CHIP metadata to be collected in a remote system | 20130617 |
Events
Interface /UI2/IF_CATALOG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TP_S_CHIP | Public | See coding | 20130701 | begin of tp_s_chip,
id type string,
title type string,
description type string,
config type string,
url type string,
base_chip_id type string,
catalog_id type string,
ref_chip_id type string,
catalog_page_usage_id type string,
end of tp_s_chip
|
||
| 2 | TP_T_CHIP | Public | See coding | 20130701 | tp_t_chip type HASHED TABLE OF tp_s_chip with unique key id
|
Method Signatures
Method CLONE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
TARGET_CATALOG | Value transfer | Object reference (TYPE REF TO) | /UI2/IF_CATALOG | UI2: Catalog | 20140203 | ||
| 2 |  Importing |
TARGET_ID | Call by reference | Type reference (TYPE) | STRING | 20140203 | |||
| 3 | Importing |
TITLE | Call by reference | Type reference (TYPE) | STRING | 20140205 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20140203 |
Method EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20140128 |
Method EXISTS on Interface /UI2/IF_CATALOG has no exception.
Method GET_BASE_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
BASE_URL | Value transfer | Type reference (TYPE) | STRING | 20140116 |
Method GET_BASE_URL on Interface /UI2/IF_CATALOG has no exception.
Method GET_CATALOG_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CATALOG_ID | Value transfer | Type reference (TYPE) | STRING | 20130618 |
Method GET_CATALOG_ID on Interface /UI2/IF_CATALOG has no exception.
Method GET_CHIP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CHIP_ID | Call by reference | Type reference (TYPE) | STRING | 20130910 | |||
| 2 | Returning |
CHIP_PROPERTIES | Value transfer | Type reference (TYPE) | TP_S_CHIP | 20130910 |
Method GET_CHIP on Interface /UI2/IF_CATALOG has no exception.
Method GET_CHIPS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CHIPS | Value transfer | Type reference (TYPE) | TP_T_CHIP | Table of Strings | 20130701 |
Method GET_CHIPS on Interface /UI2/IF_CATALOG has no exception.
Method GET_CHIP_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CHIP_COUNT | Value transfer | Type reference (TYPE) | I | 20140630 |
Method GET_CHIP_COUNT on Interface /UI2/IF_CATALOG has no exception.
Method GET_CHIP_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CHIP | Value transfer | Object reference (TYPE REF TO) | /UI2/IF_CHIP_DEF | UI2: CHIP definition | 20131108 | ||
| 2 | Importing |
CHIP_ID | Call by reference | Type reference (TYPE) | STRING | 20131108 |
Method GET_CHIP_REF on Interface /UI2/IF_CATALOG has no exception.
Method GET_DOMAIN_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DOMAIN_ID | Value transfer | Type reference (TYPE) | STRING | 20140205 |
Method GET_DOMAIN_ID on Interface /UI2/IF_CATALOG has no exception.
Method GET_OUTDATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
OUTDATED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20140205 |
Method GET_OUTDATED on Interface /UI2/IF_CATALOG has no exception.
Method GET_REMOTE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
REMOTE_ID | Value transfer | Type reference (TYPE) | STRING | 20130618 |
Method GET_REMOTE_ID on Interface /UI2/IF_CATALOG has no exception.
Method GET_REMOTE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
REMOTE_TYPE | Value transfer | Type reference (TYPE) | STRING | 20140127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_CHIP_CATALOG_CORE |
Error Class for CHIP Catalog | 20140430 |
Method GET_SYSTEM_ALIAS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
SYSTEM_ALIAS | Value transfer | Type reference (TYPE) | STRING | 20140205 |
Method GET_SYSTEM_ALIAS on Interface /UI2/IF_CATALOG has no exception.
Method GET_TITLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
TITLE | Value transfer | Type reference (TYPE) | STRING | 20130617 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_CHIP_CATALOG_CORE |
Error Class for CHIP Catalog | 20131203 |
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
TYPE | Value transfer | Type reference (TYPE) | STRING | 20130618 |
Method GET_TYPE on Interface /UI2/IF_CATALOG has no exception.
Method INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CATALOG_ID | Call by reference | Type reference (TYPE) | /UI2/CATALOG_ID | UI2: ID of a Catalog | 20130618 | ||
| 2 | Importing |
SCOPE | Call by reference | Type reference (TYPE) | STRING | 20130923 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_CHIP_CATALOG_CORE |
UI2 Exception for data provider | 20130620 |
Method IS_REMOTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
IS_REMOTE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20130617 |
Method IS_REMOTE on Interface /UI2/IF_CATALOG has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 100 |
