SAP ABAP Class CL_SPI_STEP (Process Step Definition)
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_STEP | PMI: Step Interface | 20030701 |
Properties
| Class | CL_SPI_STEP | |
| Short Description | Process Step Definition | |
| 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
Class CL_SPI_STEP has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SPI_COMMON | Common functionality | 20020704 | ||
| 2 | IF_SPI_COMPARABLE | Object comparison | 20020704 | ||
| 3 | IF_SPI_STEP | PMI: Step Interface | 20030701 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_SPI_STEP_TRANS_ITERATOR | 20020710 | Iterator via step transitions and steps | |
| 2 | CL_SPI_TRANSITION | 20020710 | Definition of Process Step Transition |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_SPI_ATTRIBUTE_CACHE | Cache for Attribute Instances | 20021007 | |||
| 2 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SPI_SEARCH_FILTER | 20030626 | ||||
| 3 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SPI_CU_STEP | Process Step Data from Customizing | 20020705 | |||
| 4 | Static Attribute | Private | See coding | Table with type, instance pairs | 20020909 | ||||
| 5 | Instance attribute | Private | Type reference (TYPE) | TSPIATTR | 20030624 | ||||
| 6 | Instance attribute | Private | Type reference (TYPE) | TSPIIDATT | Step Instance Attributes with Attribute ID | 20030825 | |||
| 7 | Instance attribute | Protected | Type reference (TYPE) | TSPITRANS | Table with Transitions | 20020709 | |||
| 8 | Instance attribute | Protected | Type reference (TYPE) | TSPITRANS | Table with Transitions | 20020709 | |||
| 9 | Instance attribute | Private | Type reference (TYPE) | SPIBOOL | Flag for Reading Step Environment | 20030410 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | 20020705 | ||
| 2 | Instance method | Public | Method | 20020710 | ||
| 3 | Instance method | Public | Method | 20020711 | ||
| 4 | Instance method | Public | Method | 20020710 | ||
| 5 | Instance method | Public | Method | 20020711 | ||
| 6 | Static method | Public | Method | Factory method | 20020909 | |
| 7 | Instance method | Public | Method | Gets Description of Attribute for Step Instances | 20030825 | |
| 8 | Instance method | Public | Method | Gets Attribute Definitions for Step Instances | 20030624 | |
| 9 | Instance method | Public | Method | Time interval for step attributes | 20020930 | |
| 10 | Instance method | Public | Method | 20030922 | ||
| 11 | Instance method | Public | Method | Predecessor of Step | 20030410 | |
| 12 | Instance method | Public | Method | Gets Process for Step | 20020925 | |
| 13 | Instance method | Public | Method | Type ID of process that belongs to this step | 20021007 | |
| 14 | Instance method | Public | Method | Returns the CL_SPI_CU_STEP | 20020823 | |
| 15 | Instance method | Public | Method | 20020726 | ||
| 16 | Instance method | Public | Method | Successor of Step | 20030410 | |
| 17 | Instance method | Public | Method | Incoming and outgoing transition edges | 20020704 | |
| 18 | Instance method | Public | Method | Returns SPI_TRUE if the step is an event | 20020924 | |
| 19 | Instance method | Public | Method | Gets SPI_TRUE, if Step Is System Event | 20040109 | |
| 20 | Instance method | Protected | Method | Gets Attribute Description for Process Step Instances | 20030825 |
Events
Class CL_SPI_STEP has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | SSPIIDATT | Protected | See coding | 20030825 | |
||
| 2 | TSPIIDATT | Protected | See coding | 20030825 | |
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_SEARCH_FILTER | Call by reference | Object reference (TYPE REF TO) | CL_SPI_SEARCH_FILTER | 20030626 | ||||
| 2 | IO_STEP | Value transfer | Object reference (TYPE REF TO) | CL_SPI_CU_STEP | Prozessschrittdaten aus dem Customizing | 20020705 | |||
| 3 | IT_TRANS | Call by reference | Type reference (TYPE) | TSPITRANS | Tabelle mit Übergängen | 20020709 |
Method CONSTRUCTOR on class CL_SPI_STEP has no exception.
Method EQUALS Signature
Method EQUALS on class CL_SPI_STEP has no parameter.
Method EQUALS on class CL_SPI_STEP has no exception.
Method GET_ATTRIBUTE Signature
Method GET_ATTRIBUTE on class CL_SPI_STEP has no parameter.
Method GET_ATTRIBUTE on class CL_SPI_STEP has no exception.
Method GET_ATTRIBUTES Signature
Method GET_ATTRIBUTES on class CL_SPI_STEP has no parameter.
Method GET_ATTRIBUTES on class CL_SPI_STEP has no exception.
Method GET_DESCRIPTION Signature
Method GET_DESCRIPTION on class CL_SPI_STEP has no parameter.
Method GET_DESCRIPTION on class CL_SPI_STEP has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_SEARCH_FILTER | Call by reference | Object reference (TYPE REF TO) | CL_SPI_SEARCH_FILTER | 20030626 | ||||
| 2 | IO_STEP | Call by reference | Object reference (TYPE REF TO) | CL_SPI_CU_STEP | Prozessschrittdaten aus dem Customizing | 20020909 | |||
| 3 | RP_STEP | Value transfer | Object reference (TYPE REF TO) | CL_SPI_STEP | Prozessschrittdefinition | 20020909 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahme aufgrund fehlender Berechtigung | 20021120 | ||
| 2 | PMI: Schrittausnahme | 20021120 |
Method GET_INSTANCE_ATTRIBUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_ATTRIBUTE_ID | Call by reference | Type reference (TYPE) | SSPIATTID | Attributid | 20030825 | |||
| 2 | RO_ATTR | Value transfer | Object reference (TYPE REF TO) | IF_SPI_ATTRIBUTE_DEFINITION | 20030825 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PMI: API-Ausnahme | 20030825 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20030825 |
Method GET_INSTANCE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ATTR | Call by reference | Type reference (TYPE) | TSPIATTR | 20030624 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PMI: API-Ausnahme | 20030624 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20030624 |
Method GET_INTERVAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_TIMEINT | Value transfer | Type reference (TYPE) | SSPITIMINT | UTC-Zeitintervall | 20020930 |
Method GET_INTERVAL on class CL_SPI_STEP has no exception.
Method GET_NAME Signature
Method GET_NAME on class CL_SPI_STEP has no parameter.
Method GET_NAME on class CL_SPI_STEP has no exception.
Method GET_PREDECESSORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_STEPS | Call by reference | Type reference (TYPE) | TSPISTEPD | Tabelle mit Instanzen von CL_SPI_STEP | 20030410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahme aufgrund fehlender Berechtigung | 20030410 | ||
| 2 | PMI: Schrittausnahme | 20030410 |
Method GET_PROCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_PROC | Value transfer | Object reference (TYPE REF TO) | CL_SPI_PROCESS | Prozessdefinition aus dem Customizing | 20020925 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahme aufgrund fehlender Berechtigung | 20021120 | ||
| 2 | PMI: Prozessausnahme | 20021120 |
Method GET_PROCESS_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_TYPE | Value transfer | Type reference (TYPE) | SPIPROCTP | SPI: ID eines Prozesstypen | 20021007 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahme aufgrund fehlender Berechtigung | 20021120 | ||
| 2 | PMI: Prozessausnahme | 20021120 |
Method GET_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_STEP | Value transfer | Object reference (TYPE REF TO) | CL_SPI_CU_STEP | Prozessschrittdaten aus dem Customizing | 20020823 |
Method GET_STEP on class CL_SPI_STEP has no exception.
Method GET_STEP_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_ID | Value transfer | Type reference (TYPE) | SPIPRSTID | SPI: ID eines Prozessschrittes | 20020726 |
Method GET_STEP_ID on class CL_SPI_STEP has no exception.
Method GET_SUCCESSORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_STEPS | Call by reference | Type reference (TYPE) | TSPISTEPD | Tabelle mit Instanzen von CL_SPI_STEP | 20030410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahme aufgrund fehlender Berechtigung | 20030410 | ||
| 2 | PMI: Schrittausnahme | 20030410 |
Method GET_TRANSITIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_IN | Call by reference | Type reference (TYPE) | TSPITRANS | Eingehende Übergänge | 20020704 | |||
| 2 | ET_OUT | Call by reference | Type reference (TYPE) | TSPITRANS | Ausgehende Übergänge | 20020704 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahme aufgrund fehlender Berechtigung | 20021120 | ||
| 2 | PMI: Schrittausnahme | 20021120 | ||
| 3 | PMI: Übergang-Ausnahme | 20021121 |
Method IS_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_BOOL | Value transfer | Type reference (TYPE) | SPIBOOL | SPI Global: Boolscher Wert | 20020924 |
Method IS_EVENT on class CL_SPI_STEP has no exception.
Method IS_SYSTEM_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_BOOL | Value transfer | Type reference (TYPE) | SPIBOOL | SPI Global: Boolscher Wert | 20040109 |
Method IS_SYSTEM_EVENT on class CL_SPI_STEP has no exception.
Method LOAD_INSTANCE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ATTR | Call by reference | Type reference (TYPE) | TSPIATTR | 20030825 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PMI: API-Ausnahme | 20030825 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20030825 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 630 |