SAP ABAP Class /BCV/CL_UIF_CHIP_CATALOG (Support Chip Catalog Methods)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-BCV (Application Component) Business Context Viewer
     ⤷ /BCV/UIF (Package) BCV User Interface Layer

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_INTERFACE	Tag Interface for BAdIs	20090319
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CHIPS_CHECK_AUTHORIZATION	BAdI Interface: CHIPS_CHECK_AUTHORIZATION	20090319

Properties

Class	/BCV/CL_UIF_CHIP_CATALOG
Short Description	Support Chip Catalog Methods
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/BCV/UIF	BCV User Interface Layer
Created	20090224	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /BCV/CL_UIF_CHIP_CATALOG has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20090319
2	IF_CHIPS_CHECK_AUTHORIZATION	☐	☐	BAdI Interface: CHIPS_CHECK_AUTHORIZATION	20090319

Friends

Class /BCV/CL_UIF_CHIP_CATALOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_BCV_CHIP_PROVIDER	Constant	Public	☐	Type reference (TYPE)	STRING	'X-SAP-BCV-CHIP'	BCV CHIP Provider	20120323
2	GC_TAG_CATALOG_CATEGORIES	Constant	Public	☐	Type reference (TYPE)	WDY_TAG_NAME	'CATALOG_CATEGORIZATION_SERIALIZED'	Name of 'Catalog Categories' Tag	20120410
3	GC_TAG_CATALOG_FILTER	Constant	Public	☐	Type reference (TYPE)	WDY_TAG_NAME	'CATALOG_FILTER_SERIALIZED'	Name of 'Catalog Filter' Tag	20120410
4	GV_CONTEXT_KEY	Static Attribute	Public	☐	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20090320
5	MT_CATEGORIES	Instance attribute	Private	☐	Type reference (TYPE)	TP_T_CATEGORIES		Categories	20090226
6	M_PARAMETER_KIND	Instance attribute	Public	☐	Type reference (TYPE)	CHIP_PARAMETER_KIND			20090226
7	M_PARAMETER_NAME	Instance attribute	Public	☐	Type reference (TYPE)	CHIP_PARAMETER_NAME			20090226

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DEFINE_CATALOG	Static method	Public	Method	Define CHIP Catalog	20120323
2	GET_CATEGORIES	Instance method	Public	Method	Returns Categories	20090226
3	GET_CONTEXT_KEY	Instance method	Public	Method	Get Context Key	20090320
4	SET_CATEGORIES	Instance method	Public	Method	Set Categories	20090226
5	SET_CONTEXT_KEY	Instance method	Public	Method	Set Context Key	20090320

Events

Class /BCV/CL_UIF_CHIP_CATALOG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_S_CATEGORY	Public	See coding			20090226	BEGIN OF tp_s_category, parameter_value TYPE chip_parameter_value, display_name TYPE chip_display_name, description TYPE chip_description, icon TYPE icon_d, END OF tp_s_category
2	TP_T_CATEGORIES	Public	See coding			20090226	tp_t_categories TYPE HASHED TABLE OF tp_s_category WITH UNIQUE KEY parameter_value

Method Signatures

Method DEFINE_CATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_API_COMP	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT		Web Dynpro: Component	20120323
2	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Reference to Controller Context	20120323
3	Importing	IO_MESSAGES	Call by reference	☑	Object reference (TYPE REF TO)	/BCV/CL_UIF_MESSAGES		Class to Store Messages	20120323
4	Importing	IV_CONTEXT_KEY	Call by reference	☐	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20120323
5	Importing	IV_CTXTP_CATEG_SER	Call by reference	☐	Type reference (TYPE)	STRING		Context Path of Serialized Categorization	20120323
6	Importing	IV_CTXTP_CONTEXT_KEY	Call by reference	☐	Type reference (TYPE)	STRING		Context Path of Context Key	20120323
7	Importing	IV_CTXTP_FILTER_SER	Call by reference	☐	Type reference (TYPE)	STRING		Context Path of Serialized Filter	20120323

Method DEFINE_CATALOG on class /BCV/CL_UIF_CHIP_CATALOG has no exception.

Method GET_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORIES	Call by reference	☐	Type reference (TYPE)	TP_T_CATEGORIES			20090226

Method GET_CATEGORIES on class /BCV/CL_UIF_CHIP_CATALOG has no exception.

Method GET_CONTEXT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTEXT_KEY	Call by reference	☐	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20090320

Method GET_CONTEXT_KEY on class /BCV/CL_UIF_CHIP_CATALOG has no exception.

Method SET_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CATEGORIES	Call by reference	☐	Type reference (TYPE)	TP_T_CATEGORIES			20090226

Method SET_CATEGORIES on class /BCV/CL_UIF_CHIP_CATALOG has no exception.

Method SET_CONTEXT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_KEY	Call by reference	☐	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20090320

Method SET_CONTEXT_KEY on class /BCV/CL_UIF_CHIP_CATALOG has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	702