SAP ABAP Class CL_SPI_PROCESS_API (Facade class of process information API)

Hierarchy

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

Properties

Class	CL_SPI_PROCESS_API
Short Description	Facade class of process information API
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPI6	Central: API Process Information
Created	20020701	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	SPI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SPI_PROCESS_API has no interface implemented.

Friends

Class CL_SPI_PROCESS_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_STATUS_GREEN	Constant	Public	☐	Type reference (TYPE)	SPIATTVAL	SPI_GREEN	Status Value Green (Okay)	20040308
2	GC_STATUS_RED	Constant	Public	☐	Type reference (TYPE)	SPIATTVAL	SPI_RED	Status Value Red (Error)	20040308
3	GC_STATUS_YELLOW	Constant	Public	☐	Type reference (TYPE)	SPIATTVAL	SPI_YELLOW	Status Value Yellow (Warning)	20040308

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	FIND	Static method	Public	Method	Gets Process Instance GUIDs According to Certain Criteria	20030314
2	GET_INSTANCE_SEARCH	Static method	Public	Method	Gets Search Filter for Process Instance Selection	20031028
3	GET_PROCESS	Static method	Public	Method	Returns process for corresponding process ID	20020923
4	GET_PROCESSES	Static method	Public	Method	Returns process types that were active in selected time per.	20020703
5	GET_PROCESS_INSTANCE	Static method	Public	Method	Returns process instance for process ID and instance ID	20020923
6	GET_PROCESS_RESTRICTION	Static method	Public	Method	Gets Search Filter for Attribute Restriction	20031104
7	GET_SEARCH_FILTER	Static method	Public	Method	Obsolete: Gets Search Filter for Attribute Restriction	20030717
8	PREPARE_ATTRIBUTES	Static method	Public	Method	Preselect Attributes	20031124
9	PREPARE_ATTRIBUTES_FOR_TABLE	Static method	Public	Method	Preselect Attributes for Process Instance List	20031125
10	SIMPLE_FIND	Static method	Public	Method	Gets Process Instance GUIDs According to Simple Criteria	20030326

Events

Class CL_SPI_PROCESS_API has no event.

Types

Class CL_SPI_PROCESS_API has no local type.

Method Signatures

Method FIND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_PROCESS_GUIDS	Value transfer	☐	Type reference (TYPE)	TSPIPRGUID		Prozessinstanz-GUIDs	20030314
2	Importing	IP_MAX_COUNT	Call by reference	☑	Type reference (TYPE)	I		Einschränkung für die Treffermenge	20030407
3	Importing	IP_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		Prozesstyp	20030314
4	Importing	IT_CONDITIONS	Call by reference	☐	Type reference (TYPE)	TSPIATTRAN		Filterkriterien	20030314

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

Method GET_INSTANCE_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_MAX_COUNT	Value transfer	☑	Type reference (TYPE)	I			20031028
2	Importing	IP_PROCESS_ID	Value transfer	☐	Type reference (TYPE)	SPIPROCTP			20031028
3	Importing	IP_SINGLETON_REQUIRED	Value transfer	☑	Type reference (TYPE)	SPIBOOL	SPI_TRUE		20031028
4	Importing	IT_CONDITIONS	Value transfer	☑	Type reference (TYPE)	TSPIATTRAN			20031028
5	Returning	RO_INSTANCE_SEARCH	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_INSTANCE_SEARCH			20031028

Method GET_INSTANCE_SEARCH on class CL_SPI_PROCESS_API has no exception.

Method GET_PROCESS 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)	IF_SPI_SEARCH_FILTER		Suchfilter	20030509
2	Importing	IP_PROCID	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		Prozess ID	20020923
3	Returning	RO_PROCESS	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_PROCESS		Prozess	20020923

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

