SAP ABAP Class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE (Metadata: Attribute Type)

Hierarchy

☛

SAP_BASIS (Software Component) SAP Basis Component
⤷

BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷

S_ESH_ENG_INTERFACE (Package) Interface

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_IF_MDATA_ATTR_ENTITY	Metadata: Attribute Entity	20091109

Properties

Class	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE
Short Description	Metadata: Attribute Type
Super Class	CL_ESH_IF_MDATA_ATTR_ENTITY	Metadata: Attribute Entity
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	CL_ESH_OM_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no interface implemented.

Friends

#	Friend	Created on	Description
1	CL_ESH_IF_MDATA_ATTR_GROUP	20091106	Metadata: Attribute Group
2	CL_ESH_IF_MDATA_COMMON_ATTR	20091210	Meta Data: Common Attribute
3	CL_ESH_IF_MDATA_CONNECTOR	20080212	Metadata: Search Connector
4	CL_ESH_IF_MDATA_REQUEST_TYPE	20080212	Metadata: Request Type

Attributes

#	Attribute	Level	Visibility	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	20091109
2	MR_ATTRIBUTE_TYPE_DATA	Instance attribute	Private	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_ATTRIBUTE_TYPE_SORTED			20090112
3	MR_CONNECTOR_DATA	Instance attribute	Private	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED			20091109
4	MV_DESCRIPTION	Instance attribute	Protected	Type reference (TYPE)	ESH_E_IF_NAME		Readable name	20080220
5	SC_CONV_EXIT_UTC_TIMESTAMP	Constant	Public	Type reference (TYPE)	ESH_E_OM_CONVEXIT	'%UTC%'	Conversion exit for UTC timestamps	20090203
6	SC_RANKING_WEIGHT_HIGH	Constant	Public	Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT	60	Ranking Weight	20121126
7	SC_RANKING_WEIGHT_LOW	Constant	Public	Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT	20	Ranking Weight	20121126
8	SC_RANKING_WEIGHT_MEDIUM	Constant	Public	Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT	40	Ranking Weight	20121126
9	SC_RANKING_WEIGHT_NO_RANKING	Constant	Public	Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT	0	Ranking Weight	20121126
10	SC_TYPE_CURRENCY	Constant	Public	Type reference (TYPE)	DYNPTYPE	'CURR'	Datatype for currency	20130404
11	SC_TYPE_CURRENCY_KEY	Constant	Public	Type reference (TYPE)	DYNPTYPE	'CUKY'	Datatype for currency key	20130404

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20080212
2	CONTAINS_TEXT	Instance method	Public	Method	Contains text	20090720
3	GET_CONVERSION_EXIT_ID	Instance method	Public	Method	Get conversion exit ID	20090114
4	GET_DOMAIN_ID	Instance method	Public	Method	Get domain name	20101005
5	GET_INSTANCE	Static method	Protected	Method	Get instance	20080212
6	GET_LENGTH	Instance method	Public	Method	Get length	20080220
7	GET_LENGTH_DECIMALS	Instance method	Public	Method	Get length (decimals)	20080305
8	GET_LENGTH_INTERNAL	Instance method	Public	Method	Get length (byte length)	20080305
9	GET_RANKING_WEIGHT	Instance method	Public	Method	Get ranking weight	20121126
10	GET_RELATED_ATTRIBUTE_TYPE	Instance method	Public	Method	Get response attribute related to current request attribute	20100218
11	GET_SEMANTIC	Instance method	Public	Method	Get attribute semantic	20090720
12	GET_SEPARATOR_SIGN	Instance method	Public	Method	Get the separator sign to be used after the attribute type	20100830
13	GET_TYPE	Instance method	Public	Method	Get type	20080220
14	GET_TYPE_INTERNAL	Instance method	Public	Method	Get type (internal type code)	20080305
15	GET_UNIT_ATTRIBUTE_TYPE	Instance method	Public	Method	Get attribute type containing the unit for this type	20130404
16	IS_AUTOCOMPLETION_SUPPORTED	Instance method	Public	Method	Autocompletion supported	20121109
17	IS_F4_HELP_SUPPORTED	Instance method	Public	Method	F4 help by search execution supported	20090119
18	IS_FILTER_CRITERION	Instance method	Public	Method	Is a filter attribute	20091008
19	IS_FREESTYLE_SEARCH_ENABLED	Instance method	Public	Method	Is enabled for freestyle search	20121026
20	IS_KEY	Instance method	Public	Method	Is a key attribute	20080313
21	IS_LOWERCASE_ALLOWED	Instance method	Public	Method	Attribute values in lowercase allowed	20080305
22	IS_SORTABLE	Instance method	Public	Method	Attribute can be used to sort search results	20090626

