SAP ABAP Class CL_ESH_SE_SNAP_CONTROLLER (Snapshot Controller)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_SEARCH (Package) Search (internal)

Properties

Class	CL_ESH_SE_SNAP_CONTROLLER
Short Description	Snapshot Controller
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_SEARCH	Search (internal)
Created	20131120	SAP
Last change	20141121
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)

Interfaces

Class CL_ESH_SE_SNAP_CONTROLLER has no interface implemented.

Friends

Class CL_ESH_SE_SNAP_CONTROLLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_BACKUP_LOCK	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_CO_LOCK		Backup Lock	20131205
2	MO_LOCK	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_CO_LOCK		Snapshot Lock	20131120
3	MV_LOCKED_CONNECTION_GUID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20131205
4	SO_SNAP_CONTROLLER_SINGLETON	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_SE_SNAP_CONTROLLER		Snapshot Controller Instance	20131125
5	SV_SNAPSHOT_ACTIVE_SESSION	Static Attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	abap_undefined		20131122

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_PREREQUISITES	Static method	Protected	Method	Check prerequisites for snaphots feature	20131125
2	CREATE_SNAPSHOT	Instance method	Public	Method	Create ESH Snapshot	20131120
3	GET_INSTANCE	Static method	Public	Method	Get instance	20131122
4	IS_LOCKED	Instance method	Public	Method	Check locked	20131125
5	IS_SNAPSHOT_ACTIVE_GLOBAL	Static method	Public	Method	Is snapshot active (local system)	20131121
6	IS_SNAPSHOT_ACTIVE_SESSION	Static method	Public	Method	Is snapshot active (for user)	20131122
7	LOCK	Instance method	Protected	Method	Set lock	20131120
8	REMOVE_SNAPSHOT	Instance method	Public	Method	Remove ESH Snapshot	20131120
9	RESUME_INDEXING	Instance method	Protected	Method	Suspend indexing jobs	20131126
10	SET_SNAPSHOT_ACTIVE_SESSION	Static method	Public	Method	Set snapshot status for session	20131122
11	SUSPEND_INDEXING	Instance method	Protected	Method	Suspend indexing jobs	20131126
12	UNLOCK	Instance method	Protected	Method	Remove lock	20131120

Events

Class CL_ESH_SE_SNAP_CONTROLLER has no event.

Types

Class CL_ESH_SE_SNAP_CONTROLLER has no local type.

Method Signatures

Method CHECK_PREREQUISITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20131125
2	Importing	IV_CREATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Check for creation	20131125
3	Importing	IV_REMOVAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Check for removal	20131125

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20131125

Method CREATE_SNAPSHOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20131122

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20131122
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20131122

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SNAP_CONTROLLER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_SE_SNAP_CONTROLLER		Snapshot Controller	20131122

Method GET_INSTANCE on class CL_ESH_SE_SNAP_CONTROLLER has no exception.

Method IS_LOCKED 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			20131125

Method IS_LOCKED on class CL_ESH_SE_SNAP_CONTROLLER has no exception.

Method IS_SNAPSHOT_ACTIVE_GLOBAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BYPASS_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20131121
2	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20131121

Method IS_SNAPSHOT_ACTIVE_GLOBAL on class CL_ESH_SE_SNAP_CONTROLLER has no exception.

Method IS_SNAPSHOT_ACTIVE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BYPASS_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20131122
2	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20131122

Method IS_SNAPSHOT_ACTIVE_SESSION on class CL_ESH_SE_SNAP_CONTROLLER has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20131126

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20131120
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20131120

Method REMOVE_SNAPSHOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20131122

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20131122
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20131122

Method RESUME_INDEXING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20131126
2	Importing	IV_PREVIOUS_STATUS	Call by reference	☐	Type reference (TYPE)	CHAR1		Previous Status	20131126

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20131126

Method SET_SNAPSHOT_ACTIVE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20131122

Method SET_SNAPSHOT_ACTIVE_SESSION on class CL_ESH_SE_SNAP_CONTROLLER has no exception.

Method SUSPEND_INDEXING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PREVIOUS_STATUS	Call by reference	☐	Type reference (TYPE)	CHAR1		Previous Status	20131126
2	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20131126

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20131126

Method UNLOCK Signature

Method UNLOCK on class CL_ESH_SE_SNAP_CONTROLLER has no parameter.
Method UNLOCK on class CL_ESH_SE_SNAP_CONTROLLER has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740