Method GET_PROCESSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROC	Call by reference	☐	Type reference (TYPE)	TSPIIFPR		Tabelle mit Referenzen auf IF_SPI_PROCESS	20020911
2	Importing	IP_ACTIVE_ONLY	Call by reference	☑	Type reference (TYPE)	SPIBOOL	SPI_TRUE	SPI Global: Boolscher Wert	20020911
3	Importing	IP_MAX_COUNT	Call by reference	☑	Type reference (TYPE)	I		Instanzeinschränkung für Suchfilter	20030717
4	Importing	IT_CONDITIONS	Call by reference	☑	Type reference (TYPE)	TSPIATTRAN		Restriktionen für Suchfilter	20030717

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

Method GET_PROCESS_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCID	Call by reference	☑	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20020923
2	Importing	IP_PROCINSTID	Call by reference	☐	Type reference (TYPE)	SPIPRGUID		SPI: GUID of a Process	20020923
3	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_PROCESS_INST		Prozessinstanz	20020923

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

Method GET_PROCESS_RESTRICTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCESS_ID	Value transfer	☐	Type reference (TYPE)	SPIPROCTP			20031104
2	Importing	IP_SINGLETON_REQUIRED	Value transfer	☑	Type reference (TYPE)	SPIBOOL	SPI_TRUE		20031104
3	Importing	IT_CONDITIONS	Value transfer	☑	Type reference (TYPE)	TSPIATTRAN			20031104
4	Returning	RO_PROCESS_RESTRICTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_PROCESS_RESTRICTION			20031104

#	Exception	Resumable	Description	Created on
1	CX_SPI_SEARCH	☐	Ausnahme im Zusammenhang mit Suchfilter	20031104

Method GET_SEARCH_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCESS_ID	Value transfer	☐	Type reference (TYPE)	SPIPROCTP			20030717
2	Importing	IP_SINGLETON_REQUIRED	Value transfer	☑	Type reference (TYPE)	SPIBOOL	SPI_TRUE		20030717
3	Importing	IT_CONDITIONS	Value transfer	☑	Type reference (TYPE)	TSPIATTRAN			20030717
4	Returning	RO_SEARCH_FILTER	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_SEARCH_FILTER			20030717

#	Exception	Resumable	Description	Created on
1	CX_SPI_SEARCH	☐	Ausnahme im Zusammenhang mit Suchfilter	20031028

Method PREPARE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TSPIATTIN		Attributreferenzen (IF_SPI_ATTRIBUTE)	20031124

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20031124

Method PREPARE_ATTRIBUTES_FOR_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTE_DEF	Call by reference	☐	Type reference (TYPE)	TSPIATTR		Tabelle mit Attributen	20031125
2	Importing	IT_PROCESS_INST	Call by reference	☐	Type reference (TYPE)	TSPIIFPRIN		Tabelle von Prozessinstanz-Interfaces	20031125

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20031125

Method SIMPLE_FIND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_PROCESS_GUIDS	Value transfer	☐	Type reference (TYPE)	TSPIPRGUID		Prozessinstanz-GUIDs	20030401
2	Importing	IP_MAX_COUNT	Call by reference	☑	Type reference (TYPE)	I		Einschränkung für die Treffermenge	20030407
3	Importing	IP_NAME_1	Call by reference	☑	Type reference (TYPE)	SPIATTNAME		Name eines Attributs	20030326
4	Importing	IP_NAME_2	Call by reference	☑	Type reference (TYPE)	SPIATTNAME		Name eines Attributs	20030326
5	Importing	IP_NAME_3	Call by reference	☑	Type reference (TYPE)	SPIATTNAME		Name eines Attributs	20030326
6	Importing	IP_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		Prozesstyp	20030326
7	Importing	IP_TIME_HIGH	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel	20030326
8	Importing	IP_TIME_LOW	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel	20030326
9	Importing	IP_USER	Call by reference	☑	Type reference (TYPE)	SPIATTVAL		Benutzername	20030326
10	Importing	IP_VALUE_1	Call by reference	☑	Type reference (TYPE)	SPIATTVAL		Zugehöriger Wert	20030326
11	Importing	IP_VALUE_2	Call by reference	☑	Type reference (TYPE)	SPIATTVAL		Zugehöriger Wert	20030326
12	Importing	IP_VALUE_3	Call by reference	☑	Type reference (TYPE)	SPIATTVAL		Zugehöriger Wert	20030326

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

History

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