SAP ABAP Class CL_SPI_PROCESS (Process Definition from Customizing)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_COMMON	Common functionality	20020704
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_COMPARABLE	Object comparison	20020704
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_PROCESS	PMI: Process Interface	20030701

Properties

Class	CL_SPI_PROCESS
Short Description	Process Definition from Customizing
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPI6	Central: API Process Information
Created	20020704	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_SPI_ADMIN_MANAGER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_SPI_STEP_TRANS_ITERATOR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	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	20020704
2	IF_SPI_COMPARABLE	☐	☐	Object comparison	20020704
3	IF_SPI_PROCESS	☐	☐	PMI: Process Interface	20030701

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SPI_PROCESS_API	☐	20020731	Facade class of process information API
2	CL_SPI_STEP	☐	20021114	Process Step Definition
3	CL_SPI_TRANSITION	☐	20021114	Definition of Process Step Transition

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_CACHE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SPI_ATTRIBUTE_CACHE		Cache for Attribute Instances	20021007
2	GO_PROC	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SPI_CU_PROCESS		Process Data from Customizing	20020704
3	GO_ROOT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SPI_STEP			20030415
4	GO_SEARCH_FILTER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SPI_SEARCH_FILTER			20030509
5	GP_LAST_SELECTED_INSTANCE	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0000000000000000'	GUID of Last Selected Instance	20040405
6	GT_INST	Static Attribute	Private	☐	See coding			Table with type, instance pairs	20020906
7	GT_INST_ATTR	Instance attribute	Private	☐	Type reference (TYPE)	TSPIIDATT			20030624
8	GT_STEPS	Instance attribute	Private	☐	Type reference (TYPE)	TSPISTEPD			20030415
9	GT_TRANS	Instance attribute	Private	☐	Type reference (TYPE)	TSPITRANS			20030415

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20020704
2	EQUALS	Instance method	Public	Method		20020712
3	GET_ADMIN_INFO	Instance method	Public	Method	Returns admin info for this process type	20020911
4	GET_AGGREGATED_ATTRIBUTES	Instance method	Public	Method	Returns Step Attributes Aggregated Over Multiple Steps	20030612
5	GET_ATTRIBUTE	Instance method	Public	Method		20020712
6	GET_ATTRIBUTES	Instance method	Public	Method		20020712
7	GET_DESCRIPTION	Instance method	Public	Method		20020712
8	GET_INSTANCE	Static method	Public	Method	Factory method	20020906
9	GET_INSTANCE_ATTRIBUTE	Instance method	Public	Method	Returns Description of an Attribute for Process Instances	20030715
10	GET_INSTANCE_ATTRIBUTES	Instance method	Public	Method	Gets Attribute Description for Process Instances	20030624
11	GET_INTERVAL	Instance method	Public	Method	Obsolete: Time Interval for the Process	20020909
12	GET_PAYLOAD_RAW_DATA	Instance method	Public	Method	Prototype: Raw Data Interface for Payload Data	20030603
13	GET_PROCESS	Instance method	Public	Method	Returns process	20020812
14	GET_RAW_DATA	Instance method	Public	Method	Raw Data Interface for Payload Data	20040423
15	GET_RUNTIME_MODE	Instance method	Public	Method	Gets the runtime mode	20080815
16	GET_SEARCH_FILTER	Instance method	Public	Method	Returns the Search Filter	20030911
17	GET_STEPIDS_BY_NAME	Instance method	Public	Method	Returns the Steps that Belong to a Step Name	20030603
18	GET_STEPS	Instance method	Public	Method	Process Steps	20030415
19	GET_STEP_TREE	Instance method	Public	Method	Gets First Step	20030410
20	GET_TECHNICAL_RAW_DATA	Instance method	Public	Method	Prototype: Raw Data Interface for Technical Data	20030603
21	GET_TIME_INT	Instance method	Public	Method		20031105
22	GET_TRANSITIONS	Instance method	Public	Method	Process Transitions	20030415
23	GET_TYPE_ID	Instance method	Public	Method	Gets Process Type (GUID)	20020926
24	LOAD_INSTANCE_ATTRIBUTES	Instance method	Protected	Method	Gets Attribute Description for Process Instances	20030715
25	TRAVERSE_AND_FILL	Instance method	Private	Method	Fills Step Table and Transition Table	20030415

