SAP ABAP Class CL_MDG_BS_SEARCH_PROVIDER_API (API for dealing with MDG search providers)

Hierarchy

☛ MDG_FND (Software Component) MDG Foundation
   ⤷ CA-MDG-AF (Application Component) Application Framework
     ⤷ USMD_CREQUEST_GENIL (Package) Change Request GenIL

Properties

Class	CL_MDG_BS_SEARCH_PROVIDER_API
Short Description	API for dealing with MDG search providers
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	USMD_CREQUEST_GENIL	Change Request GenIL
Created	20100825	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	USMD0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_MDG_BS_SEARCH_PROVIDER_API has no interface implemented.

Friends

Class CL_MDG_BS_SEARCH_PROVIDER_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ATTRIBUTE	Constant	Public	☐	See coding				20100907
2	GC_CONTROL_ATTRIBUTE	Constant	Public	☐	See coding				20100907
3	GC_STANDARD_SEARCH_METHOD	Constant	Public	☐	Type reference (TYPE)	TY_SEARCH_METHOD-METHOD	'0000'		20100825
4	GO_INSTANCE	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_MDG_BS_SEARCH_PROVIDER_API		API for dealing with MDG search providers	20100825

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	EXECUTE_SEARCH	Instance method	Public	Method	executes a search based on a specific provider/search help	20100828
2	GET_BOR_OBJECT_FOR_GENIL_COMP	Instance method	Public	Method	determines the BOR object type for the given GenIL component	20101112
3	GET_INSTANCE	Static method	Public	Method	returns the singleton reference of the API	20100825
4	GET_MAIN_ENTITY_FOR_GENIL_COMP	Instance method	Public	Method	determines the MDG main entity for the given GenIL component	20101018
5	GET_MODEL_NAME_FOR_GENIL_COMP	Instance method	Public	Method	determines the MDG model name for the given GenIL component	20100907
6	GET_PROVIDER_BY_NAME	Instance method	Public	Method	returns a reference to a search provider class	20100826
7	GET_SEARCH_ATTRIBUTES	Instance method	Public	Method	determines the list of search attributes for a provider	20100906
8	GET_SEARCH_METHODS	Instance method	Public	Method	determines a list of accepted search methods	20100825
9	GET_STANDARD_SEARCH_METHOD	Instance method	Public	Method	returns the default search-method for the given model	20101004
10	PROVIDER_NEEDS_FUZZY_FLAG	Instance method	Public	Method	returns true (X) if given provider needs fuzzy-flag	20101004
11	PROVIDER_SUPPORTS_FREE_TEXT	Instance method	Public	Method	returns true (X) if given provider supports free text	20100907
12	PROVIDER_SUPPORTS_MODEL	Instance method	Public	Method	returns true (x) if given provider supports given model	20100908

Events

Class CL_MDG_BS_SEARCH_PROVIDER_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_SEARCH_METHOD	Public	See coding			20100825	BEGIN OF ty_search_method, method(4) TYPE n, provider TYPE usmd_search_mode, search_help TYPE subshlp, text TYPE string, END OF ty_search_method
2	TY_SEARCH_METHODS	Public	See coding			20100825	ty_search_methods TYPE STANDARD TABLE OF ty_search_method

Method Signatures

Method EXECUTE_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	USMD_T_MESSAGE		Messages	20100828
2	Exporting	ET_SEARCH_RESULT	Call by reference	☐	Type reference (TYPE)	USMD_T_SEARCH_RESULT		Search for Entities: Search Results	20100828
3	Importing	IT_SEARCH_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	USMD_TS_SEL		Sorted Table: Selection Condition (Range per Field)	20100828
4	Importing	IV_DATA_MODEL	Call by reference	☐	Type reference (TYPE)	USMD_MODEL		Data Model	20100828
5	Importing	IV_ENTITY_NAME	Call by reference	☑	Type reference (TYPE)	USMD_ENTITY		Entity Type	20100907
6	Importing	IV_FUZZY_SEARCH	Call by reference	☐	Type reference (TYPE)	USMD_FLG		Financial MDM: General Indicator	20100828
7	Importing	IV_MAX_NUM_RESULTS	Call by reference	☐	Type reference (TYPE)	I			20100828
8	Importing	IV_SEARCH_HELP	Call by reference	☑	Type reference (TYPE)	SUBSHLP		Search help included in a collective search help	20100828
9	Importing	IV_SEARCH_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20100909
10	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20100828

