SAP ABAP Class CL_STC_SCENARIO_FACTORY (Task List Factory)

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

Properties

Class	CL_STC_SCENARIO_FACTORY
Short Description	Task List Factory
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	STC_TM
Program status
Category	0
Package	STC_TM	Technical Configuration Task Management
Created	20101126	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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...

Interfaces

Class CL_STC_SCENARIO_FACTORY has no interface implemented.

Friends

Class CL_STC_SCENARIO_FACTORY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_CONFIG_CLASS	Static Attribute	Private	☐	Type reference (TYPE)	TT_CONFIG_CLASS			20131106
2	MT_SCENARIO	Static Attribute	Private	☐	Type reference (TYPE)	TT_SCENARIO			20101207

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_NAME	Static method	Public	Method	Check Task List ID	20110211
2	COPY_SCENARIO	Static method	Public	Method	Copy Task List	20101217
3	CREATE_NEW_SCENARIO	Static method	Public	Method	Create new Task List	20101215
4	CREATE_TEMP_SCENARIO	Static method	Public	Method	Create temporary Task List (no persistence)	20130315
5	DELETE_SCENARIO	Static method	Public	Method	Delete Task List	20101217
6	DOCU_WHERE_USED	Static method	Public	Method	Check for task list docu reuse	20120302
7	GENERATE_SCENARIO_ID	Static method	Public	Method	Generate Task List ID	20130315
8	GET_CONFIG_CLASS_INSTANCE	Static method	Public	Method	Get instance of configuration class	20131106
9	GET_SCENARIO_BY_ID	Static method	Public	Method	Get Task List by ID	20101126
10	REFRESH_BUFFER	Static method	Public	Method	Clear Task List Buffer inside Factory	20131106

Events

Class CL_STC_SCENARIO_FACTORY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_CONFIG_CLASS	Private	See coding		Configuration Class	20131106	BEGIN OF ts_config_class, classname TYPE stc_scenario_config_class, instance TYPE REF TO cl_stc_scenario_config, END OF ts_config_class
2	TT_CONFIG_CLASS	Private	See coding		List of Configuration Classes	20131106	tt_config_class TYPE HASHED TABLE OF ts_config_class WITH UNIQUE KEY classname
3	TT_SCENARIO	Private	See coding			20101207	tt_scenario TYPE HASHED TABLE OF t_scenario WITH UNIQUE KEY id
4	T_SCENARIO	Private	See coding			20101207	begin of t_scenario, id type stc_scenario_id, ref type ref to cl_stc_scenario, end of t_scenario

Method Signatures

Method CHECK_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Task List	20110211

#	Exception	Resumable	Description	Created on
1	CX_STC_SCENARIO	☐	Task List Exception	20110211

Method COPY_SCENARIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COPY_DOCU_LINK	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	SPACE	Copy link to docu?	20110303
2	Importing	IV_DST_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Scenario ID	20101217
3	Importing	IV_SRC_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Scenario ID	20101217

#	Exception	Resumable	Description	Created on
1	CX_STC_AUTHORITY	☐	Authority Exception	20110411
2	CX_STC_SCENARIO	☐	Scenario Exception	20101217

Method CREATE_NEW_SCENARIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Scenario ID	20101215
2	Returning	RR_SCENARIO	Value transfer	☐	Object reference (TYPE REF TO)	IF_STC_SCENARIO		Technical Configuration Scenario	20101215

#	Exception	Resumable	Description	Created on
1	CX_STC_AUTHORITY	☐	Authority Exception	20110411
2	CX_STC_SCENARIO	☐	Scenario Exception	20101215

Method CREATE_TEMP_SCENARIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TASK	Call by reference	☐	Type reference (TYPE)	IF_STCTM_TASK=>TT_TASK		List of Tasks	20130416
2	Importing	IV_SCENARIO_ID	Call by reference	☑	Type reference (TYPE)	STC_SCENARIO_ID		Task List	20130315
3	Returning	RR_SCENARIO	Value transfer	☐	Object reference (TYPE REF TO)	IF_STC_SCENARIO		Task List Interface	20130315

#	Exception	Resumable	Description	Created on
1	CX_STC_SCENARIO	☐	Task List Exception	20130315

Method DELETE_SCENARIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Scenario ID	20101217

#	Exception	Resumable	Description	Created on
1	CX_STC_AUTHORITY	☐	Authority Exception	20110411
2	CX_STC_SCENARIO	☐	Scenario Exception	20101217

Method DOCU_WHERE_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SCENARIO	Call by reference	☐	Type reference (TYPE)	STC_T_SCENARIO		List of Task Lists	20120302
2	Importing	IV_DOKU_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Document class	20120302
3	Importing	IV_DOKU_OBJ	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20120302

Method DOCU_WHERE_USED on class CL_STC_SCENARIO_FACTORY has no exception.

Method GENERATE_SCENARIO_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SCENARIO_ID	Value transfer	☐	Type reference (TYPE)	STC_SCENARIO_ID		Task List	20130315

Method GENERATE_SCENARIO_ID on class CL_STC_SCENARIO_FACTORY has no exception.

Method GET_CONFIG_CLASS_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_CONFIG_CLASS	Call by reference	☐	Object reference (TYPE REF TO)	CL_STC_SCENARIO_CONFIG		Define Task List Configuration	20131106
2	Importing	IV_CONFIG_CLASS	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_CONFIG_CLASS		Task List Configuration Class	20131106
3	Importing	IV_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Task List ID	20131106

#	Exception	Resumable	Description	Created on
1	CX_STC_SCENARIO	☐	Task List Exception	20131106

Method GET_SCENARIO_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Scenario ID	20101126
2	Importing	IV_VISIBILITY_CHECK	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	SPACE	'X' = check visibility	20131106
3	Returning	RR_SCENARIO	Value transfer	☐	Object reference (TYPE REF TO)	IF_STC_SCENARIO		Technical Configuration Scenario	20101126

#	Exception	Resumable	Description	Created on
1	CX_STC_SCENARIO	☐	Task List Exception	20101207

Method REFRESH_BUFFER Signature

Method REFRESH_BUFFER on class CL_STC_SCENARIO_FACTORY has no parameter.
Method REFRESH_BUFFER on class CL_STC_SCENARIO_FACTORY has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	703