SAP ABAP Class CL_CSI_INSTANCE_HANDLER (CSI Cloud Instance Handler)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-RCC (Application Component) Remote Control and Communication Framework
     ⤷ CSI_ADMIN (Package) Cloud Service Administration

Properties

Class	CL_CSI_INSTANCE_HANDLER
Short Description	CSI Cloud Instance Handler
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CSI_ADMIN	Cloud Service Administration
Created	20091118	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	IF_CSI_DATASTORE_C	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_CSI_INSTANCE_HANDLER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CSI_PROFILE	☐	20110615	CSI Administration Profile
2	CL_CSI_PROFILE_COMMAND	☐	20110615	CSI Administration Profile Commands

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_PROFILE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CSI_PROFILE		CSI Administration Profile	20100107
2	MV_LOCKED	Instance attribute	Private	☐	Type reference (TYPE)	CSI_INT	0	Number on how often this got locked	20100118
3	MV_LOCKMODE	Instance attribute	Private	☐	Type reference (TYPE)	ENQMODE	IF_CSI_DATASTORE_C=>GC_LOCK_NONE	Lock mode	20091118
4	SO_DATA	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_CSI_DATASTORE			20100105
5	SO_HANDLER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_CSI_INSTANCE_HANDLER		singleton	20100118
6	ST_CALLER_RESERVED	Static Attribute	Private	☐	Type reference (TYPE)	GT_TY_CALLER_RESERVED			20110723

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD	Instance method	Public	Method	Add new Instances for a given Provider	20091118
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20091118
3	GET	Static method	Public	Method	Create an Instance Handler for a Given Provider	20091118
4	GET_ALL	Instance method	Public	Method	Get All Instances for the profile	20110616
5	GET_FREE	Instance method	Public	Method	Get Free Instances	20091118
6	LOCK	Instance method	Public	Method	Lock the Instance Handler	20091118
7	RAISE_AFTER	Static method	Private	Method	Helper: Raise the after action event	20110615
8	RAISE_BEFORE	Static method	Private	Method	Helper: Raise the before action event	20110615
9	RAISE_FOR_ACTION	Static method	Private	Method	Helper: Raise the after action event	20110615
10	REGISTER	Instance method	Public	Method	Register Instances	20091118
11	REGISTER_EVENTHANDLER	Static method	Public	Method	Helper: Register a class as an eventhandler for an instance	20110615
12	RELEASE	Instance method	Public	Method	Release Instances	20091118
13	REMOVE	Instance method	Public	Method	Remove Instances for a given Provider	20091118
14	UNLOCK	Instance method	Public	Method	Unlock the Instance Handler	20091118
15	UNREGISTER_EVENTHANDLER	Static method	Public	Method	Helper:Unregister a class as an eventhandler for an instance	20110615
16	_UNREGISTER_EVENTHANDLER	Static method	Private	Method	Helper:Unregister a class as an eventhandler for an instance	20110616

Events

Class CL_CSI_INSTANCE_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GS_TY_CALLER_RESERVED	Private	See coding			20110723	begin of GS_TY_CALLER_RESERVED , caller type csi_session, slots_reserved type csi_slot_reserved, end of gs_ty_caller_reserved
2	GT_TY_CALLER_RESERVED	Private	See coding			20110723	gt_ty_caller_reserved type HASHED TABLE OF gs_ty_caller_reserved with UNIQUE key caller

Method Signatures

Method ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE	Call by reference	☑	Type reference (TYPE)	CSIS_INSTANCE		CSI Cloud Instance	20091118
2	Importing	IT_INSTANCES	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20091118
3	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	CSI_BOOL		CSI Bool Field	20091118

Method ADD on class CL_CSI_INSTANCE_HANDLER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_CSI_INSTANCE_HANDLER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CSI_INSTANCE_HANDLER has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROFILE	Call by reference	☐	Object reference (TYPE REF TO)	CL_CSI_PROFILE		CSI Administration Profile	20100107
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_INSTANCE_HANDLER		CSI Instance	20091118

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20091118

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_INSTANCES	Value transfer	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110616

Method GET_ALL on class CL_CSI_INSTANCE_HANDLER has no exception.

Method GET_FREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_INSTANCES	Value transfer	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20091118

