SAP ABAP Class CL_ESH_WS_SOC_GET (WS Proxy Wrapper: Retrievals)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_IF_WEB_SERVICES (Package) Interfaces:Encapsulation of Web Services

Properties

Class	CL_ESH_WS_SOC_GET
Short Description	WS Proxy Wrapper: Retrievals
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_IF_WEB_SERVICES	Interfaces:Encapsulation of Web Services
Created	20071029	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_WS_SOC_GET has no forward declaration.

Interfaces

Class CL_ESH_WS_SOC_GET has no interface implemented.

Friends

Class CL_ESH_WS_SOC_GET has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MS_1	Instance attribute	Private	☐	Type reference (TYPE)	STRING		ESH_WS_GET_ALL_SEARCH_OBJECT_C	20071029
2	MS_2	Instance attribute	Private	☐	Type reference (TYPE)	STRING		ESH_WS_GET_ALL_SEARCH_OBJECT_4	20071029
3	MS_3	Instance attribute	Private	☐	Type reference (TYPE)	STRING		ESH_WS_GET_ALL_SEARCH_OBJECT_2	20071029
4	MV_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	SYST-TABIX		Index of internal tables	20071029
5	MV_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20071029

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20071029
2	GET_CONNECTORS_ALL	Static method	Public	Method	getAllSearchObjectConnectors	20071029
3	GET_CONNECTOR_STATUS	Static method	Public	Method	getSearchObjectConnectorStatus	20071029
4	GET_CONNECTOR_STATUS_ALL	Static method	Public	Method	getAllSearchObjectConnectorStatus	20071029
5	GET_NEXT	Instance method	Public	Method	Get next data set	20071029
6	GET_TEMPLATE_TYPES_ALL	Static method	Public	Method	getAllSearchObjectConnectorTypes	20071029

Events

Class CL_ESH_WS_SOC_GET has no event.

Types

Class CL_ESH_WS_SOC_GET has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20071029
2	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20071029

Method CONSTRUCTOR on class CL_ESH_WS_SOC_GET has no exception.

Method GET_CONNECTORS_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGICAL_PORT_NAME	Call by reference	☑	Type reference (TYPE)	PRX_LOGICAL_PORT_NAME		Logical Port Name	20071029
2	Returning	RR_OUTPUT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_WS_SOC_GET		WS Proxy Wrapper: Retrievals	20071029

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

Method GET_CONNECTOR_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20071029
2	Exporting	EV_STATUS	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20071029
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	DATA		Search Connector ID	20071029
4	Importing	IV_LOGICAL_PORT_NAME	Call by reference	☑	Type reference (TYPE)	PRX_LOGICAL_PORT_NAME		Logical Port Name	20071029

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

Method GET_CONNECTOR_STATUS_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGICAL_PORT_NAME	Call by reference	☑	Type reference (TYPE)	PRX_LOGICAL_PORT_NAME		Logical Port Name	20071029
2	Returning	RR_OUTPUT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_WS_SOC_GET		WS Proxy Wrapper: Retrievals	20071029

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

Method GET_NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DISPLAY_NAMES	Call by reference	☐	Type reference (TYPE)	ESH_T_WS_TEXTS		Language dependent texts	20071029
2	Exporting	ET_PROPERTIES	Call by reference	☐	Type reference (TYPE)	ESH_T_WS_PROPERTIES		Properties	20071029
3	Exporting	EV_ACTIVE	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20071129
4	Exporting	EV_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20071029
5	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20071029
6	Exporting	EV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	STRING			20071029
7	Exporting	EV_STATUS	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20071029
8	Exporting	EV_TEMPLATE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20071029
9	Exporting	EV_TEMPLATE_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20071030

Method GET_NEXT on class CL_ESH_WS_SOC_GET has no exception.

Method GET_TEMPLATE_TYPES_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGICAL_PORT_NAME	Call by reference	☑	Type reference (TYPE)	PRX_LOGICAL_PORT_NAME		Logical Port Name	20071029
2	Returning	RR_OUTPUT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_WS_SOC_GET		WS Proxy Wrapper: Retrievals	20071029

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

History

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