SAP ABAP Class CL_TC_TASK_TEMPLATE (General task template class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-BTC (Application Component) Background Processing
     ⤷ SBTJOBAPI (Package) new background job API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BP_JOB_TEMPLATE	Background job template class	20000504

Properties

Class	CL_TC_TASK_TEMPLATE
Short Description	General task template class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SBTJOBAPI	new background job API
Created	20000504	SAP
Last change	20000504	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_TC_TASK_TEMPLATE has no forward declaration.

Interfaces

Class CL_TC_TASK_TEMPLATE has no interface implemented.

Friends

Class CL_TC_TASK_TEMPLATE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GUID	Instance attribute	Protected	☐	Type reference (TYPE)	CSMSYSGUID		Task GUID in char32 form	20000504
2	MODIFIED	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1		indicator for modification	20000504
3	NAME	Instance attribute	Public	☐	Type reference (TYPE)	BTCJOB		Background job name	20000504
4	STATE	Instance attribute	Protected	☐	Type reference (TYPE)	BTCSTATUS		Status of batch job	20000504

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_STATE	Instance method	Public	Method	Change the state of task	20000504
2	GET_NAME	Instance method	Public	Method	Get task name	20000504
3	GET_STATE	Instance method	Public	Method	Get task state	20000504
4	SET_GUID	Instance method	Public	Method	Set task GUID >>>> should be protected when friend is ready	20000504
5	SET_NAME	Instance method	Public	Method	Set task name	20000504
6	SET_STATE	Instance method	Public	Method	Set task state	20000504

Events

Class CL_TC_TASK_TEMPLATE has no event.

Types

Class CL_TC_TASK_TEMPLATE has no local type.

Method Signatures

Method CHANGE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SOURCE_STATE	Call by reference	☑	Type reference (TYPE)	BTCSTATUS		Status eines Hintergrundjobs	20000504
2	Importing	TARGET_STATE	Call by reference	☐	Type reference (TYPE)	BTCSTATUS		Status eines Hintergrundjobs	20000504

#	Exception	Resumable	Description	Created on
1	CURRENT_STATE_UNDEFINED	☐	Aktueller Status nicht definiert	20000504
2	ERROR_CHANGE_STATE	☐	Unbekannter Fehler bei Statuswechsel	20000504
3	INVALID_SOURCE_STATE	☐	Ungültiger Quellstatus	20000504
4	INVALID_TARGET_STATE	☐	Ungültiger Zielstatus	20000504

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	O_NAME	Value transfer	☐	Type reference (TYPE)	BTCJOB		Aufgabenname ausgeben	20000504

Method GET_NAME on class CL_TC_TASK_TEMPLATE has no exception.

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	O_STATE	Value transfer	☐	Type reference (TYPE)	BTCSTATUS		Status eines Hintergrundjobs	20000504

#	Exception	Resumable	Description	Created on
1	NO_STATE_AVAILABLE	☐	Für diese Aufgabe ist kein Status verfügbar	20000504

Method SET_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	CSMSYSGUID		Aufgaben-GUID eingeben	20000504

Method SET_GUID on class CL_TC_TASK_TEMPLATE has no exception.

Method SET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	BTCJOB	SPACE	Aufgabenname eingeben	20000504

Method SET_NAME on class CL_TC_TASK_TEMPLATE has no exception.

Method SET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STATE	Call by reference	☐	Type reference (TYPE)	BTCSTATUS		Status eines Hintergrundjobs	20000504

#	Exception	Resumable	Description	Created on
1	ERROR_SET_STATE	☐	Unbekannter Fehler bei Setzen des Aufgabenstatus	20000504
2	INVALID_INPUT_STATE	☐	Ungültiger Eingabestatus	20000504

History

Last changed by/on	SAP	20000504
SAP Release Created in	610