Events

Class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_ATTR_TYPE_ID	Public	See coding		Attribute Type ID	20090311	`BEGIN OF s_attr_type_id, id TYPE esh_e_if_attribute_entity_id, position TYPE int2, END OF s_attr_type_id`
2	T_ATTR_TYPE_IDS_SORTED	Public	See coding		Attribute Type IDs (sorted)	20090311	`t_attr_type_ids_sorted TYPE SORTED TABLE OF s_attr_type_id WITH UNIQUE KEY id WITH NON-UNIQUE SORTED KEY position COMPONENTS position`

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	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_ATTRIBUTE_TYPE_DATA	Call by reference	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_ATTRIBUTE_TYPE_SORTED		20090112
3	Importing	IR_CONNECTOR_DATA	Call by reference	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		20090113

Method CONSTRUCTOR on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method CONTAINS_TEXT 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		Attribute contains text	20090720

Method CONTAINS_TEXT on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_CONVERSION_EXIT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONVERSION_EXIT_ID	Value transfer		Type reference (TYPE)	ESH_E_OM_CONVEXIT		Conversion Exit	20090114

Method GET_CONVERSION_EXIT_ID on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_DOMAIN_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DOMAIN_ID	Value transfer		Type reference (TYPE)	DOMNAME		Domain name	20101005

Method GET_DOMAIN_ID on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	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_ATTRIBUTE_TYPE_DATA	Call by reference	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_ATTRIBUTE_TYPE_SORTED		20090112
3	Importing	IR_CONNECTOR_DATA	Call by reference	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		20090113
4	Returning	RO_ATTRIBUTE	Value transfer	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE	Meta Data: Attribute Type	20080220

Method GET_INSTANCE on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LENGTH	Value transfer		Type reference (TYPE)	DDLENG		Length (No. of Characters)	20080305

Method GET_LENGTH on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_LENGTH_DECIMALS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LENGTH_DECIMALS	Value transfer		Type reference (TYPE)	DECIMALS		Number of Decimal Places	20080305

Method GET_LENGTH_DECIMALS on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_LENGTH_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LENGTH_INTERNAL	Value transfer		Type reference (TYPE)	INTLEN		Internal Length in Bytes	20080305

Method GET_LENGTH_INTERNAL on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_RANKING_WEIGHT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RANKING_WEIGHT	Value transfer		Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT		Ranking Weight	20121126

Method GET_RANKING_WEIGHT on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_RELATED_ATTRIBUTE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ATTRIBUTE_TYPE	Value transfer		Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE		Meta Data: Attribute Type	20100218

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

Method GET_SEMANTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEMANTIC	Call by reference		Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_SEMANTIC		Attribute Semantic	20090720

Method GET_SEMANTIC on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_SEPARATOR_SIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEPARATOR_SIGN	Value transfer		Type reference (TYPE)	CHAR1		Separator Sign	20100830

Method GET_SEPARATOR_SIGN on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TYPE	Value transfer		Type reference (TYPE)	DYNPTYPE		ABAP/4 Dictionary: Screen data type for Screen Painter	20080305

Method GET_TYPE on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_TYPE_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TYPE_INTERNAL	Value transfer		Type reference (TYPE)	INTTYPE		ABAP data type (C,D,N,...)	20080305

Method GET_TYPE_INTERNAL on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method GET_UNIT_ATTRIBUTE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ATTRIBUTE_TYPE	Value transfer		Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE		Metadata: Attribute Type	20130404

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

Method IS_AUTOCOMPLETION_SUPPORTED 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			20121109

Method IS_AUTOCOMPLETION_SUPPORTED on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method IS_F4_HELP_SUPPORTED 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			20090119

Method IS_F4_HELP_SUPPORTED on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method IS_FILTER_CRITERION 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			20091008

Method IS_FILTER_CRITERION on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method IS_FREESTYLE_SEARCH_ENABLED 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			20121026

Method IS_FREESTYLE_SEARCH_ENABLED on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method IS_KEY 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			20080313

Method IS_KEY on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method IS_LOWERCASE_ALLOWED 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			20080305

Method IS_LOWERCASE_ALLOWED on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

Method IS_SORTABLE 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			20090626

Method IS_SORTABLE on class CL_ESH_IF_MDATA_ATTRIBUTE_TYPE has no exception.

History

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

Object Hierarchy

Using

Used by

Advertise Links