SAP ABAP Class CL_BP_JOB (General job class)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_TC_TASK	General task class	19991123
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BP_DB_TRANSACTION	Database transaction regarding new job API	20000229
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BP_JOB_CHECK	Check whether a job is properly defined	20000218
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BP_JOB_ENGINE	Job engine to start a background job	20000229

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BP_ABAP_JOB	Background ABAP job class	20000218
2	Inheritance (c INHERITING FROM c_ref)	CL_BP_EXTERNAL_JOB	Class for external background jobs	20000503
3	Inheritance (c INHERITING FROM c_ref)	CL_BP_EXTERNAL_JOB_TEMPLATE	Class for external background job template class	20000728
4	Inheritance (c INHERITING FROM c_ref)	CL_BP_PERIODIC_JOB	Periodic job class	20000505

Properties

Class	CL_BP_JOB
Short Description	General job class
Super Class	CL_TC_TASK	General task 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	19991123	SAP
Last change	20000426	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BP_JOB has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BP_DB_TRANSACTION	☐	☐	Database transaction regarding new job API	20000229
2	IF_BP_JOB_CHECK	☐	☐	Check whether a job is properly defined	20000218
3	IF_BP_JOB_ENGINE	☐	☐	Job engine to start a background job	20000229

Friends

Class CL_BP_JOB has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COMPLETED_OBS	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1	SPACE	Appl. assumes job is defined -- obsolete	20000706
2	JOBCOUNT	Instance attribute	Public	☐	Type reference (TYPE)	BTCJOBCNT		The reference to tbtco	20000217
3	JOB_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	BPJOBTYP		Job type for new Job API	20000208
4	RELEASE	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1		Single-character flag for release	19991123
5	RESTART	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1	SPACE	Flag for restarting the job	20000404
6	TRG_GUID	Instance attribute	Public	☐	Type reference (TYPE)	CSMSYSGUID		Reference to trigger GUID-char32	19991123
7	TRG_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	TRGTYPE		Background trigger type	20000122

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_TRIGGER	Instance method	Public	Method	Attach trigger to the job	20000229
2	GENERATE_JOB_COUNT	Instance method	Protected	Method		20000229
3	GET_JOB_TYPE	Instance method	Public	Method	get job type	20000208
4	GET_RESTART_FLAG	Instance method	Public	Method	Get restart flag for job	20000405
5	IS_DEFINED	Instance method	Protected	Method		20000218
6	LOCK_ENTRY	Instance method	Public	Method	Lock the job entry in job table	20000210
7	PLAN_JOB	Instance method	Public	Method		20000307
8	PLAN_JOB_STEP	Instance method	Protected	Method		20000229
9	RELEASE_JOB	Instance method	Public	Method		20000229
10	SAVE_DB	Instance method	Public	Method		20000229
11	SET_COMPLETED	Instance method	Public	Method		20000218
12	SET_JOBCOUNT	Instance method	Public	Method	For factory ONLY! >>change to protected when friend is ready	20000424
13	SET_JOB_TYPE	Instance method	Public	Method	set job type	20000208
14	SET_RESTART_FLAG	Instance method	Public	Method	Set restart flag for job	20000405
15	SET_TRG_GUID	Instance method	Public	Method	Set trigger GUID >>>change to protected when friend is ready	20000107
16	SET_TRG_TYPE	Instance method	Public	Method	Set trigger Type >>>change to protected when friend is ready	20000122
17	START_IMMEDIATELY	Instance method	Protected	Method		20000229
18	START_SIMPLE	Instance method	Public	Method	Start the job immediately	20000229
19	UNLOCK_ENTRY	Instance method	Public	Method	Unlock the job entry in job table	20000210
20	UPDATE_DB	Instance method	Public	Method		20000229

Events

Class CL_BP_JOB has no event.

Types

Class CL_BP_JOB has no local type.

Method Signatures

Method ATTACH_TRIGGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRIGGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_TC_REGULAR_TRIGGER		Eingabe-Trigger-GUID	20000229

Method ATTACH_TRIGGER on class CL_BP_JOB has no exception.

Method GENERATE_JOB_COUNT Signature

