SAP ABAP Class CL_CSI_INSTANCE_LOGGING (CSI Instance Logging)

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_LOGGING
Short Description	CSI Instance Logging
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

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

Interfaces

Class CL_CSI_INSTANCE_LOGGING has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CSI_ADMIN_CLEANUP	☐	20110801	CSI cleanup action
2	CL_CSI_INSTANCE_LOGSCREEN	☐	20110720	Log Class for Displaying Engine Log

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_BAL_OBJECT	Constant	Private	☐	Type reference (TYPE)	BALOBJ_D	'CSI'	Application log: Object name (Application code)	20110721
2	GC_BAL_SUBOBJECT	Constant	Private	☐	Type reference (TYPE)	BALSUBOBJ	'INSTANCE_LOG'	Application Log: Subobject	20110721
3	MS_INSTANCE_LOGENTRY	Instance attribute	Public	☑	Type reference (TYPE)	CSIS_INSTANCE_LOG_DETAILS			20110712
4	MS_INSTANCE_LOGKEY	Instance attribute	Private	☐	Type reference (TYPE)	CSIS_INSTANCE_LOG_KEY		CSI Instance Log Key	20110712
5	MV_BALLOGHNDL	Instance attribute	Public	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20110721
6	MV_BALLOG_IS_DIRTY	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20110721
7	MV_BALLOG_OPEN	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20110721
8	MV_IS_DIRTY	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL			20110712
9	SO_DB	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_CSI_DATASTORE		CSI Datastore Interface	20110712
10	ST_LOGGING	Static Attribute	Private	☐	Type reference (TYPE)	CSIT_INSTANCE_LOG_OBJ		CSI Instance Log Object Table	20110810

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD	Instance method	Public	Method	Add a new instance to the log	20110712
2	ADD_MESSAGE	Instance method	Public	Method	Add an application log message for the history	20110721
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20110712
4	CLEANUP	Instance method	Private	Method	Cleanup the data, if the object is deleted	20110815
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110712
6	DELETE	Instance method	Public	Method	Delete an instance entry	20110712
7	DELETE_BALLOG	Static method	Private	Method	Delete the referenced Basis Application Log	20110802
8	DELETE_MULTIPLE	Static method	Protected	Method	Delete multiple entries	20110712
9	FACTORY	Static method	Public	Method	Create a new logging object for a given (new?) session	20110712
10	GET_ALL	Static method	Protected	Method	Get old entries	20110815
11	GET_TIMESTAMP_FOR_MESSAGE	Static method	Public	Method	Return a formated timestamp-string	20110725
12	INSTANCE_ACTION	Static method	Private	Method	Start or stop an instance for a given profile	20110720
13	OPEN_BALLOG	Instance method	Private	Method	Open the Basis Application Log	20110724
14	REFRESH	Instance method	Public	Method	Refresh log data (overwrite)	20110805
15	SAVE	Instance method	Public	Method	Save the instance entry	20110712
16	SET_RESERVED_SLOTS	Instance method	Public	Method	Set the reserved slots field	20110722
17	UPDATE	Instance method	Public	Method	Update an instance entry	20110712
18	UPDATE_STATUS	Static method	Private	Method	Update the status of all entries	20110715

Events

Class CL_CSI_INSTANCE_LOGGING has no event.

Types

Class CL_CSI_INSTANCE_LOGGING has no local type.

Method Signatures

Method ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_LOGENTRY	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE_LOG_DETAILS			20110712

Method ADD on class CL_CSI_INSTANCE_LOGGING has no exception.

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MSG_LOGGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110721
2	Importing	IS_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG		Message Variable	20110721

Method ADD_MESSAGE on class CL_CSI_INSTANCE_LOGGING has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CLEANUP Signature

Method CLEANUP on class CL_CSI_INSTANCE_LOGGING has no parameter.
Method CLEANUP on class CL_CSI_INSTANCE_LOGGING has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_LOGKEY	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE_LOG_KEY			20110712

Method CONSTRUCTOR on class CL_CSI_INSTANCE_LOGGING has no exception.

Method DELETE Signature

Method DELETE on class CL_CSI_INSTANCE_LOGGING has no parameter.
Method DELETE on class CL_CSI_INSTANCE_LOGGING has no exception.

