SAP ABAP Class CL_ESH_QL_CLICK_REGISTRATOR (Logging of follow-up actions on search result list)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_QUERY_LOGGING (Package) Query Logging

Properties

Class	CL_ESH_QL_CLICK_REGISTRATOR
Short Description	Logging of follow-up actions on search result list
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_QUERY_LOGGING	Query Logging
Created	20091110	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_QL_CLICK_REGISTRATOR has no forward declaration.

Interfaces

Class CL_ESH_QL_CLICK_REGISTRATOR has no interface implemented.

Friends

Class CL_ESH_QL_CLICK_REGISTRATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_QL_CUST_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QL_CUST_CONTAINER		Query Log customizing container	20091110
2	MS_AREG	Instance attribute	Private	☐	Type reference (TYPE)	ESH_S_QL_AREG		Follow-up action registration	20091112
3	MS_AREGX	Instance attribute	Private	☐	Type reference (TYPE)	ESH_S_QL_AREGX		Follow-up action reg.: long contents (clustered)	20110223

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AREGX_GET_BYTELEN	Instance method	Private	Method	Get byte-length QLOGQ	20110223
2	DET_VOL_ADDED	Instance method	Private	Method	Determine volume added	20091202
3	GET_ACTION_FROM_URL	Instance method	Private	Method	Get action from URL	20091202
4	GET_INSTANCE	Static method	Public	Method	Get instance	20091110
5	LOG_FOLLOW_UP_ACTION	Instance method	Public	Method	Log follow-up action	20091110
6	LOG_INTERNAL	Instance method	Private	Method	Log Internally	20091110
7	PERSIST	Instance method	Private	Method	Persist	20091110
8	SET_CUSTOMIZING	Instance method	Private	Method	Set customizing	20091110

Events

Class CL_ESH_QL_CLICK_REGISTRATOR has no event.

Types

Class CL_ESH_QL_CLICK_REGISTRATOR has no local type.

Method Signatures

Method AREGX_GET_BYTELEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AREGQ_XSTRING	Call by reference	☐	Type reference (TYPE)	ESH_E_QL_AREG_ACTION_XSTRING		Query Log Content	20110223
2	Returning	RV_BYTELEN	Value transfer	☐	Type reference (TYPE)	ESH_E_QL_AREG_CONTENT_VOLUME		Query Log Content Volume	20110223

Method AREGX_GET_BYTELEN on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method DET_VOL_ADDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_AREG	Call by reference	☐	Type reference (TYPE)	ESH_S_QL_AREG		Query Log Action Reg.	20091202
2	Importing	IS_AREGX	Call by reference	☑	Type reference (TYPE)	ESH_S_QL_AREGX		Query Log Action Reg. - Cluster	20110223
3	Returning	RV_VOL_ADDED	Value transfer	☐	Type reference (TYPE)	ESH_E_QL_VOL_ADDED		Volume added (rounded to next kB)	20091202

Method DET_VOL_ADDED on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method GET_ACTION_FROM_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_QL_AREGX	Call by reference	☐	Type reference (TYPE)	ESH_S_QL_AREGX		Follow-Up Action Contents	20110223
2	Exporting	EV_ACTION	Call by reference	☐	Type reference (TYPE)	ESH_E_QL_AREG_ACTION		Follow-Up Action	20091202
3	Exporting	EV_ACTION_HASHKEY	Call by reference	☐	Type reference (TYPE)	ESH_E_QL_AREG_ACTION_HASHKEY		Follow-Up Action Hashkey	20110223
4	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL	20091202

Method GET_ACTION_FROM_URL on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_CLICK_REGISTRATOR	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_QL_CLICK_REGISTRATOR		Logging of follow-up actions on search result list	20091110

Method GET_INSTANCE on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method LOG_FOLLOW_UP_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CALLER_IP	Call by reference	☑	Type reference (TYPE)	RFCIPV6ADDR		IP Address in IPv6 Format	20091110
2	Importing	IV_CLICK_POSITION	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_RESULT_ITEM_POS		Click Position	20091216
3	Importing	IV_CONNECTOR_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091110
4	Importing	IV_INSTANCE_KEY	Call by reference	☑	Type reference (TYPE)	STRING		Selected Instance	20091110
5	Importing	IV_REFERENCING_EXEC_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Search Execution ID	20091110
6	Importing	IV_SEARCHTERMS	Call by reference	☑	Type reference (TYPE)	STRING		Search Terms	20091110
7	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL	20091110

Method LOG_FOLLOW_UP_ACTION on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method LOG_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CALLER_IP	Call by reference	☑	Type reference (TYPE)	RFCIPV6ADDR		IP Address in IPv6 Format	20091112
2	Importing	IV_CLICK_POSITION	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_RESULT_ITEM_POS		Click Position	20091216
3	Importing	IV_CONNECTOR_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091112
4	Importing	IV_INSTANCE_KEY	Call by reference	☑	Type reference (TYPE)	STRING		Selected Instance	20091112
5	Importing	IV_REFERENCING_EXEC_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Search Execution ID	20091112
6	Importing	IV_SEARCHTERMS	Call by reference	☑	Type reference (TYPE)	STRING		Search Terms	20091112
7	Importing	IV_URL	Call by reference	☑	Type reference (TYPE)	STRING		URL	20091112

Method LOG_INTERNAL on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method PERSIST Signature

Method PERSIST on class CL_ESH_QL_CLICK_REGISTRATOR has no parameter.
Method PERSIST on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

Method SET_CUSTOMIZING Signature

Method SET_CUSTOMIZING on class CL_ESH_QL_CLICK_REGISTRATOR has no parameter.
Method SET_CUSTOMIZING on class CL_ESH_QL_CLICK_REGISTRATOR has no exception.

History

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