SAP ABAP Class CL_ESH_TOS_SEARCH_RESULT (Represents the Search Result)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_AUT_OPEN_SEARCH_CLNT (Package) Open Search Client (ABAP)

Properties

Class	CL_ESH_TOS_SEARCH_RESULT
Short Description	Represents the Search Result
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_AUT_OPEN_SEARCH_CLNT	Open Search Client (ABAP)
Created	20100129	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_TOS_SEARCH_RESULT has no forward declaration.

Interfaces

Class CL_ESH_TOS_SEARCH_RESULT has no interface implemented.

Friends

Class CL_ESH_TOS_SEARCH_RESULT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LT_NAVIGATION_TARGET_RES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_NAV_TARGET			20100129
2	LT_RELATED_SEARCH_SOURCES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_REL_SEARCH_SOURCE			20100129
3	LT_RESULT_VALUES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SEARCH_ATTR			20100129
4	LV_CONNECTOR_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
5	LV_DESCRIPTION	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
6	LV_LINK	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
7	LV_TITLE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20100129
2	GET_ATTRIBUTE_VALUE	Instance method	Public	Method	Return the attribute value by ID	20100129
3	GET_ATTRIBUTE_VALUES	Instance method	Public	Method	Return the attribute values	20100129
4	GET_ATTRIBUTE_VAL_BY_CON_ID	Instance method	Public	Method	Return the attribute values by connector ID	20100129
5	GET_CONNECTOR_ID	Instance method	Public	Method	Return connector ID	20100129
6	GET_DESCRIPTION	Instance method	Public	Method	Return the description	20100129
7	GET_LINK	Instance method	Public	Method	Return the link	20100129
8	GET_NAVIGATION_TARGETS	Instance method	Public	Method	Return the navigation targets	20100129
9	GET_RELATED_SEARCH_SOURCES	Instance method	Public	Method	Return related search sources	20100129
10	GET_TITLE	Instance method	Public	Method	Return the title	20100129

Events

Class CL_ESH_TOS_SEARCH_RESULT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_NAV_TARGET	Public	See coding			20100129	BEGIN OF ty_nav_target , id_val type int4, nav_target TYPE REF TO CL_ESH_TOS_NAV_TARGET, END OF ty_nav_target
2	TY_REL_SEARCH_SOURCE	Public	See coding			20100129	BEGIN OF ty_rel_search_source , id_val type int4, rel_search_source TYPE REF TO CL_ESH_TOS_REL_SEARCH_SRC, END OF ty_rel_search_source
3	TY_SEARCH_ATTR	Public	See coding			20100129	BEGIN OF ty_search_attr , id_val type int4, search_attr TYPE REF TO CL_ESH_TOS_SEARCH_ATTR_VALUE, END OF ty_search_attr
4	TY_T_NAV_TARGET	Public	See coding			20100129	ty_t_nav_target TYPE STANDARD TABLE OF ty_nav_target with key id_val
5	TY_T_REL_SEARCH_SOURCE	Public	See coding			20100129	ty_t_rel_search_source TYPE STANDARD TABLE OF ty_rel_search_source with key id_val
6	TY_T_SEARCH_ATTR	Public	See coding			20100129	ty_t_search_attr TYPE STANDARD TABLE OF ty_search_attr with key id_val

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_NAVIGATION_TARGET_RES	Call by reference	☐	Type reference (TYPE)	TY_T_NAV_TARGET			20100129
2	Importing	IT_RELATED_SEARCH_SOURCES	Call by reference	☐	Type reference (TYPE)	TY_T_REL_SEARCH_SOURCE			20100129
3	Importing	IT_RESULT_VALUES	Call by reference	☐	Type reference (TYPE)	TY_T_SEARCH_ATTR			20100129
4	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100129
5	Importing	IV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20100129
6	Importing	IV_LINK	Call by reference	☐	Type reference (TYPE)	STRING			20100129
7	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20100129

Method CONSTRUCTOR on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_ATTRIBUTE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID_VAL	Call by reference	☐	Type reference (TYPE)	STRING			20100129
2	Returning	RO_ATTR_VALUE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_ATTR_VALUE			20100129

Method GET_ATTRIBUTE_VALUE on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_ATTRIBUTE_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ATTR_VALS	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_RESULT_ITER			20100129

Method GET_ATTRIBUTE_VALUES on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_ATTRIBUTE_VAL_BY_CON_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100129
2	Returning	RO_SEARCH_RES	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_RESULT_ITER			20100129

Method GET_ATTRIBUTE_VAL_BY_CON_ID on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_CONNECTOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONNECTOR_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_CONNECTOR_ID on class CL_ESH_TOS_SEARCH_RESULT 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)	STRING			20100129

Method GET_DESCRIPTION on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LINK	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_LINK on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_NAVIGATION_TARGETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_NAV_TARGETS	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_NAV_TARGET_ITERATOR			20100129

Method GET_NAVIGATION_TARGETS on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_RELATED_SEARCH_SOURCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_REL_SEARCH_SOURCES	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_REL_SEARCH_SRC_ITER			20100129

Method GET_RELATED_SEARCH_SOURCES on class CL_ESH_TOS_SEARCH_RESULT has no exception.

Method GET_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TITLE	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_TITLE on class CL_ESH_TOS_SEARCH_RESULT has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	730