SAP ABAP Class /UI2/CL_CHIP_CATALOG (CHIP 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

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/UI2/CL_CHIP_CATALOG_CACHE	/UI2/CL_CHIP_CATALOG_CACHE	20130312

Properties

Class	/UI2/CL_CHIP_CATALOG
Short Description	CHIP Catalog
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	/UI2/ABAP_PAGE_BUILDER	UI2: ABAP Pagebuilder
Created	20130313	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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

Class /UI2/CL_CHIP_CATALOG has no interface implemented.

Friends

Class /UI2/CL_CHIP_CATALOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CHIP_DEFINITIONS	Static Attribute	Protected	☐	Type reference (TYPE)	TP_T_CHIP_DEFINITION			20130313
2	CO_CHIP_CATALOG_TAG	Constant	Public	☐	Type reference (TYPE)	STRING	'WDY_CHIP_CATALOG_TAG'		20130313
3	CO_PERS_KEY	Constant	Public	☐	Type reference (TYPE)	CHAR30	'CHIP_CATALOG_FAVORITES'		20130313
4	MT_CHIP_NAMES_RECU	Static Attribute	Private	☐	See coding				20130313
5	M_CATALOG_ALL	Static Attribute	Public	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_CATALOG			20130313
6	M_CATALOG_FAVORITES	Static Attribute	Public	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_CATALOG			20130313
7	PROVIDERS	Static Attribute	Protected	☐	Type reference (TYPE)	TP_T_PROVIDER			20130313

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CHIP_DEFINITION	Static method	Private	Method		20130313
2	CHECK_AUTHORIZATION	Static method	Public	Method		20130313
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20130313
4	DELETE_CHIP_DEFINITION	Static method	Private	Method		20130313
5	DELETE_DEFINITION_FROM_BUFFER	Static method	Protected	Method		20130313
6	GET_CATALOG_ALL	Static method	Public	Method		20130313
7	GET_CATALOG_FAVORITES	Static method	Public	Method		20130313
8	GET_CHIP_DEFINITION	Static method	Public	Method		20130313
9	GET_CHIP_INFOS	Instance method	Public	Method		20130313
10	GET_CHIP_INFOS_BY_CATEGORY	Instance method	Public	Method		20130313
11	GET_CHIP_NAMES	Instance method	Public	Method		20130313
12	GET_CHIP_NAMES_FINAL	Instance method	Protected	Method		20130313
13	GET_NAME_FROM_NAME_PROVIDER	Static method	Public	Method		20130313
14	GET_NAME_PROVIDER_FROM_NAME	Static method	Public	Method		20130313
15	GET_PARAMETER_VALUES	Instance method	Public	Method		20130313
16	GET_PROVIDER	Static method	Public	Method		20130313
17	GET_PROVIDERS	Static method	Public	Method		20130313
18	GET_TIMESTAMP	Instance method	Public	Method		20130313
19	INIT_PROVIDER	Static method	Public	Method		20130313
20	RESET_CACHE	Instance method	Public	Method		20130313
21	SYNCHRONIZE_CACHE	Instance method	Public	Method		20130313

Events

Class /UI2/CL_CHIP_CATALOG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_S_CHIP_DEFINITION	Protected	See coding			20130313	BEGIN OF tp_s_chip_definition, chip_name TYPE /ui2/chip_name, chip_definition TYPE REF TO /ui2/if_chip_definition, END OF tp_s_chip_definition
2	TP_S_CHIP_INFO	Public	See coding			20130313	BEGIN OF tp_s_chip_info, chip_name TYPE /ui2/chip_name, display_name TYPE string, description TYPE string, url TYPE string, config TYPE string, icon TYPE string, author TYPE string, devclass TYPE string, createdon TYPE d, changedon TYPE d, execute_static TYPE wdy_boolean, execute_remote TYPE wdy_boolean, launcher_app TYPE string, launcher_app_config TYPE string, chip_definition_xml TYPE xstring, chip_definition_version TYPE string, END OF tp_s_chip_info
3	TP_S_CHIP_INFOS_CATEGORY	Public	See coding			20130313	BEGIN OF tp_s_chip_infos_category, parameter_value TYPE string. INCLUDE TYPE tp_s_chip_info. TYPES: END OF tp_s_chip_infos_category
4	TP_S_PROVIDER	Public	See coding			20130313	BEGIN OF tp_s_provider, provider_name TYPE /ui2/chip_provider_name, class_name TYPE seoclsname, catalog_comp TYPE /ui2/chip_component_name, display_name TYPE /ui2/chip_provider_dispname, provider TYPE REF TO /ui2/if_chip_provider, only_runtime TYPE wdy_boolean, no_cache TYPE wdy_boolean, timestamp TYPE timestamp, etag type /ui2/chip_cache_etag, END OF tp_s_provider
5	TP_T_CHIP_DEFINITION	Protected	See coding			20130313	tp_t_chip_definition TYPE HASHED TABLE OF tp_s_chip_definition WITH UNIQUE KEY chip_name
6	TP_T_CHIP_INFOS	Public	See coding			20130313	tp_t_chip_infos TYPE STANDARD TABLE OF tp_s_chip_info WITH DEFAULT KEY
7	TP_T_CHIP_INFOS_CATEGORIES	Public	See coding			20130313	tp_t_chip_infos_categories TYPE STANDARD TABLE OF tp_s_chip_infos_category
8	TP_T_PROVIDER	Public	See coding			20130313	tp_t_provider TYPE HASHED TABLE OF tp_s_provider WITH UNIQUE KEY provider_name

Method Signatures

Method ADD_CHIP_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_DEFINITION	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_DEFINITION			20130313
2	Importing	PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313

Method ADD_CHIP_DEFINITION on class /UI2/CL_CHIP_CATALOG has no exception.

Method CHECK_AUTHORIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTVT	Call by reference	☐	Type reference (TYPE)	ACTIV_AUTH			20130313
2	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME			20130313

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_NOT_AUTHORIZED	☐		20130313

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /UI2/CL_CHIP_CATALOG has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/CL_CHIP_CATALOG has no exception.

Method DELETE_CHIP_DEFINITION Signature

Method DELETE_CHIP_DEFINITION on class /UI2/CL_CHIP_CATALOG has no parameter.
Method DELETE_CHIP_DEFINITION on class /UI2/CL_CHIP_CATALOG has no exception.

Method DELETE_DEFINITION_FROM_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME			20130313

Method DELETE_DEFINITION_FROM_BUFFER on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_CATALOG_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CATALOG_ALL	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_CATALOG			20130313

Method GET_CATALOG_ALL on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_CATALOG_FAVORITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CATALOG_FAVORITES	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_CATALOG			20130313

Method GET_CATALOG_FAVORITES on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_CHIP_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHIP_DEFINITION	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_DEFINITION			20130313
2	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130313

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG_CORE	☐		20130313

Method GET_CHIP_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATALOG_FILTER	Call by reference	☑	Object reference (TYPE REF TO)	/UI2/CL_CHIP_CATALOG_FILTER			20130313
2	Importing	CHECK_AUTHORIZATION	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_TRUE		20130313
3	Returning	CHIP_INFOS	Value transfer	☐	Type reference (TYPE)	TP_T_CHIP_INFOS			20130313

Method GET_CHIP_INFOS on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_CHIP_INFOS_BY_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATALOG_FILTER	Call by reference	☑	Object reference (TYPE REF TO)	/UI2/CL_CHIP_CATALOG_FILTER			20130313
2	Importing	CATEGORIZATION_PARAMETER	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PARAMETER_NAME			20130313
3	Importing	CHECK_AUTHORIZATION	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_TRUE		20130313
4	Exporting	CHIP_INFOS_CATEGORIES	Call by reference	☐	Type reference (TYPE)	TP_T_CHIP_INFOS_CATEGORIES			20130313

Method GET_CHIP_INFOS_BY_CATEGORY on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_CHIP_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_NAME			20130313
2	Returning	CHIP_NAMES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE			20130313
3	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130313
4	Importing	HAS_INPORTS	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_HAS_PORTS			20130313
5	Importing	HAS_OUTPORTS	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_HAS_PORTS			20130313
6	Importing	PROVIDER_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313
7	Importing	TAGS	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_TAGS			20130313

Method GET_CHIP_NAMES on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_CHIP_NAMES_FINAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_NAME			20130313
2	Returning	CHIP_NAMES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE			20130313
3	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130313
4	Importing	HAS_INPORTS	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_HAS_PORTS			20130313
5	Importing	HAS_OUTPORTS	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_HAS_PORTS			20130313
6	Importing	PROVIDER_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313
7	Importing	TAGS	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_TAGS			20130313

Method GET_CHIP_NAMES_FINAL on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_NAME_FROM_NAME_PROVIDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHIP_NAME	Value transfer	☐	Type reference (TYPE)	/UI2/CHIP_NAME			20130313
2	Importing	CHIP_NAME_PROVIDER	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER			20130313
3	Importing	CHIP_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313

Method GET_NAME_FROM_NAME_PROVIDER on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_NAME_PROVIDER_FROM_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME			20130313
2	Returning	CHIP_NAME_PROVIDER	Value transfer	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER			20130313

Method GET_NAME_PROVIDER_FROM_NAME on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_PARAMETER_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARAMETER_KIND	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_PARAMETER_KIND			20130313
2	Importing	PARAMETER_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PARAMETER_NAME			20130313
3	Returning	RT_PARAMETER_VALUES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE			20130313

Method GET_PARAMETER_VALUES on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_PROVIDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PROVIDER	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PROVIDER			20130313
2	Importing	PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313

Method GET_PROVIDER on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_PROVIDERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INCLUDING_ONLY_RT	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130313
2	Importing	ONLY_NO_CACHE	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130313
3	Returning	R_PROVIDERS	Value transfer	☐	Type reference (TYPE)	TP_T_PROVIDER			20130313

Method GET_PROVIDERS on class /UI2/CL_CHIP_CATALOG has no exception.

Method GET_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROVIDER_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313
2	Returning	TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP			20130313

Method GET_TIMESTAMP on class /UI2/CL_CHIP_CATALOG has no exception.

Method INIT_PROVIDER Signature

Method INIT_PROVIDER on class /UI2/CL_CHIP_CATALOG has no parameter.
Method INIT_PROVIDER on class /UI2/CL_CHIP_CATALOG has no exception.

Method RESET_CACHE Signature

Method RESET_CACHE on class /UI2/CL_CHIP_CATALOG has no parameter.
Method RESET_CACHE on class /UI2/CL_CHIP_CATALOG has no exception.

Method SYNCHRONIZE_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROVIDER_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_PROVIDER_NAME			20130313

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_FOREIGN_LOCK	☐		20130313

History

Last changed by/on	SAP	20131127
SAP Release Created in	100