SAP ABAP Interface IF_SPI_METRIC_INST (PMI Metric Instance Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     ⤷ SPI6 (Package) Central: API Process Information

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SPI_METRIC_INST	Abstract Metric Instance	20070430

Properties

Interface	IF_SPI_METRIC_INST
Short Description	PMI Metric Instance Interface

General Data

Package	SPI6	Central: API Process Information
Created	20070425	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SPI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SPI_COMMON	☐	☐	Common functionality	20070425

Friends

Interface IF_SPI_METRIC_INST has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	G_EVENT_ID	Instance attribute	Public	☐	Type reference (TYPE)	SPIEVGUID		SPI: GUID of an Event (Metric Event)	20070425
2	G_TIMEOUT	Instance attribute	Public	☐	Type reference (TYPE)	SPIBOOL		Is this a timeout event?	20100623
3	G_TIMESTAMP	Instance attribute	Public	☐	Type reference (TYPE)	TIMESTAMPL		UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun)	20070503

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_AS_STRING	Instance method	Public	Method	Gets the value as a string	20070425
2	GET_EVENT_ID	Instance method	Public	Method	Gets Event ID	20080211
3	GET_METRIC_DEFINITION	Instance method	Public	Method		20070503
4	GET_PROCESS_INSTANCE	Instance method	Public	Method	Gets references to process instances (might be empty)	20070425
5	GET_TRGUID	Instance method	Public	Method	Returns the TRGUID(s) of associated steps/step ID at timeout	20100628
6	GET_VALUE	Instance method	Public	Method	Gets the value in a suitable format	20070425
7	IS_TIMEOUT	Instance method	Public	Method	Is this a timeout event?	20100623

Events

Interface IF_SPI_METRIC_INST has no event.

Types

Interface IF_SPI_METRIC_INST has no local type.

Method Signatures

Method GET_AS_STRING Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425
2	CX_SPI_METRIC_INST	☐	Ausnahme bei Metric	20070425

Method GET_EVENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_EVENT_ID	Value transfer	☐	Type reference (TYPE)	SPIEVGUID		SPI: GUID eines Events (Auftreten einer Metrik)	20080211

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20080211
2	CX_SPI_METRIC_INST	☐	Ausnahme bei Metric	20080211

Method GET_METRIC_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RI_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_METRIC		PMI Metric-Interface	20070503

Method GET_METRIC_DEFINITION on Interface IF_SPI_METRIC_INST has no exception.

Method GET_PROCESS_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	TSPIIFPRIN		PMI: Prozessinstanz-Interface	20070515

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425
2	CX_SPI_METRIC_INST	☐		20070425

Method GET_TRGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_TRGUID	Value transfer	☐	Type reference (TYPE)	TSPITRGUID		TrackingGuid(s) zu dem/den beteiligten Step(s)	20100628

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20100628
2	CX_SPI_METRIC_INST	☐		20100628

Method GET_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_VALUE	Value transfer	☐	Type reference (TYPE)	ANY			20070425

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425
2	CX_SPI_METRIC_INST	☐	Ausnahme bei Metric	20070425

Method IS_TIMEOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	SPIBOOL		spi_true = Time Out-Event	20100623

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20100628
2	CX_SPI_METRIC_INST	☐		20100628

History

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