SAP ABAP Interface IF_STCTM_BG_TASK (Background Task)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-INS-TC-RT (Application Component) Runtime for ABAP based automated TC
⤷
STC_TASK (Package) Technical Configuration Task Definition
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-INS-TC-RT (Application Component) Runtime for ABAP based automated TC⤷
STC_TASK (Package) Technical Configuration Task Definition
Meta Relationship - Used By
Properties
| Interface | IF_STCTM_BG_TASK | |
| Short Description | Background Task |
General Data
| Package | STC_TASK | Technical Configuration Task Definition |
| Created | 20101115 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | IF_STCTM_TASK | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | T | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SERIALIZABLE_OBJECT | Serializable Object | 20101115 | ||
| 2 | IF_STCTM_TASK | Technical Configuration Task | 20101115 |
Friends
Interface IF_STCTM_BG_TASK has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_BOOL | Instance attribute | Public | Attribute reference (LIKE) | 20101115 | ||||
| 2 | PR_LOG | Instance attribute | Public | Attribute reference (LIKE) | 20101115 | ||||
| 3 | PT_PREDECESSOR | Instance attribute | Public | Attribute reference (LIKE) | 20101115 | ||||
| 4 | PT_SUCCESSOR | Instance attribute | Public | Attribute reference (LIKE) | 20101115 | ||||
| 5 | P_STATUS | Instance attribute | Public | Attribute reference (LIKE) | 20101115 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECKMODE |
Instance method | Public | Method | Task Supports Checkmode | 20101201 |
| 2 | EXECUTE |
Instance method | Public | Method | Execute Task | 20101115 |
| 3 | IS_NECESSARY |
Instance method | Public | Method | 20101115 | |
| 4 | LONGRUNNER |
Instance method | Public | Method | Task is Longrunner (must be executed in Batch) | 20101206 |
| 5 | RESUMABLE |
Instance method | Public | Method | Task is Resumable | 20101118 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | UPDATE_PROGRESS | Instance Event (0) |
Public (2) |
Trigger task manager to save intermediate progress | 20130627 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_PROGRESS | Public | Attribute reference (LIKE) | 20130627 | |
Method Signatures
Method CHECKMODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_TASKLIST | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TASKLIST | Configured List of Tasks | 20111205 | ||
| 2 |  Returning |
R_CHECKMODE | Value transfer | Type reference (TYPE) | IF_STCTM_TASK=>T_BOOL | Checkmode is Supported | 20101201 |
Method CHECKMODE on Interface IF_STCTM_BG_TASK has no exception.
Method EXECUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_TASKLIST | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TASKLIST | Configured List of Tasks | 20101115 | ||
| 2 | Importing |
I_CHECK | Call by reference | Type reference (TYPE) | STC_CHECKRUN | No Changes, Checking and Simulation only | 20101201 | ||
| 3 | Importing |
I_TRACE | Call by reference | Type reference (TYPE) | STC_TRACE | Log Detailed Information | 20101115 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ERROR_OCCURED |
Execution Ended in Error | 20101116 | |
| 2 | WARNING_OCCURED |
Execution Ended with Warning | 20101116 |
Method IS_NECESSARY Signature
Method IS_NECESSARY on Interface IF_STCTM_BG_TASK has no parameter.
Method IS_NECESSARY on Interface IF_STCTM_BG_TASK has no exception.
Method LONGRUNNER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_TASKLIST | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TASKLIST | Configured List of Tasks | 20111205 | ||
| 2 | Returning |
R_LONGRUNNER | Value transfer | Type reference (TYPE) | IF_STCTM_TASK=>T_BOOL | Task need to be executed in batch mode | 20101206 |
Method LONGRUNNER on Interface IF_STCTM_BG_TASK has no exception.
Method RESUMABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_TASKLIST | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TASKLIST | Configured List of Tasks | 20101118 | ||
| 2 | Returning |
R_RESUMABLE | Value transfer | Type reference (TYPE) | IF_STCTM_TASK=>T_BOOL | Is Task resumable after failed execution | 20101118 |
Method RESUMABLE on Interface IF_STCTM_BG_TASK has no exception.
Event Signatures
Event UPDATE_PROGRESS Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PROGRESS | Exporting | Value transfer | Type reference (TYPE) | T_PROGRESS | Progress in percent (0-100) | 20130627 |
Meta Relationship - Used By (full list)
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 703 |
