SAP ABAP Class CL_SPI_AGENT (Abstract Class for PMIT Agents)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     ⤷ SPI7 (Package) Local: Agents
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  /SPE/CL_PMI_AGENT_DLV PMI Agent for deliveries 20061219
2 Inheritance (c INHERITING FROM c_ref)  /SPE/CL_PMI_AGENT_PO PMI Agent Purchasing 20061221
3 Inheritance (c INHERITING FROM c_ref)  CL_BGRFC_PMI_ADAPTER Interface to Process Monitoring Infrastructure 20060301
4 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_ALERT SPI Agent for Alert Test Application 20070522
5 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_EXAMPLE PMI Example Agent 20030217
6 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_GENERAL Global PMI Tracking Agent 20030225
7 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_MONITOR SPI Agent for Alert Test Application 20100528
8 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_OBL PMI Example Agent 20030822
9 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_TEST Global PMI Test Agent 20090717
10 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_TRACE SPI Agent for Trace Test Application 20070903
... Click here to see Used By full list (16 items)
Properties
Class CL_SPI_AGENT  
Short Description Abstract Class for PMIT Agents    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SPI7   Local: Agents 
Created 20030214   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 SPIL Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_SPI_AGENT has no interface implemented.
Friends
Class CL_SPI_AGENT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_STATE_FINISHED Constant Public Type reference (TYPE) SPICMPFIN SPIL_FIN_FORCED Ends Branch 20070209
2 GC_STATE_FINISHED_ALL Constant Public Type reference (TYPE) SPICMPFIN SPIL_FIN_FORCED_ALL Ends all branches 20100706
3 GC_STATE_NOT_FINISHED Constant Public Type reference (TYPE) SPICMPFIN SPIL_NFIN Not completed 20070209
4 GC_STATUS_ERROR Constant Public Type reference (TYPE) SPIERRST SPIL_TR_ERROR_STATUS_ERROR Error 20070209
5 GC_STATUS_OKAY Constant Public Type reference (TYPE) SPIERRST SPIL_TR_ERROR_STATUS_OKAY OK 20070209
6 GC_STATUS_WARNING Constant Public Type reference (TYPE) SPIERRST SPIL_TR_ERROR_STATUS_WARNING Warning 20070209
7 GP_INST_COUNTER Static Attribute Protected Type reference (TYPE) I 1 Instance Counter 20030217
8 GT_CONFIG Instance attribute Protected Type reference (TYPE) TSPISIGOBJ Agent Configuration 20030217
9 GT_TRACKING_DATA Instance attribute Protected Type reference (TYPE) TSPISIGPL Tracking Data 20030217
Methods
# Method Level Visibility Method type Description Created on
1 ASK_FOR_VALUE Instance method Private Method Prompts Subclass for a Field Value 20040326
2 COLLECT_DATA Instance method Protected Method Collects Tracking Data in Global Table 20030217
3 EVALUATE_TRACE_CONDITIONS Instance method Private Method Evaluation of Trace Conditions 20070713
4 FLUSH Instance method Protected Method Writes Tracking Data to Local Repository 20030217
5 GET_AGENT_ID Instance method Protected Method Gets Agent ID (Abstract) 20030217
6 GET_AGENT_ID_FOR_CHECK Instance method Public Method Gets AgentID 20071220
7 GET_FIELD_VALUE Instance method Protected Method Gets Value for Field Name (Abstract) 20071115
8 GET_FINISHED_STATE Instance method Protected Method Gets the end status (completed/open) 20070209
9 GET_LED_STATUS Instance method Protected Method Gets Status (Red, Yellow, Green, Temporary/Final) 20030217
10 GET_VALUE Instance method Protected Method Gets Value for Field Name (Abstract) 20030217
11 IS_ACTIVE Instance method Protected Method Checks Whether Data Must Be Written 20030217
12 SET_TRACE_FLAGS Instance method Private Method Set the Trace Flags in the Passport 20070713
13 TRACK_DATA Instance method Public Method Main Method of Agent 20030217
Events
Class CL_SPI_AGENT has no event.
Types
Class CL_SPI_AGENT has no local type.
Method Signatures

Method ASK_FOR_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_FLDNAM Value transfer Type reference (TYPE) SPIDFLDNAM Feldname 20040326
2 Returning RP_VALUE Value transfer Type reference (TYPE) SPIATTVAL Wert im Feldnamen 20040326
# Exception Resumable Description Created on
1 CX_SPI_AGENT Ausnahmen von Agenten 20040326

Method COLLECT_DATA Signature

Method COLLECT_DATA on class CL_SPI_AGENT has no parameter.
Method COLLECT_DATA on class CL_SPI_AGENT has no exception.