Method DELETE_BALLOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOGENTRY	Call by reference	☑	Type reference (TYPE)	CSIS_INSTANCE_LOG_DETAILS		CSI Instance Log Details	20110802
2	Importing	IT_LOGENTRY	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE_LOG		CSI Instance Log Table	20110802
3	Importing	IT_LOGKEY_RANGE	Call by reference	☑	Type reference (TYPE)	IF_CSI_DATASTORE=>TY_GT_INST_LOGKEY_RANGE			20110802

Method DELETE_BALLOG on class CL_CSI_INSTANCE_LOGGING has no exception.

Method DELETE_MULTIPLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_LOGENTRY	Call by reference	☑	Type reference (TYPE)	CSIS_INSTANCE_LOG_DETAILS		CSI Instance Log Details	20110802
2	Importing	IS_INSTANCE_LOGKEY	Call by reference	☑	Type reference (TYPE)	CSIS_INSTANCE_LOG_KEY		CSI Instance Log Key	20110712
3	Importing	IT_INSTANCE_LOGKEY_RANGE	Call by reference	☑	Type reference (TYPE)	IF_CSI_DATASTORE=>TY_GT_INST_LOGKEY_RANGE			20110712
4	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	CSI_INT		CSI Integer (4 Byte)	20110712

Method DELETE_MULTIPLE on class CL_CSI_INSTANCE_LOGGING has no exception.

Method FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_LOGKEY	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE_LOG_KEY			20110712
2	Returning	RO_INSTANCE_LOGGING	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_INSTANCE_LOGGING		CSI Instance Logging	20110712

Method FACTORY on class CL_CSI_INSTANCE_LOGGING has no exception.

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOGENTRIES	Call by reference	☐	Type reference (TYPE)	CSIT_INSTANCE_LOG		CSI Instance Log Table	20110815
2	Exporting	ET_LOGOBJECTS	Call by reference	☐	Type reference (TYPE)	CSIT_INSTANCE_LOG_OBJ		CSI Instance Log Object Table	20110815
3	Importing	IV_TO_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Field of type DATS	20110815

Method GET_ALL on class CL_CSI_INSTANCE_LOGGING has no exception.

Method GET_TIMESTAMP_FOR_MESSAGE Signature

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

Method GET_TIMESTAMP_FOR_MESSAGE on class CL_CSI_INSTANCE_LOGGING has no exception.

Method INSTANCE_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_INSTANCES	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110720
2	Exporting	EV_ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20110720
3	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110720
4	Importing	IV_START	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110720

Method INSTANCE_ACTION on class CL_CSI_INSTANCE_LOGGING has no exception.

Method OPEN_BALLOG Signature

Method OPEN_BALLOG on class CL_CSI_INSTANCE_LOGGING has no parameter.
Method OPEN_BALLOG on class CL_CSI_INSTANCE_LOGGING has no exception.

Method REFRESH Signature

Method REFRESH on class CL_CSI_INSTANCE_LOGGING has no parameter.
Method REFRESH on class CL_CSI_INSTANCE_LOGGING has no exception.

Method SAVE Signature

Method SAVE on class CL_CSI_INSTANCE_LOGGING has no parameter.
Method SAVE on class CL_CSI_INSTANCE_LOGGING has no exception.

Method SET_RESERVED_SLOTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CALLER	Call by reference	☑	Type reference (TYPE)	CSI_SESSION		CSI Session GUID	20110722
2	Importing	IV_SLOTS_RESERVED	Call by reference	☐	Type reference (TYPE)	CSI_SLOT_RESERVED		CSI number of reserved slots	20110722

Method SET_RESERVED_SLOTS on class CL_CSI_INSTANCE_LOGGING has no exception.

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_LOGENTRY	Call by reference	☐	Type reference (TYPE)	CSIS_INSTANCE_LOG_DETAILS			20110712
2	Importing	IV_SKIP_INITIAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110712

Method UPDATE on class CL_CSI_INSTANCE_LOGGING has no exception.

Method UPDATE_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INSTANCE_ID	Call by reference	☑	Type reference (TYPE)	CSI_INSTANCE_ID		Force update single instance	20110718
2	Importing	IV_PROFILE_NAME	Call by reference	☑	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110718
3	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	CSI_INSTANCE_STATE		CSI Instance Status	20110718

Method UPDATE_STATUS on class CL_CSI_INSTANCE_LOGGING has no exception.

History

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