SAP ABAP Class CL_SPI_ATTRIBUTE (Abstract Attribute)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_ATTRIBUTE	Attribute of a Process, Step, or Transfer	20020902
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_ATTRIBUTE_DEFINITION	Attribute definition of a process, step, or transition	20021028

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SPI_PROCESS_ATTRIBUTE	Abstract Process Attribute	20020903
2	Inheritance (c INHERITING FROM c_ref)	CL_SPI_PROC_INST_ATTRIBUTE	Abstract Process Instance Attribute	20020903
3	Inheritance (c INHERITING FROM c_ref)	CL_SPI_STEP_ATTRIBUTE	Abstract Step Attribute	20020903
4	Inheritance (c INHERITING FROM c_ref)	CL_SPI_STEP_INST_ATTRIBUTE	Abstract Step Instance Attribute	20020904
5	Inheritance (c INHERITING FROM c_ref)	CL_SPI_TRANS_INST_ATTRIBUTE	Transition Instance Attributes	20030919

Properties

Class	CL_SPI_ATTRIBUTE
Short Description	Abstract Attribute
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SPI12	Central: Analysis Tools (Process Information Tools)
Created	20020902	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ABAP_TSTMP	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SPI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SPI_ATTRIBUTE	☐	☐	Attribute of a Process, Step, or Transfer	20020902
2	IF_SPI_ATTRIBUTE_DEFINITION	☐	☐	Attribute definition of a process, step, or transition	20021028

Friends

Class CL_SPI_ATTRIBUTE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GS_ID	Instance attribute	Protected	☐	Type reference (TYPE)	SSPIATTID		Structure of Attribute ID	20020902
2	G_ATTR_VALUE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Attribute Value	20020905
3	G_DESCRIPTION	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Attribute Description	20020905
4	G_INST_COUNT	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Number of Process Instances	20021007
5	G_IS_DEFINITION	Instance attribute	Protected	☐	Type reference (TYPE)	SPIBOOL		Global SPI: Boolean Value	20021120
6	G_SEC_REFRESH	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Maximum Time in Seconds Until Recalculation	20020917
7	G_TIME_CALC	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL		Time of Attribute Value Calculation	20020905
8	G_TIME_COUNT	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL		Time at which Instances are Counted	20021007
9	G_TIME_INVALIDATION	Instance attribute	Protected	☐	Type reference (TYPE)	TIMESTAMPL		Time at which attribute value invalidated	20110404

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_DISPLAY_TOOL_IMP	Instance method	Protected	Method	Go to External Display	20020903
2	CHECK_FOR_CHANGES	Instance method	Protected	Method	True: Recalculate Only After Local Store Changes	20021007
3	CONSTRUCTOR	Instance method	Public	Constructor		20020902
4	COUNT_INSTANCES_IMP	Instance method	Protected	Method	Returns Number of Process Instance Objects of an Attribute	20020902
5	GET_DESCRIPTION_IMP	Instance method	Protected	Method	Description of Attribute	20020903
6	GET_DETAIL_IMP	Instance method	Protected	Method	Detail Data for an Attribute	20020902
7	GET_DISPLAY_TOOL_URL_IMP	Instance method	Protected	Method	Returns URL for Display Tool - Default = Space	20021113
8	GET_FILTER_VALUES_IMP	Instance method	Protected	Method	Filter Values for Restricting the Process Instance Amount	20020905
9	GET_ICON_NAME_IMP	Instance method	Protected	Method	Implementation: if_Spi_attribute_definition~get_icon_name	20040315
10	GET_ID_IMP	Instance method	Protected	Method	ID of this Attribute	20020905
11	GET_INSTANCES_IMP	Instance method	Protected	Method	Returns Process Instance Objects for an Attribute	20020902
12	GET_PROCESS_TYPE	Instance method	Protected	Method	Process Type in whose Context the Attribute is Calculated	20021007
13	GET_TIME_INTERVAL_RANGES	Instance method	Protected	Method	Structuring Ranges Table for the Time Interval Restrictions	20021111
14	GET_TYPE_IMP	Instance method	Protected	Method	Data Type of Attribute Value (String, Number, or Date)	20020905
15	GET_VALUE_IMP	Instance method	Protected	Method	Attribute Value	20020902
16	HAS_DETAIL_IMP	Instance method	Protected	Method	Can Return Detail Data for Attribute Values	20020903
17	HAS_DISPLAY_TOOL_IMP	Instance method	Protected	Method	Can Go To External Display Tool	20020903
18	HAS_INSTANCES_IMP	Instance method	Protected	Method	Can Return Process Instances for the Attribute	20020903
19	HAS_VALUE_IMP	Instance method	Protected	Method	Can Return an Attribute Value	20020903
20	IS_VALUE_ACTUAL	Instance method	Protected	Method	Determines Whether Attribute Value is Still Valid	20020909
21	PROCESS_INST_CHANGED	Instance method	Protected	Method	Checked Whether the State of the Local Store has Changed	20021007
22	RESET_REFRESH	Instance method	Protected	Method	Invalidates Buffered Values	20021114

