SAP ABAP Class CL_ESH_IF_MDATA_CATEGORY (Meta Data: Category)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE (Package) Interface

Properties

Class	CL_ESH_IF_MDATA_CATEGORY
Short Description	Meta Data: Category
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20080212	SAP
Last change	20140121	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)
2	IF_ESH_SE_RUNTIME_DATA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ESH_IF_MDATA_CATEGORY has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_IF_MDATA_CONNECTOR	☐	20090123	Metadata: Search Connector

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_CHILDREN_IDS	Instance attribute	Protected	☐	Type reference (TYPE)	T_CATEGORY_IDS			20080901
2	MT_CONNECTOR_IDS	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTORS		Metadata: Connectors	20090728
3	MT_TEMPLATE_IDS	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_MDATA_TEMPLATES		Metadata: Templates	20080904
4	MV_DESCRIPTION	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable name	20080721
5	MV_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category	20080721
6	MV_IS_AUTHORIZED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Is authorized	20100414
7	MV_IS_REPLACED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Is replaced	20130326
8	MV_IS_SEARCHABLE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Is searchable	20090122
9	MV_PARENT_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category ID	20080901
10	SC_BUFFER_MAX_ENTRIES	Constant	Private	☐	Type reference (TYPE)	INT4	500	Maximum amount of entries in connector buffer	20080721
11	SC_CATEGORY_ID_ALL	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID	'ALL_CONTENT_200811101622'	All content category ID	20080912
12	SC_CATEGORY_ID_DEFAULT	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID	'DEFAULT_CONTENT_200811101622'	Default content category ID	20080912
13	ST_CATEGORIES	Static Attribute	Private	☐	Type reference (TYPE)	LTT_CATEGORY		Category instances	20080721
14	ST_CATEGORIES_FROM_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Categories (sorted)	20080819

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COLLECT_CATEGORY_DISTANCE	Static method	Private	Method	Collect category distance for joint category list	20130709
2	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20080721
3	GET_CATEGORIES_OF_CONNECTOR	Static method	Protected	Method	Get categories of connector (not performance optimized)	20100414
4	GET_CATEGORY	Static method	Public	Method	Get category instance	20080403
5	GET_CATEGORY_IDS	Static method	Public	Method	Get category IDs	20080403
6	GET_CHILDREN	Instance method	Public	Method	Get children	20080403
7	GET_CHILDREN_IDS	Instance method	Protected	Method	Get category IDs of all levels of subcategories	20090210
8	GET_CONNECTORS	Instance method	Public	Method	Get connectors	20080904
9	GET_CONNECTOR_IDS	Instance method	Protected	Method	Get connector IDs of the category and subcategories	20090728
10	GET_DESCRIPTION	Instance method	Public	Method	Get description	20080904
11	GET_ID	Instance method	Public	Method	Get ID	20081010
12	GET_JOINT_CATEGORIES	Static method	Public	Method	Get closest categories of connectors (not perf.-optimized)	20130708
13	GET_LANGUAGES	Static method	Private	Method	Get relevant languages	20080901
14	GET_PARENT	Instance method	Public	Method	Get parent	20080403
15	GET_TEMPLATE_IDS	Instance method	Protected	Method	Get template IDs of the category and subcategories	20080904
16	HAS_PARENT	Instance method	Public	Method	Category has parent category	20090928
17	IS_AUTHORIZED	Instance method	Public	Method	Current user is authorized for category	20100414
18	IS_REPLACED	Instance method	Public	Method	All contained connectors arer replaced	20130326
19	IS_SEARCHABLE	Instance method	Public	Method	At least one searchable connector in authorized category	20090122
20	REFRESH_STATUS	Static method	Protected	Method	Refresh status on all instances	20090122

Events

Class CL_ESH_IF_MDATA_CATEGORY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LST_CATEGORY	Private	See coding			20080721	BEGIN OF lst_category, id TYPE esh_e_om_category, instance TYPE REF TO cl_esh_if_mdata_category, END OF lst_category
2	LTT_CATEGORY	Private	See coding			20080721	ltt_category TYPE SORTED TABLE OF lst_category WITH UNIQUE KEY id
3	S_CATEGORY_DIST	Protected	See coding			20130708	BEGIN OF s_category_dist, category_id TYPE esh_e_if_category_id, category TYPE REF TO cl_esh_if_mdata_category, has_all_connectors TYPE abap_bool, distance_sum TYPE i, distance_min TYPE i, connectors TYPE t_connector_dist, END OF s_category_dist
4	S_CONNECTOR_DIST	Protected	See coding			20130708	BEGIN OF s_connector_dist, connector_id TYPE esh_e_if_search_connector_id, distance TYPE i, END OF s_connector_dist
5	T_CATEGORY_DIST	Protected	See coding			20130708	t_category_dist TYPE STANDARD TABLE OF s_category_dist WITH UNIQUE SORTED KEY category_id COMPONENTS category_id WITH NON-UNIQUE SORTED KEY has_all_connectors COMPONENTS has_all_connectors
6	T_CATEGORY_IDS	Protected	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORY_IDS_SORTED		20080901
7	T_CONNECTOR_DIST	Protected	See coding			20130708	t_connector_dist TYPE SORTED TABLE OF s_connector_dist WITH UNIQUE KEY connector_id