Method GET_FREE on class CL_CSI_INSTANCE_HANDLER has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	IF_CSI_DATASTORE_C=>GC_LOCK_WRITE	see IF_CSI_DATASTORE_C	20091118
2	Importing	IV_RETRIES	Call by reference	☐	Type reference (TYPE)	INT1	2	Dummy for B20 int1 (Local Everywhere)	20091118

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20091118

Method RAISE_AFTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE		CSI Cloud Instance	20110615
2	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	CHAR01		see if_csi_instance_eventhandler_c=>constants	20110615
3	Importing	IV_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
4	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110615

Method RAISE_AFTER on class CL_CSI_INSTANCE_HANDLER has no exception.

Method RAISE_BEFORE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE		CSI Cloud Instance	20110615
2	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	CHAR01		see if_csi_instance_eventhandler_c=>constants	20110615
3	Importing	IV_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
4	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110615

Method RAISE_BEFORE on class CL_CSI_INSTANCE_HANDLER has no exception.

Method RAISE_FOR_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE		CSI Cloud Instance	20110615
2	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	CHAR01		see if_csi_instance_eventhandler_c=>constants	20110615
3	Importing	IV_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
4	Importing	IV_METHOD	Call by reference	☐	Type reference (TYPE)	SEOCPDNAME		Full Component Name	20110615
5	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110615

Method RAISE_FOR_ACTION on class CL_CSI_INSTANCE_HANDLER has no exception.

Method REGISTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLBACK	Call by reference	☑	Object reference (TYPE REF TO)	IF_CSI_INSTANCE_EVENTHANDLER		CSI Instance Eventhandler	20110912
2	Importing	IT_IGNORE	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110912
3	Importing	IV_CHECK_FREE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20091118
4	Importing	IV_INSTANCE_COUNT	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_COUNT	1	CSI Number of Instances	20091118
5	Importing	IV_MIN_INSTANCES	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_COUNT	0	Number of instances that have to be available at least 0=all	20110723
6	Importing	IV_SESSION	Call by reference	☐	Type reference (TYPE)	CSI_SESSION		CSI Session GUID	20091118
7	Importing	IV_SLOT_PER_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSI_SLOT_RESERVED	1	Reserved slots per instance	20110723
8	Returning	RT_INSTANCES	Value transfer	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20091118

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20091118

Method REGISTER_EVENTHANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INSTANCE_EVENTHANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_CSI_INSTANCE_EVENTHANDLER		CSI Instance Eventhandler	20110615
2	Importing	IV_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
3	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110615

Method REGISTER_EVENTHANDLER on class CL_CSI_INSTANCE_HANDLER has no exception.

Method RELEASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLBACK	Call by reference	☑	Object reference (TYPE REF TO)	IF_CSI_INSTANCE_EVENTHANDLER		CSI Instance Eventhandler	20110912
2	Importing	IT_INSTANCE_IDS	Call by reference	☐	Type reference (TYPE)	CSIT_INSTANCE_IDS		CSI Session GUID	20110722
3	Importing	IV_SESSION	Call by reference	☑	Type reference (TYPE)	CSI_SESSION		CSI Session GUID	20110722
4	Importing	IV_SLOT_PER_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSI_SLOT_RESERVED	1	Reserved slots per instance	20110723

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20091118

Method REMOVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_INSTANCES	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20091118
2	Importing	IT_INSTANCE_IDS	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE_IDS			20110713
3	Importing	IV_INSTANCE_ID	Call by reference	☑	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
4	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	CSI_BOOL		CSI Bool Field	20091118

Method REMOVE on class CL_CSI_INSTANCE_HANDLER has no exception.

Method UNLOCK Signature

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

Method UNREGISTER_EVENTHANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INSTANCE_EVENTHANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_CSI_INSTANCE_EVENTHANDLER		CSI Instance Eventhandler	20110615
2	Importing	IV_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
3	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110615

Method UNREGISTER_EVENTHANDLER on class CL_CSI_INSTANCE_HANDLER has no exception.

Method _UNREGISTER_EVENTHANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INSTANCE_EVENTHANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_CSI_INSTANCE_EVENTHANDLER		CSI Instance Eventhandler	20110616
2	Importing	IV_INSTANCE_ID	Call by reference	☑	Type reference (TYPE)	CSI_INSTANCE_ID			20110713
3	Importing	IV_PROFILE_NAME	Call by reference	☑	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110616

Method _UNREGISTER_EVENTHANDLER on class CL_CSI_INSTANCE_HANDLER has no exception.

History

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