SAP ABAP Class CL_ESH_IF_MDATA_REQUEST_TYPE (Metadata: Request Type)

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_REQUEST_TYPE
Short Description	Metadata: Request Type
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	20130531	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	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ESH_IF_MDATA_REQUEST_TYPE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_IF_MDATA_COMMON_ATTR	☐	20091214	Meta Data: Common Attribute
2	CL_ESH_IF_MDATA_CONNECTOR	☐	20080212	Metadata: Search Connector

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_CONNECTOR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Metadata: Search connector	20090112
2	MR_CONNECTOR_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED			20090112
3	MR_REQUEST_TYPE_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_REQUEST_TYPE_SORTED			20090112
4	MT_COMMON_ATTRIBUTES	Instance attribute	Private	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTES		Metadata: Common attribute objects	20091210
5	MT_REQUEST_ATTRIBUTE_GROUPS	Instance attribute	Private	☐	Type reference (TYPE)	CL_ESH_IF_MDATA_ATTR_ENTITY=>T_ATTRIBUTE_ENTITIES		Metadata: Attribute group objects	20091108
6	MT_REQUEST_ATTRIBUTE_TYPES	Instance attribute	Private	☐	Type reference (TYPE)	CL_ESH_IF_MDATA_ATTR_ENTITY=>T_ATTRIBUTE_ENTITIES		Metadata: Attribute type objects	20080313
7	MV_DESCRIPTION	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable name	20080220
8	MV_IS_DEFAULT	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Is default	20081014
9	MV_REQUEST_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_OM_REQUEST		Request	20080313

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20080212
2	GET_ATTRIBUTE_ENTITIES	Instance method	Public	Method	Get request attribute entities (groups and types)	20100212
3	GET_ATTRIBUTE_GROUPS	Instance method	Public	Method	Get request type attribute groups	20091108
4	GET_ATTRIBUTE_GROUP_OBJ	Instance method	Protected	Method	Get object for request attribute group	20100212
5	GET_ATTRIBUTE_TYPE	Instance method	Public	Method	Get request type attribute	20100219
6	GET_ATTRIBUTE_TYPES	Instance method	Public	Method	Get request type attributes	20080220
7	GET_ATTRIBUTE_TYPE_IDS	Instance method	Public	Method	Get request type attribute IDs	20090311
8	GET_ATTRIBUTE_TYPE_OBJ	Instance method	Protected	Method	Get object for request attribute type	20100212
9	GET_COMMON_ATTRIBUTE	Instance method	Public	Method	Get common attribute	20100113
10	GET_COMMON_ATTRIBUTES	Instance method	Public	Method	Get common attributes	20091210
11	GET_COMMON_ATTRIBUTE_IDS	Instance method	Protected	Method	Get common attribute IDs	20091214
12	GET_DESCRIPTION	Instance method	Public	Method	Get description	20080212
13	GET_ID	Instance method	Public	Method	Get ID	20080212
14	GET_INSTANCE	Static method	Protected	Method	Get instance	20080212
15	GET_JOINT_ATTRIBUTE_TYPE_IDS	Static method	Public	Method	Get joint request attributes of compatible request types	20100222
16	GET_LANGUAGES	Static method	Private	Method	Get relevant languages	20080313
17	IS_DEFAULT	Instance method	Public	Method	Is default request type	20081014
18	IS_FOR_ATTRIBUTE_SEARCH	Instance method	Public	Method	Is relevant for attribute search	20110121
19	IS_INTERNAL	Instance method	Public	Method	Is an internal request type	20100813

Events

Class CL_ESH_IF_MDATA_REQUEST_TYPE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_COMMON_ATTRIBUTE	Private	See coding		Common Attribute	20100113	BEGIN OF s_common_attribute, id TYPE esh_e_om_comm_attr, object TYPE REF TO cl_esh_if_mdata_common_attr, END OF s_common_attribute
2	T_COMMON_ATTRIBUTES	Private	See coding		Common Attributes	20100113	t_common_attributes TYPE SORTED TABLE OF s_common_attribute WITH UNIQUE KEY id

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONNECTOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Meta Data: Search Connector	20090203
2	Importing	IR_CONNECTOR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED			20090203
3	Importing	IR_REQUEST_TYPE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_REQUEST_TYPE_SORTED			20090203

Method CONSTRUCTOR on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_ATTRIBUTE_ENTITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_ENTITIES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_ATTR_ENTITY_OBJ		Meta Data: Attribute Entity Objects	20100212

Method GET_ATTRIBUTE_ENTITIES on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_ATTRIBUTE_GROUPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_GROUPS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_ATTR_GROUPS_OBJ		Meta Data: Attribute Group Objects	20091108