Method EVALUATE_TRACE_CONDITIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_CONDITIONS Call by reference Type reference (TYPE) TSPITRCCND E2E Trace Bedingungen 20070713
2 Returning RP_RESULT Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20070713

Method EVALUATE_TRACE_CONDITIONS on class CL_SPI_AGENT has no exception.

Method FLUSH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_AGENT_ID Call by reference Type reference (TYPE) SPIAGNTID SPI Global: Agenten-ID 20030217

Method FLUSH on class CL_SPI_AGENT has no exception.

Method GET_AGENT_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_AGENT_ID Value transfer Type reference (TYPE) SPIAGNTID Abstrakt: Liefert die GUID(22) des Agenten 20030217

Method GET_AGENT_ID on class CL_SPI_AGENT has no exception.

Method GET_AGENT_ID_FOR_CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_AGENT_ID Value transfer Type reference (TYPE) SPIAGNTID Abstrakt: Liefert die GUID(22) des Agenten 20071220

Method GET_AGENT_ID_FOR_CHECK on class CL_SPI_AGENT has no exception.

Method GET_FIELD_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_FLDNAM Call by reference Type reference (TYPE) SPIDFLDNAM SPI: Name eines Datenfelds 20071115
2 Returning RP_VALUE Value transfer Type reference (TYPE) STRING Wert im Feldnamen 20071115
# Exception Resumable Description Created on
1 CX_SPI_AGENT Ausnahmen von Agenten 20071115

Method GET_FINISHED_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_FINISHED_STATE Value transfer Type reference (TYPE) SPICMPFIN SPI: Finished + Complete Status 20070209

Method GET_FINISHED_STATE on class CL_SPI_AGENT has no exception.

Method GET_LED_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_STATUS Value transfer Type reference (TYPE) SPIERRST SPI: Fehlerstatus für Prozess 20030217

Method GET_LED_STATUS on class CL_SPI_AGENT has no exception.

Method GET_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_FLDNAM Call by reference Type reference (TYPE) SPIDFLDNAM Feldname 20030217
2 Returning RP_VALUE Value transfer Type reference (TYPE) SPIATTVAL Wert im Feldnamen 20030217
# Exception Resumable Description Created on
1 CX_SPI_AGENT Ausnahmen von Agenten 20030217

Method IS_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_AGENT_ID Call by reference Type reference (TYPE) SPIAGNTID Id dieses Agenten 20030217
2 Returning RP_ACTIVE Value transfer Type reference (TYPE) SPIBOOL Returnwert (0/1) 20030217

Method IS_ACTIVE on class CL_SPI_AGENT has no exception.

Method SET_TRACE_FLAGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_TRACEFLAGS Call by reference Type reference (TYPE) INT4 Natürliche Zahl 20070713

Method SET_TRACE_FLAGS on class CL_SPI_AGENT has no exception.

Method TRACK_DATA Signature

Method TRACK_DATA on class CL_SPI_AGENT has no parameter.
Method TRACK_DATA on class CL_SPI_AGENT has no exception.
Meta Relationship - Used By (full list)
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  /SPE/CL_PMI_AGENT_DLV PMI Agent for deliveries 20061219
2 Inheritance (c INHERITING FROM c_ref)  /SPE/CL_PMI_AGENT_PO PMI Agent Purchasing 20061221
3 Inheritance (c INHERITING FROM c_ref)  CL_BGRFC_PMI_ADAPTER Interface to Process Monitoring Infrastructure 20060301
4 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_ALERT SPI Agent for Alert Test Application 20070522
5 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_EXAMPLE PMI Example Agent 20030217
6 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_GENERAL Global PMI Tracking Agent 20030225
7 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_MONITOR SPI Agent for Alert Test Application 20100528
8 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_OBL PMI Example Agent 20030822
9 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_TEST Global PMI Test Agent 20090717
10 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AGENT_TRACE SPI Agent for Trace Test Application 20070903
11 Inheritance (c INHERITING FROM c_ref)  CL_SPI_DEMO_AGENT SPI Agent for Alert Test Application 20101004
12 Inheritance (c INHERITING FROM c_ref)  CL_SWF_XI_PMI_AGENT XI: PMI agent for process engine 20030815
13 Inheritance (c INHERITING FROM c_ref)  CL_XI_SPI_AGENT Superclass for All XI_PMI Agents 20030303
14 Inheritance (c INHERITING FROM c_ref)  CL_XI_SPI_IDOC_AGENT XI: IDoc Adapter Agent for PMI 20030506
15 Inheritance (c INHERITING FROM c_ref)  CL_XI_SPI_PERF_AGENT XI: Performance Agent for PMI 20030331
16 Inheritance (c INHERITING FROM c_ref)  CL_XI_SPI_STATUS_AGENT XI: Status Agent for PMI 20030811
History
Last changed by/on SAP  20110908 
SAP Release Created in 640