SAP ABAP Class CL_SPI_UI_API (API for PMI Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     ⤷ SPI10 (Package) Central: User Interface

Properties

Class	CL_SPI_UI_API
Short Description	API for PMI Interface
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPI10	Central: User Interface
Created	20030324	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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

Class CL_SPI_UI_API has no interface implemented.

Friends

Class CL_SPI_UI_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_FALSE	Constant	Public	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Boolean Value: False	20031009
2	GC_RUNTIME_MODE	Constant	Public	☐	Type reference (TYPE)	STRING	'RUNTIME_MODE'	Runtime Mode	20070828
3	GC_STATUS_ERROR	Constant	Public	☐	Type reference (TYPE)	SPILED	SPI_RED	Process Status: Errors	20030916
4	GC_STATUS_SUCCESS	Constant	Public	☐	Type reference (TYPE)	SPILED	SPI_GREEN	Process Status: No Errors	20030916
5	GC_STATUS_WARNING	Constant	Public	☐	Type reference (TYPE)	SPILED	SPI_YELLOW	Process Status: Warning	20030916
6	GC_TIME_INTERVAL	Constant	Public	☐	Type reference (TYPE)	STRING	'TIME_INTERVAL'	Time Interval	20070828
7	GC_TRUE	Constant	Public	☐	Type reference (TYPE)	SPIBOOL	SPI_TRUE	Boolean Value: True	20031009
8	GO_SLD_ACCESSOR	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SLD_ACCESSOR		Access to SLD Server	20040116
9	GT_URL_ITS	Static Attribute	Private	☐	Type reference (TYPE)	TSYSURLITS		Table with URLs for ITS	20040116
10	G_PROCESS_ID	Instance attribute	Private	☐	Type reference (TYPE)	SPIPROCTP		Process GUID	20030324

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_INSTANCE	Instance method	Private	Method	Process Instance Display Check	20030903
2	CHECK_PROCESS	Instance method	Private	Method	Process Display Check	20030903
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030324
4	GET_FILTER_FROM_MEMORY	Static method	Public	Method	Internal: Gets filter from the memory	20070828
5	GET_PROCESS_LIST	Static method	Public	Method	Gets Table with All Processes	20030828
6	GET_URL_ADMIN	Instance method	Public	Method	Gets URL for Administration	20030627
7	GET_URL_DEFINITION	Instance method	Public	Method	Gets URl for Process Definition	20080215
8	GET_URL_INSTANCE	Instance method	Public	Method	Delivers URL for the Process Instance Overview	20030324
9	GET_URL_ITS	Static method	Public	Method	Gets URL for ITS of System	20040115
10	GET_URL_PROCESS	Instance method	Public	Method	Delivers URL for the Process Overview	20030324
11	GET_URL_PROCESS_LIST	Static method	Public	Method	Gets URL for Process Overview List	20030912
12	SET_FILTER_TO_MEMORY	Static method	Public	Method	Internal: Sets filter to the memory	20070828

Events

Class CL_SPI_UI_API has no event.

Types

Class CL_SPI_UI_API has no local type.

Method Signatures

Method CHECK_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	SPIPRGUID			20030903
2	Importing	IP_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	SPIPROCTP			20030903

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20030903

Method CHECK_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	SPIPROCTP			20030903

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20030903

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		Prozessguid	20030324

Method CONSTRUCTOR on class CL_SPI_UI_API has no exception.

Method GET_FILTER_FROM_MEMORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ID	Value transfer	☐	Type reference (TYPE)	STRING		ID	20070828
2	Returning	RT_CONDITION	Value transfer	☐	Type reference (TYPE)	TSPIATTRAN		SPI: Tabelle von Attribut-IDs und Rangestabellen	20070828

Method GET_FILTER_FROM_MEMORY on class CL_SPI_UI_API has no exception.

Method GET_PROCESS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ACTIVE_ONLY	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Monitoringstatus	20030828
2	Importing	IP_PROC_STATUS	Call by reference	☑	Type reference (TYPE)	SPILED		Prozessstatus	20030916
3	Importing	IS_TIMEINT	Call by reference	☑	Type reference (TYPE)	SSPITIMINT		Zeitinterval	20030828
4	Returning	RT_PROCESS_LIST	Value transfer	☐	Type reference (TYPE)	TSPIUIPROCLIST		Tabelle mit den Prozessdaten	20030828

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20030828

Method GET_URL_ADMIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_SECURE_HTTP	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, ob HTTP oder HTTP geliefert wird	20040511
2	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL für die Administration	20030627

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20031002

Method GET_URL_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ACCESSIBILITY	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, für "accessibility" Modus	20080215
2	Importing	IP_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Sprache	20080215
3	Importing	IP_SECURE_HTTP	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, ob HTTP oder HTTP geliefert wird	20080215
4	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL für die Prozessübersicht	20080215

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20080215

Method GET_URL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ACCESSIBILITY	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Option für "accessibility" Modus	20050429
2	Importing	IP_GRAPHIC_ONLY	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Option nur die Graphik anzeigen	20070620
3	Importing	IP_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	SPIPRGUID		Instanzguid	20030324
4	Importing	IP_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Sprache	20040906
5	Importing	IP_SECURE_HTTP	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, ob HTTP oder HTTPS geliefert wird	20040511
6	Importing	IP_USED_ONLY	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_TRUE	Option, ob nur beteiligte Komponenten angezeigt werden	20040601
7	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL für die Prozessübersicht	20030324

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20030903

Method GET_URL_ITS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_SYSTEM_ID	Call by reference	☑	Type reference (TYPE)	RFCSYSID		System-Id	20040115
2	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL zum zentralen ITS	20040115

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20040115

Method GET_URL_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		Einschränken der Prozessselektion	20030627
2	Importing	IP_ACCESSIBILITY	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, für "accessibility" Modus	20050429
3	Importing	IP_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Sprache	20040906
4	Importing	IP_REFRESH_INTERVAL	Call by reference	☑	Type reference (TYPE)	I		Auffrischintervall (0 = kein Auffrischen)	20050429
5	Importing	IP_SECURE_HTTP	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, ob HTTP oder HTTP geliefert wird	20040511
6	Importing	IP_SHOW_FILTER	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Option, ob der Filter angezeigt wird	20031103
7	Importing	IP_USED_ONLY	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_TRUE	Option, ob nur beteiligte Komponenten angezeigt werden	20040601
8	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL für die Prozessübersicht	20030324

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20030903

Method GET_URL_PROCESS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ACCESSIBILITY	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Accessibility Modus	20050429
2	Importing	IP_LANGU	Call by reference	☑	Type reference (TYPE)	SY-LANGU		Sprache	20050429
3	Importing	IP_NO_APPL_FRAME	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Seite ohne Rahmen anzeigen	20050429
4	Importing	IP_REFRESH_INTERVAL	Call by reference	☑	Type reference (TYPE)	I		Auffrischintervall (0 = kein Auffrischen)	20050429
5	Importing	IP_SECURE_HTTP	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Sicheres Protokoll verwenden	20040511
6	Importing	IS_TIMEINT	Call by reference	☑	Type reference (TYPE)	SSPITIMINT		UTC-Zeitintervall	20070810
7	Importing	IT_RUNTIME_MODE	Call by reference	☑	Type reference (TYPE)	TSPIRTMODERANGE		SPI: Ranges-Tabelle für Laufzeitmodus	20070810
8	Returning	RP_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL für die Prozessübersichtsliste	20030912

#	Exception	Resumable	Description	Created on
1	CX_SPI_UI_API	☐	Ausnahme im Monitoring UI	20030912

Method SET_FILTER_TO_MEMORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CONDITION	Call by reference	☐	Type reference (TYPE)	TSPIATTRAN		SPI: Tabelle von Attribut-IDs und Rangestabellen	20070828
2	Returning	RP_ID	Value transfer	☐	Type reference (TYPE)	STRING		ID	20070828

Method SET_FILTER_TO_MEMORY on class CL_SPI_UI_API has no exception.

History

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