Method EXECUTE_SEARCH on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_BOR_OBJECT_FOR_GENIL_COMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GENIL_COMPONENT_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_COMPONENT_NAME		Component Name	20101112
2	Returning	RV_BOR_OBJECT_TYPE	Value transfer	☐	Type reference (TYPE)	SWO_OBJTYP		Data Model	20101112

Method GET_BOR_OBJECT_FOR_GENIL_COMP on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME	'CL_MDG_BS_SEARCH_PROVIDER_API'	Abbreviation for Data Collection	20100825
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_MDG_BS_SEARCH_PROVIDER_API		API for dealing with MDG search providers	20100825

Method GET_INSTANCE on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_MAIN_ENTITY_FOR_GENIL_COMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GENIL_COMPONENT_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_COMPONENT_NAME		Component Name	20101018
2	Returning	RV_MAIN_ENTITY_NAME	Value transfer	☐	Type reference (TYPE)	USMD_ENTITY		name of the main entity	20101018

Method GET_MAIN_ENTITY_FOR_GENIL_COMP on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_MODEL_NAME_FOR_GENIL_COMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GENIL_COMPONENT_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_COMPONENT_NAME		Component Name	20100907
2	Returning	RV_MODEL_NAME	Value transfer	☐	Type reference (TYPE)	USMD_MODEL		Data Model	20100907

Method GET_MODEL_NAME_FOR_GENIL_COMP on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_PROVIDER_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEARCH_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20100909
2	Returning	RO_PROVIDER	Value transfer	☐	Object reference (TYPE REF TO)	IF_USMD_SEARCH_DATA		Search for Entities	20100826

Method GET_PROVIDER_BY_NAME on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_SEARCH_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	USMD_T_SEARCH_CRITERIA		Suchkriterien und deren Eigenschaften	20100906
2	Exporting	ET_SEARCH_ATTRIBUTE_PROPS	Call by reference	☐	Type reference (TYPE)	USMD_TS_SEARCH_ATTRIBUTE		zusätzliche Eigenschaften der Suchattribute	20100908
3	Importing	IV_DATA_MODEL	Call by reference	☐	Type reference (TYPE)	USMD_MODEL		Data Model	20100906
4	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20100907
5	Importing	IV_SEARCH_HELP	Call by reference	☑	Type reference (TYPE)	SUBSHLP		Search help included in a collective search help	20100906
6	Importing	IV_SEARCH_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20100909

Method GET_SEARCH_ATTRIBUTES on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_SEARCH_METHODS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_METHODS	Call by reference	☐	Type reference (TYPE)	TY_SEARCH_METHODS			20100825
2	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	USMD_MODEL		Data Model	20100825

Method GET_SEARCH_METHODS on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method GET_STANDARD_SEARCH_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PROVIDER	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20101004
2	Exporting	EV_SEARCH_HELP	Call by reference	☐	Type reference (TYPE)	SUBSHLP		Search help included in a collective search help	20101004
3	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	USMD_MODEL		Data Model	20101004

Method GET_STANDARD_SEARCH_METHOD on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method PROVIDER_NEEDS_FUZZY_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEARCH_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20101004
2	Returning	RV_NEEDS_FUZZY_FLAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		indicator: 'X' = needs fuzzy-flag (e.g. on UI)	20101004

Method PROVIDER_NEEDS_FUZZY_FLAG on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method PROVIDER_SUPPORTS_FREE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEARCH_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20100909
2	Returning	RV_SUPPORTS_FREE_TEXT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		indicator: 'X' = supports free text searches	20100907

Method PROVIDER_SUPPORTS_FREE_TEXT on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

Method PROVIDER_SUPPORTS_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	USMD_MODEL		Data Model	20100908
2	Importing	IV_SEARCH_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	USMD_SEARCH_MODE		Type of Search	20100909
3	Returning	RV_SUPPORTS_MODEL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: X = supports the given model	20100908

Method PROVIDER_SUPPORTS_MODEL on class CL_MDG_BS_SEARCH_PROVIDER_API has no exception.

History

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