SAP ABAP Class CL_STCTM_TEMPLATE (Task List Variant)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-INS-TC-RT (Application Component) Runtime for ABAP based automated TC
⤷
STC_TM (Package) Technical Configuration Task Management
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SERIALIZABLE_OBJECT | Serializable Object | 20110413 |
Properties
| Class | CL_STCTM_TEMPLATE | |
| Short Description | Task List Variant | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | STC_TM | |
| Program status | ||
| Category | 0 | |
| Package | STC_TM | Technical Configuration Task Management |
| Created | 20110413 | SAP |
| Last change | 20141121 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SERIALIZABLE_OBJECT | Serializable Object | 20110413 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_STCTM_PERSISTENCE | 20130315 | Task List Run/Variant Persistence | |
| 2 | CL_STCTM_PREPROCESSOR | 20110413 | Task List Run/Variant Preprocessor (User Interface) | |
| 3 | CL_STCTM_XML_UTILITIES | 20130418 | Helper methods for XML processing |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_STCTM_TASKLIST | Task List | 20110413 | |||
| 2 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_STC_EMBEDDED_SCENARIO | Reference Task List used in Task List Run/Variant | 20130315 | |||
| 3 | Instance attribute | Public | Type reference (TYPE) | TS_TIMES | Create/Change Data | 20110413 | |||
| 4 | Instance attribute | Public | Type reference (TYPE) | CL_STCTM_PERSISTENCE=>TT_SECSTORE | Links to Secure Store | 20111130 | |||
| 5 | Instance attribute | Public | Type reference (TYPE) | STC_TEMPLATE_DESCR | Task List Variant Description | 20110413 | |||
| 6 | Instance attribute | Public | Type reference (TYPE) | LAISO | Content Language (ISO) | 20130304 | |||
| 7 | Instance attribute | Public | Type reference (TYPE) | STC_SCENARIO_ID | Task List | 20120113 | |||
| 8 | Instance attribute | Public | Type reference (TYPE) | STC_TEMPLATE_ID | Task List Variant | 20120113 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Can Task List Variant be maintained? | 20130304 | |
| 2 | Instance method | Public | Method | Consistency check of Task List Variant | 20120510 | |
| 3 | Instance method | Public | Method | Check if language is different to logon language | 20130311 | |
| 4 | Instance method | Public | Method | Check if Task List has changed | 20130311 | |
| 5 | Instance method | Public | Constructor | Constructor | 20110413 | |
| 6 | Instance method | Public | Method | Check if Tasklist contains secure content | 20120103 | |
| 7 | Static method | Public | Method | Create Task List Variant from Task List | 20110413 | |
| 8 | Static method | Public | Method | Create Task List Variant from Task List Run | 20110413 | |
| 9 | Static method | Public | Method | Create Task List Variant from different Task List Variant | 20110413 | |
| 10 | Static method | Public | Method | Create Task List Variant from XML | 20110418 | |
| 11 | Instance method | Public | Method | Get list of tasks for external usage | 20121214 | |
| 12 | Instance method | Public | Method | Get hash value for Variant (e.g. to determine data changes) | 20111130 | |
| 13 | Instance method | Public | Method | Get all external parameters from Tasks | 20121026 | |
| 14 | Instance method | Public | Method | Get possible task actions | 20121218 | |
| 15 | Instance method | Public | Method | Get Task List informations used for Variant | 20130311 | |
| 16 | Instance method | Public | Method | Get Task List Variant in XML form | 20110418 | |
| 17 | Static method | Public | Method | Load Task List Variant from persistence | 20110413 | |
| 18 | Instance method | Public | Method | Update task list variant and add missing data after reload | 20130704 | |
| 19 | Instance method | Public | Method | Reset Task List Variant | 20120103 | |
| 20 | Instance method | Public | Method | Save Task List Variant | 20110413 | |
| 21 | Instance method | Private | Event handling method | Update Runtime Informations for Tasklist | 20120116 |
Events
Class CL_STCTM_TEMPLATE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TS_TIMES | Public | See coding | 20110413 | BEGIN OF ts_times,
created_by TYPE cruser,
created_on TYPE stc_crtimestamp,
changed_by TYPE chuser,
changed_on TYPE stc_chtimestamp,
END OF ts_times
|
Method Signatures
Method CAN_TEMPLATE_BE_MAINTAINED Signature
Method CAN_TEMPLATE_BE_MAINTAINED on class CL_STCTM_TEMPLATE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task list variant cannot be maintained | 20130304 |
Method CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_MESSAGES | Task Manager Messages | 20120510 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List Variant is inconsistent | 20120510 |
Method CHECK_LANGU_DIFF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | Content Language | 20130311 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Language in Run is different to logon language | 20130311 |
Method CHECK_SCENARIO_DIFF Signature
Method CHECK_SCENARIO_DIFF on class CL_STCTM_TEMPLATE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List dont exist (anymore) | 20130311 | ||
| 2 | Task List has changed | 20130311 |
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_STCTM_TEMPLATE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Invalid | 20110413 |
Method CONTAINS_SECURE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CONTAINS_SECDATA | Value transfer | Type reference (TYPE) | BOOLEAN | 'X' - Run contains secure data | 20120103 |
Method CONTAINS_SECURE_DATA on class CL_STCTM_TEMPLATE has no exception.
Method CREATE_FROM_SCENARIO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_TEMPLATE | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TEMPLATE | Task List Variant | 20130418 | |||
| 2 | IT_TASK | Call by reference | Type reference (TYPE) | IF_STCTM_TASK=>TT_TASK | List of Tasks | 20130416 | |||
| 3 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | STC_TEMPLATE_DESCR | Task List Variant Description | 20110421 | |||
| 4 | I_SCENARIO_ID | Call by reference | Type reference (TYPE) | STC_SCENARIO_ID | Task List | 20110413 | |||
| 5 | I_TEMPLATE_ID | Call by reference | Type reference (TYPE) | STC_TEMPLATE_ID | Task List Variant | 20120113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List Variant can't be created | 20110413 | ||
| 2 | Task List don't exists | 20110413 |
Method CREATE_FROM_SESSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_SESSION | Task List Run | 20110413 | |||
| 2 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | STC_TEMPLATE_DESCR | Task List Variant Description | 20110421 | |||
| 3 | I_SESSION_ID | Call by reference | Type reference (TYPE) | STC_SESSION_ID | Task List Run | 20110413 | |||
| 4 | I_TEMPLATE_ID | Call by reference | Type reference (TYPE) | STC_TEMPLATE_ID | Task List Variant | 20120113 | |||
| 5 | RR_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | CL_STCTM_TEMPLATE | Task List Variant | 20110413 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List Variant can't be created | 20110413 | ||
| 2 | Not authorized to create Variants | 20110414 | ||
| 3 | Task List Run don't exists | 20110413 |
Method CREATE_FROM_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_TEMPLATE | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TEMPLATE | Task List Variant | 20130418 | |||
| 2 | IR_TEMPLATE | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TEMPLATE | Task List Variant | 20110414 | |||
| 3 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | STC_TEMPLATE_DESCR | Task List Variant Description | 20110421 | |||
| 4 | I_SCENARIO_ID | Call by reference | Type reference (TYPE) | STC_SCENARIO_ID | TC Task List | 20110414 | |||
| 5 | I_TEMPLATE_ID | Call by reference | Type reference (TYPE) | STC_TEMPLATE_ID | Task List Variant | 20110414 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List Variant can't be created | 20110413 | ||
| 2 | Not authorized to create Task List Variants | 20110414 | ||
| 3 | Task List Variant don't exists | 20110413 |
Method CREATE_FROM_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_TEMPLATE | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TEMPLATE | TC Task List Variant | 20130418 | |||
| 2 | I_CHECK_SCENARIO_ID | Call by reference | Type reference (TYPE) | STC_SCENARIO_ID | Task List | 20120126 | |||
| 3 | I_CHECK_TEMPLATE_ID | Call by reference | Type reference (TYPE) | STC_TEMPLATE_ID | Task List Variant | 20120126 | |||
| 4 | I_XML | Call by reference | Type reference (TYPE) | XSTRING | 20110418 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List Run can't be created | 20110418 |
Method GET_EXTERNAL_TASKLIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_TASKLIST | Call by reference | Type reference (TYPE) | STCTM_T_TASK | List of Tasks | 20121214 | |||
| 2 | I_DISPLAY_MODE | Call by reference | Type reference (TYPE) | SAP_BOOL | Display Mode | 20130318 | |||
| 3 | I_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | 'E' | Language | 20121214 |
Method GET_EXTERNAL_TASKLIST on class CL_STCTM_TEMPLATE has no exception.
Method GET_HASH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_HASH | Value transfer | Type reference (TYPE) | HASH160 | Hash Value (160 Bits) | 20111130 |
Method GET_HASH on class CL_STCTM_TEMPLATE has no exception.
Method GET_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_MESSAGES | Task Manager Messages | 20130111 | |||
| 2 | ET_PARAMETER | Call by reference | Type reference (TYPE) | STCTM_TX_VALUE | List of Task Parameter Values | 20121026 | |||
| 3 | ET_PARAM_DEF | Call by reference | Type reference (TYPE) | STCTM_TX_PARAMETER | List of Task Parameter | 20121026 | |||
| 4 | I_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | Get parameters in specified Language | 20121112 |
Method GET_PARAMETERS on class CL_STCTM_TEMPLATE has no exception.
Method GET_POSSIBLE_TASK_ACTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_CONFIRM | Call by reference | Type reference (TYPE) | SAP_BOOL | 'X' if (manual activity) task can be confirmed | 20121218 | |||
| 2 | E_MAINTAIN | Call by reference | Type reference (TYPE) | SAP_BOOL | 'X' if parameter of (user interface) task can be maintained | 20121218 | |||
| 3 | E_SKIP | Call by reference | Type reference (TYPE) | SAP_BOOL | 'X' if task can be skipped | 20121218 | |||
| 4 | E_UNSKIP | Call by reference | Type reference (TYPE) | SAP_BOOL | 'X' if task can be set in scope | 20121218 | |||
| 5 | IR_TASK | Call by reference | Object reference (TYPE REF TO) | IF_STCTM_TASK | Technical Configuration Task | 20121218 | |||
| 6 | I_DISPLAY_MODE | Call by reference | Type reference (TYPE) | SAP_BOOL | 'X' if display mode, ' ' if change mode | 20121218 |
Method GET_POSSIBLE_TASK_ACTIONS on class CL_STCTM_TEMPLATE has no exception.
Method GET_USED_SCENARIO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_SCENARIO | Value transfer | Object reference (TYPE REF TO) | IF_STC_SCENARIO | Task List Interface | 20130311 |
Method GET_USED_SCENARIO on class CL_STCTM_TEMPLATE has no exception.
Method GET_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_XML | Call by reference | Type reference (TYPE) | XSTRING | Task List Variant XML | 20121012 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XML is invalid | 20110418 |
Method LOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_TEMPLATE | Call by reference | Object reference (TYPE REF TO) | CL_STCTM_TEMPLATE | TC Task List Variant | 20130418 | |||
| 2 | I_SCENARIO_ID | Call by reference | Type reference (TYPE) | STC_SCENARIO_ID | TC Task List | 20110413 | |||
| 3 | I_TEMPLATE_ID | Call by reference | Type reference (TYPE) | STC_TEMPLATE_ID | TC Task List Variant | 20110413 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Task List Variant is invalid | 20110413 | ||
| 2 | Not authorized to load Task List Variants | 20110413 | ||
| 3 | Task List Variant does not exist | 20110413 |
Method RECOVER_MISSING_DATA Signature
Method RECOVER_MISSING_DATA on class CL_STCTM_TEMPLATE has no parameter.
Method RECOVER_MISSING_DATA on class CL_STCTM_TEMPLATE has no exception.
Method RESET Signature
Method RESET on class CL_STCTM_TEMPLATE has no parameter.
Method RESET on class CL_STCTM_TEMPLATE has no exception.
Method SAVE Signature
Method SAVE on class CL_STCTM_TEMPLATE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Invalid | 20110413 | ||
| 2 | Not authorized to save Task List Variant | 20110413 |
Method UPDATE_TASKLIST_RUNTIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_RT_INFO | Call by reference | Attribute reference (LIKE) | 20120116 |
Method UPDATE_TASKLIST_RUNTIME on class CL_STCTM_TEMPLATE has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 731 |