Method Signatures

Method COLLECT_CATEGORY_DISTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CATEG_DISTANCE	Call by reference	☐	Type reference (TYPE)	T_CATEGORY_DIST			20130709
2	Importing	IO_CATEGORY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CATEGORY		Meta Data: Category	20130709
3	Importing	IV_CONNECTOR_COUNT	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20130709
4	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20130709
5	Importing	IV_DISTANCE	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20130709

Method COLLECT_CATEGORY_DISTANCE on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category	20080721

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20080721

Method GET_CATEGORIES_OF_CONNECTOR 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)	ESH_T_IF_MDATA_CATEGORY_OBJ		Meta Data: Category Objects	20100414
2	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	CHAR32		Connection GUID	20100414
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100414
4	Importing	IV_ONLY_NON_REPLACED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only with non replaced connectors	20130326
5	Importing	IV_ONLY_SEARCHABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only searchable categories	20100414

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100414

Method GET_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category	20080721
2	Returning	RO_CATEGORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CATEGORY		Meta Data: Category	20080721

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20080721

Method GET_CATEGORY_IDS 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)	ESH_T_IF_MDATA_CATEGORIES		Meta Data: Category	20080721
2	Importing	IV_ONLY_NON_REPLACED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only with non replaced connectors	20130326
3	Importing	IV_ONLY_SEARCHABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only with searchable connectors	20090122

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20080721

Method GET_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CHILD_CATEGORIES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CATEGORY_OBJ		Meta Data: Category Objects	20080904
2	Importing	IV_ALL_DEGREES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Get children of all degrees of relationship	20090210
3	Importing	IV_ONLY_NON_REPLACED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only with non replaced connectors	20130326
4	Importing	IV_ONLY_SEARCHABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only with searchable connectors	20090210

Method GET_CHILDREN on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_CHILDREN_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CHILDREN_IDS	Call by reference	☐	Type reference (TYPE)	T_CATEGORY_IDS			20090210

Method GET_CHILDREN_IDS on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_CONNECTORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTOR_OBJ		Meta Data: Connector Objects	20080904
2	Importing	IV_INCLUDE_CHILDREN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Include Connectors of Child Categories	20081110
3	Importing	IV_ONLY_NON_REPLACED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only non replaced connectors	20130326
4	Importing	IV_ONLY_SEARCHABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only searchable connectors	20090122

Method GET_CONNECTORS on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_CONNECTOR_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CONNECTOR_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTORS		Meta Data: Connectors	20090728

Method GET_CONNECTOR_IDS on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20080904

Method GET_DESCRIPTION on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Search Connector ID	20081010

Method GET_ID on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_JOINT_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)	ESH_T_IF_MDATA_CATEGORY_OBJ		Meta Data: Category Objects	20130708
2	Importing	IO_FILTER_CATEGORY	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CATEGORY		Meta Data: Category	20130708
3	Importing	IT_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTOR_OBJ		Meta Data: Connector Objects	20130708
4	Importing	IV_ONLY_NON_REPLACED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only with non replaced connectors	20130708
5	Importing	IV_ONLY_SEARCHABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Only searchable Categories	20130708

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20130708

Method GET_LANGUAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LANGUAGES	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_LANGU		Table of Languages used for Admin	20080901

Method GET_LANGUAGES on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method GET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_PARENT_CATEGORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CATEGORY		Meta Data: Category	20080901

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20080901

Method GET_TEMPLATE_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TEMPLATE_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_TEMPLATES		Meta Data: Templates	20080904

Method GET_TEMPLATE_IDS on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method HAS_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090928

Method HAS_PARENT on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method IS_AUTHORIZED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REFRESH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100414
2	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100414

Method IS_AUTHORIZED on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method IS_REPLACED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130326

Method IS_REPLACED on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method IS_SEARCHABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090122

Method IS_SEARCHABLE on class CL_ESH_IF_MDATA_CATEGORY has no exception.

Method REFRESH_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEARCHABILITY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Refresh searchability status	20090122

Method REFRESH_STATUS on class CL_ESH_IF_MDATA_CATEGORY has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	711