Method GET_ATTRIBUTE_GROUPS on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_ATTRIBUTE_GROUP_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ATTRIBUTE_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTR_ENTITY		Meta Data: Attribute Entity	20100212
2	Exporting	EO_ATTRIBUTE_GROUP	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTR_GROUP			20100212
3	Importing	IR_ATTRIBUTE_GROUP_DATA	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_ATTR_GROUP_SORTED			20100212
4	Importing	IV_ATTRIBUTE_GROUP_ID	Call by reference	☐	Type reference (TYPE)	CHAR32		Attribute Group ID	20100212

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

Method GET_ATTRIBUTE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_TYPE_ID	Call by reference	☐	Type reference (TYPE)	CHAR32		Request Attribute Type ID	20100219
2	Returning	RO_ATTRIBUTE_TYPE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE		Meta Data: Attribute Type	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_MDATA_NO_DATA	☐	Requested Meta Data not available	20100219

Method GET_ATTRIBUTE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_TYPES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ		Meta Data: Attribute Type Objects	20080220

Method GET_ATTRIBUTE_TYPES on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_ATTRIBUTE_TYPE_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_TYPE_IDS	Call by reference	☐	Type reference (TYPE)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>T_ATTR_TYPE_IDS_SORTED		Attribute Type IDs (sorted)	20090311
2	Importing	IV_ONLY_FILTER_CRITERION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only Attribute Types usable as filter criterion	20110916
3	Importing	IV_ONLY_SORTABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only sortable Attribute Types	20110916

Method GET_ATTRIBUTE_TYPE_IDS on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_ATTRIBUTE_TYPE_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ATTRIBUTE_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTR_ENTITY		Meta Data: Attribute Entity	20100212
2	Exporting	EO_ATTRIBUTE_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE		Meta Data: Attribute Type	20100212
3	Importing	IR_ATTRIBUTE_TYPE_DATA	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_ATTRIBUTE_TYPE_SORTED			20100212
4	Importing	IV_ATTRIBUTE_TYPE_ID	Call by reference	☐	Type reference (TYPE)	CHAR32		Attribute Type ID	20100212

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

Method GET_COMMON_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMMON_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_COMMON_ATTRIBUTE_ID		Common Attribute ID	20100113
2	Returning	RO_COMMON_ATTRIBUTE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_COMMON_ATTR		Meta Data: Common Attribute	20100113

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

Method GET_COMMON_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMON_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_COMMON_ATTR_OBJ		Meta Data: Common Attribute Objects	20091210

Method GET_COMMON_ATTRIBUTES on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_COMMON_ATTRIBUTE_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMON_ATTRIBUTE_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_COMMON_ATTR_IDS		Meta Data: Common Attribute IDs	20091214
2	Importing	IV_ONLY_FILTER_CRITERION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only Common Attributes usable as filter criterion	20110916
3	Importing	IV_ONLY_SORTABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only sortable Common Attributes	20100218

Method GET_COMMON_ATTRIBUTE_IDS on class CL_ESH_IF_MDATA_REQUEST_TYPE 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	20080220

Method GET_DESCRIPTION on class CL_ESH_IF_MDATA_REQUEST_TYPE 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_CON_REQUEST_TYPE_ID		Request Type ID	20080220

Method GET_ID on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONNECTOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Meta Data: Search Connector	20090112
2	Importing	IR_CONNECTOR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED			20090112
3	Importing	IR_REQUEST_TYPE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_REQUEST_TYPE_SORTED			20090112
4	Returning	RO_REQUEST_TYPE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_REQUEST_TYPE		Meta Data: Request Type	20080313

Method GET_INSTANCE on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method GET_JOINT_ATTRIBUTE_TYPE_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_TYPE_IDS	Call by reference	☐	Type reference (TYPE)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>T_ATTR_TYPE_IDS_SORTED		Attribute Type IDs (sorted)	20100222
2	Importing	IT_REQUEST_TYPES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_REQUEST_TY_OBJ2		Meta Data: Request Type Objects	20100222
3	Importing	IV_ONLY_FILTER_CRITERION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only Attribute Types usable as filter criterion	20110916
4	Importing	IV_ONLY_SORTABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Only sortable Attribute Types	20110916

Method GET_JOINT_ATTRIBUTE_TYPE_IDS on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

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	20080313

Method GET_LANGUAGES on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method IS_DEFAULT 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			20081014

Method IS_DEFAULT on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method IS_FOR_ATTRIBUTE_SEARCH 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			20110121

Method IS_FOR_ATTRIBUTE_SEARCH on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

Method IS_INTERNAL 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			20100813

Method IS_INTERNAL on class CL_ESH_IF_MDATA_REQUEST_TYPE has no exception.

History

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