Method GENERATE_JOB_COUNT on class CL_BP_JOB has no parameter.
Method GENERATE_JOB_COUNT on class CL_BP_JOB has no exception.

Method GET_JOB_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	O_JOB_TYPE	Call by reference	☐	Type reference (TYPE)	BPJOBTYP		Jobtyp für neue Job-API	20000210

Method GET_JOB_TYPE on class CL_BP_JOB has no exception.

Method GET_RESTART_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	O_RESTART_FLAG	Call by reference	☐	Type reference (TYPE)	CHAR1		Ausgabe Neustartkennzeichen	20000405

Method GET_RESTART_FLAG on class CL_BP_JOB has no exception.

Method IS_DEFINED Signature

Method IS_DEFINED on class CL_BP_JOB has no parameter.
Method IS_DEFINED on class CL_BP_JOB has no exception.

Method LOCK_ENTRY Signature

Method LOCK_ENTRY on class CL_BP_JOB has no parameter.

#	Exception	Resumable	Description	Created on
1	FOREIGN_LOCK_EXCEPTION	☐	Objekt ist bereits gesperrt	20000210
2	SYSTEM_FAILURE_EXCEPTION	☐	Interner Fehler vom Enqueue-Server	20000210
3	UNKNOWN_EXCEPTION	☐	Unbekannte Ausnahmen	20000210

Method PLAN_JOB Signature

Method PLAN_JOB on class CL_BP_JOB has no parameter.
Method PLAN_JOB on class CL_BP_JOB has no exception.

Method PLAN_JOB_STEP Signature

Method PLAN_JOB_STEP on class CL_BP_JOB has no parameter.
Method PLAN_JOB_STEP on class CL_BP_JOB has no exception.

Method RELEASE_JOB Signature

Method RELEASE_JOB on class CL_BP_JOB has no parameter.
Method RELEASE_JOB on class CL_BP_JOB has no exception.

Method SAVE_DB Signature

Method SAVE_DB on class CL_BP_JOB has no parameter.
Method SAVE_DB on class CL_BP_JOB has no exception.

Method SET_COMPLETED Signature

Method SET_COMPLETED on class CL_BP_JOB has no parameter.
Method SET_COMPLETED on class CL_BP_JOB has no exception.

Method SET_JOBCOUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT		Jobzähler setzen --- NUR für Factory!	20000424

Method SET_JOBCOUNT on class CL_BP_JOB has no exception.

Method SET_JOB_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_JOB_TYPE	Call by reference	☐	Type reference (TYPE)	BPJOBTYP	SPACE	Jobtyp für neue Job-API	20000210

Method SET_JOB_TYPE on class CL_BP_JOB has no exception.

Method SET_RESTART_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RESTART_FLAG	Call by reference	☐	Type reference (TYPE)	CHAR1		Eingabe Neustartkennzeichen	20000405

Method SET_RESTART_FLAG on class CL_BP_JOB has no exception.

Method SET_TRG_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRG_GUID	Call by reference	☐	Type reference (TYPE)	CSMSYSGUID	SPACE	Eingabe-Trigger-GUID (Char32)	20000107

Method SET_TRG_GUID on class CL_BP_JOB has no exception.

Method SET_TRG_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRG_TYPE	Call by reference	☐	Type reference (TYPE)	TRGTYPE		Hintergrund-Trigger-Typ	20000122

Method SET_TRG_TYPE on class CL_BP_JOB has no exception.

Method START_IMMEDIATELY Signature

Method START_IMMEDIATELY on class CL_BP_JOB has no parameter.
Method START_IMMEDIATELY on class CL_BP_JOB has no exception.

Method START_SIMPLE Signature

Method START_SIMPLE on class CL_BP_JOB has no parameter.
Method START_SIMPLE on class CL_BP_JOB has no exception.

Method UNLOCK_ENTRY Signature

Method UNLOCK_ENTRY on class CL_BP_JOB has no parameter.
Method UNLOCK_ENTRY on class CL_BP_JOB has no exception.

Method UPDATE_DB Signature

Method UPDATE_DB on class CL_BP_JOB has no parameter.
Method UPDATE_DB on class CL_BP_JOB has no exception.

History

Last changed by/on	SAP	20000426
SAP Release Created in	46C