Events

Class CL_SPI_PROCESS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	SSPIIDATT	Protected	See coding			20030715
2	TSPIIDATT	Protected	See coding			20030715

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROC	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_CU_PROCESS		Prozessdaten aus dem Customizing	20020704
2	Importing	IO_SEARCH_FILTER	Call by reference	☑	Object reference (TYPE REF TO)	CL_SPI_SEARCH_FILTER			20030509

Method CONSTRUCTOR on class CL_SPI_PROCESS has no exception.

Method EQUALS Signature

Method EQUALS on class CL_SPI_PROCESS has no parameter.
Method EQUALS on class CL_SPI_PROCESS has no exception.

Method GET_ADMIN_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_ADMIN		Verwaltungsdaten eines Prozesses	20020911

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021120
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20021120

Method GET_AGGREGATED_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_AGGREGATION_TYPE	Call by reference	☐	Type reference (TYPE)	SPIATTAGGR		Aggregationsart	20030612
2	Importing	IS_ID	Call by reference	☐	Type reference (TYPE)	SSPIATTID		Struktur der Attribut ID	20030612
3	Importing	IT_STEPS	Call by reference	☑	Type reference (TYPE)	TSPISTEPD		Schritte über die aggregiert werden soll	20030612
4	Importing	IT_TRANSITIONS	Call by reference	☑	Type reference (TYPE)	TSPITRANS		zugehörige Überggänge	20030612
5	Returning	RP_ATTRIBUTE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_ATTRIBUTE		Aggregationsattribut	20030612

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20030612
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030612

Method GET_ATTRIBUTE Signature

Method GET_ATTRIBUTE on class CL_SPI_PROCESS has no parameter.
Method GET_ATTRIBUTE on class CL_SPI_PROCESS has no exception.

Method GET_ATTRIBUTES Signature

Method GET_ATTRIBUTES on class CL_SPI_PROCESS has no parameter.
Method GET_ATTRIBUTES on class CL_SPI_PROCESS has no exception.

Method GET_DESCRIPTION Signature

Method GET_DESCRIPTION on class CL_SPI_PROCESS has no parameter.
Method GET_DESCRIPTION on class CL_SPI_PROCESS has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROC	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_CU_PROCESS		Prozessdaten aus dem Customizing	20020906
2	Importing	IO_SEARCH_FILTER	Call by reference	☑	Object reference (TYPE REF TO)	CL_SPI_SEARCH_FILTER			20030509
3	Returning	RP_PROC	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_PROCESS		Prozessdefinition aus dem Customizing	20020906

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021120
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20021120

Method GET_INSTANCE_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	SSPIATTID		Attributid	20030715
2	Returning	RO_ATTR	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_ATTRIBUTE_DEFINITION			20030715

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20030715
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030715

Method GET_INSTANCE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR	Call by reference	☐	Type reference (TYPE)	TSPIATTR			20030624

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20030624
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030624

Method GET_INTERVAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_INTERVAL	Call by reference	☐	Type reference (TYPE)	SSPITIMINT		UTC-Zeitintervall	20020909

Method GET_INTERVAL on class CL_SPI_PROCESS has no exception.

Method GET_PAYLOAD_RAW_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	INT4	0	Anzahl der Sätze, die auf einmal gelesen werden	20040406
2	Importing	IS_PROCESS_MODIFICATION	Value transfer	☐	Type reference (TYPE)	SSPITIMINT		Einschränkung auf letzte Modifikation der Instanzen	20030922
3	Importing	IT_PAYLOAD_FIELDS	Call by reference	☐	Type reference (TYPE)	TSPIFLDNAM		Tabelle von Payloadfeldern	20030603
4	Importing	IT_STEPIDS	Call by reference	☑	Type reference (TYPE)	TSPIPRSTID		Zu beachtende Schritte	20030603
5	Returning	RT_PAYLOAD_RAW_DATA	Value transfer	☐	Type reference (TYPE)	TSPICSPRPL		Tabelle der Payload-Daten	20030603

Method GET_PAYLOAD_RAW_DATA on class CL_SPI_PROCESS has no exception.

Method GET_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_PROC	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_CU_PROCESS		Prozessdaten aus dem Customizing	20020812