Events

Class CL_SPI_ATTRIBUTE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_TIMINT	Protected	See coding		Time Stamp interval with Short Time Stamps	20040309	BEGIN OF ts_timint, from TYPE tzntstmps, to TYPE tzntstmps, END OF ts_timint

Method Signatures

Method CALL_DISPLAY_TOOL_IMP Signature

Method CALL_DISPLAY_TOOL_IMP on class CL_SPI_ATTRIBUTE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method CHECK_FOR_CHANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_BOOL	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20021007

Method CHECK_FOR_CHANGES on class CL_SPI_ATTRIBUTE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_IS_DEF	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	True: nur Def; False: auch Berechnungen	20021120
2	Importing	IP_SEC_REFRESH	Call by reference	☐	Type reference (TYPE)	INT4	3600	Maximale Zeit in Sek. bis zum Neuberechnen	20020917
3	Importing	IS_ID	Call by reference	☐	Type reference (TYPE)	SSPIATTID		Struktur der Attribut ID	20020902

Method CONSTRUCTOR on class CL_SPI_ATTRIBUTE has no exception.

Method COUNT_INSTANCES_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SEARCH_FILTER	Call by reference	☑	Object reference (TYPE REF TO)	CL_SPI_SEARCH_FILTER		Direkte Suche nach Prozessinstanzen	20040223
2	Returning	RP_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20020902

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_DESCRIPTION_IMP Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_DETAIL_IMP Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021120
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_DISPLAY_TOOL_URL_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL zum Displaytool	20021113

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021120
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_FILTER_VALUES_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FILTER	Call by reference	☐	Type reference (TYPE)	TSPIAFNAM		SPI: Tabelle mit (Filtername,Filterbeschreibung)-Paaren	20020905

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_ICON_NAME_IMP 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		SAP Ikone für Attribut Beschreibung	20040315

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐		20040315
2	CX_SPI_AUTH	☐		20040315

Method GET_ID_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ID	Value transfer	☐	Type reference (TYPE)	SSPIATTID		Struktur der Attribut ID	20020905

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_INSTANCES_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SEARCH_FILTER	Call by reference	☑	Object reference (TYPE REF TO)	CL_SPI_SEARCH_FILTER		Direkte Suche nach Prozessinstanzen	20040223
2	Importing	IP_FIRST_N	Call by reference	☑	Type reference (TYPE)	INT4		Nur die ersten n Instanzen	20021025
3	Importing	IP_LAST_N	Call by reference	☑	Type reference (TYPE)	INT4		Nur die letzten n Instanzen	20021025
4	Returning	RT_INST	Value transfer	☐	Type reference (TYPE)	TSPIPROCI		Tabelle mit Prozessinstanzen	20020903

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_PROCESS_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_TYPE	Value transfer	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20021007

Method GET_PROCESS_TYPE on class CL_SPI_ATTRIBUTE has no exception.

Method GET_TIME_INTERVAL_RANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FILT_BEGIN	Call by reference	☐	Type reference (TYPE)	TSPIATTFLT		SPI: Rangestabelle für Filterwerte	20021111
2	Exporting	ET_FILT_END	Call by reference	☐	Type reference (TYPE)	TSPIATTFLT		SPI: Rangestabelle für Filterwerte	20021111
3	Importing	IS_TIMEINT	Call by reference	☑	Type reference (TYPE)	SSPITIMINT		UTC-Zeitintervall	20021111
4	Importing	IT_FILTER	Call by reference	☑	Type reference (TYPE)	TSPIAFTAB		SPI: Tabelle mit (Filtername,Rangestabelle)-Paaren	20021111

Method GET_TIME_INTERVAL_RANGES on class CL_SPI_ATTRIBUTE has no exception.

Method GET_TYPE_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_TYPE	Value transfer	☐	Type reference (TYPE)	SPIATTYP		Datentyp des Attributwerts	20020905

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method GET_VALUE_IMP Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021120
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method HAS_DETAIL_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RES	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20020903

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method HAS_DISPLAY_TOOL_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RES	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20020903

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method HAS_INSTANCES_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RES	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20020903

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method HAS_VALUE_IMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RES	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20020903

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method IS_VALUE_ACTUAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ELAPSED_SEC	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20020909
2	Returning	RP_BOOL	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20020909

#	Exception	Resumable	Description	Created on
1	CX_SPI_ATTR	☐	PMI: Attribut-Ausnahme	20021121
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021121

Method PROCESS_INST_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_COMP_CALC	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_TRUE	True: für die Berechnung, sonst für das Zählen	20021007
2	Returning	RP_BOOL	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20021007

Method PROCESS_INST_CHANGED on class CL_SPI_ATTRIBUTE has no exception.

Method RESET_REFRESH Signature

Method RESET_REFRESH on class CL_SPI_ATTRIBUTE has no parameter.
Method RESET_REFRESH on class CL_SPI_ATTRIBUTE has no exception.

History

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