Method GET_PROCESS on class CL_SPI_PROCESS has no exception.

Method GET_RAW_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	INT4	0	Anzahl der Sätze, die auf einmal gelesen werden	20040423
2	Importing	IS_PROCESS_MODIFICATION	Value transfer	☐	Type reference (TYPE)	SSPITIMINT		Einschränkung auf letzte Modifikation der Instanzen	20040423
3	Importing	IT_PAYLOAD_FIELDS	Call by reference	☐	Type reference (TYPE)	TSPIFLDNAM		Tabelle von Payloadfeldern	20040423
4	Importing	IT_STEPIDS	Call by reference	☑	Type reference (TYPE)	TSPIPRSTID		Zu beachtende Schritte	20040423
5	Importing	IT_TECHNICAL_FIELDS	Call by reference	☐	Type reference (TYPE)	TSPIFLDNAM		Tabelle von technischen Feldern	20040423
6	Returning	RT_PAYLOAD_RAW_DATA	Value transfer	☐	Type reference (TYPE)	TSPICSPRPL		Tabelle der Payload-Daten	20040423

Method GET_RAW_DATA on class CL_SPI_PROCESS has no exception.

Method GET_RUNTIME_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RUNTIME_MODE	Value transfer	☐	Type reference (TYPE)	SPIRTMODE		SPI: Laufzeitmodus	20080815

Method GET_RUNTIME_MODE on class CL_SPI_PROCESS has no exception.

Method GET_SEARCH_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SEARCH_FILTER	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_SEARCH_FILTER			20030911

Method GET_SEARCH_FILTER on class CL_SPI_PROCESS has no exception.

Method GET_STEPIDS_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_STEP_NAME	Call by reference	☐	Type reference (TYPE)	SPIPSNAME		Schrittname	20030603
2	Returning	RT_STEPIDS	Value transfer	☐	Type reference (TYPE)	TSPIPRSTID		zugrhörige Schritt-IDs	20030603

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030603
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20030603

Method GET_STEPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_STEPS	Value transfer	☐	Type reference (TYPE)	TSPISTEPD			20030415

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030415
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20030415

Method GET_STEP_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_STEP	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_STEP			20030410

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030410
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20030410

Method GET_TECHNICAL_RAW_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	INT4	0	Anzahl der Sätze, die auf einmal gelesen werden	20040405
2	Importing	IS_PROCESS_MODIFICATION	Value transfer	☐	Type reference (TYPE)	SSPITIMINT		Einschränkung auf letzte Modifikation der Instanzen	20030922
3	Importing	IT_STEPIDS	Call by reference	☑	Type reference (TYPE)	TSPIPRSTID		Zu beachtende Schritte	20030603
4	Importing	IT_TECHNICAL_FIELDS	Call by reference	☐	Type reference (TYPE)	TSPIFLDNAM		Tabelle von technischen Feldern	20030603
5	Returning	RT_TECH_RAW_DATA	Value transfer	☐	Type reference (TYPE)	TSPICSPRST		Tabelle der technischen RAW-Daten	20030603

Method GET_TECHNICAL_RAW_DATA on class CL_SPI_PROCESS has no exception.

Method GET_TIME_INT Signature

Method GET_TIME_INT on class CL_SPI_PROCESS has no parameter.
Method GET_TIME_INT on class CL_SPI_PROCESS has no exception.

Method GET_TRANSITIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_TRANS	Value transfer	☐	Type reference (TYPE)	TSPITRANS			20030415

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030415
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20030415

Method GET_TYPE_ID 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	20020926

Method GET_TYPE_ID on class CL_SPI_PROCESS has no exception.

Method LOAD_INSTANCE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR	Call by reference	☐	Type reference (TYPE)	TSPIATTR			20030715

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20030715
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030715

Method TRAVERSE_AND_FILL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PREV	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_STEP			20030415
2	Importing	IO_STEP	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_STEP			20030415
3	Importing	IP_RECLEVEL	Value transfer	☐	Type reference (TYPE)	I	0		20040403

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030415
2	CX_SPI_PROC	☐	PMI: Prozessausnahme	20030415
3	CX_SPI_STEP	☐	PMI: Schrittausnahme	20030415
4	CX_SPI_TRANS	☐	PMI: Übergang-Ausnahme	20030415

History

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