SAP ABAP Interface IF_BP_JOB_ENGINE (Job engine to start a background job)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-BTC (Application Component) Background Processing
⤷
SBTJOBAPI (Package) new background job API
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 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_BP_JOB | General job class | 20000229 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_BP_JOB_TEMPLATE | Background job template class | 20000505 |
Properties
| Interface | IF_BP_JOB_ENGINE | |
| Short Description | Job engine to start a background job |
General Data
| Package | SBTJOBAPI | new background job API |
| Created | 20000229 | SAP |
| Last changed | 00000000 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_BP_JOB_ENGINE has no forward declaration.
Interfaces
Interface IF_BP_JOB_ENGINE has no interface.
Friends
Interface IF_BP_JOB_ENGINE has no friend.
Attributes
Interface IF_BP_JOB_ENGINE has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GENERATE_JOB_COUNT |
Instance method | Public | Method | Generate job count | 20000229 |
| 2 | PLAN_JOB |
Instance method | Public | Method | Plan job (without starting condition) | 20000301 |
| 3 | PLAN_JOB_STEP |
Instance method | Public | Method | Schedule one step for the job | 20000229 |
| 4 | RELEASE_JOB |
Instance method | Public | Method | Attach start condition to the job | 20000229 |
| 5 | START_IMMEDIATELY |
Instance method | Public | Method | Start the job immediately | 20000229 |
Events
Interface IF_BP_JOB_ENGINE has no event.
Types
Interface IF_BP_JOB_ENGINE has no local type.
Method Signatures
Method GENERATE_JOB_COUNT Signature
Method GENERATE_JOB_COUNT on Interface IF_BP_JOB_ENGINE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CANT_CREATE_JOB |
Job kann nicht angelegt werden, siehe SYSLOG | 20000229 | |
| 2 | INVALID_JOB_DATA |
Job enthält ungültige Jobdaten, siehe SYSLOG | 20000229 | |
| 3 | JOBNAME_MISSING |
Jobname nicht angegeben | 20000229 |
Method PLAN_JOB Signature
Method PLAN_JOB on Interface IF_BP_JOB_ENGINE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | GENERATE_JOB_COUNT_FAILED |
Jobzähler wurde nicht generiert | 20000404 | |
| 2 | JOB_NOT_WELL_DEFINED |
Job ist nicht vollständig definiert | 20000404 | |
| 3 | PLAN_JOB_STEP_FAILED |
Job-Step wurde nicht geplant | 20000404 |
Method PLAN_JOB_STEP Signature
Method PLAN_JOB_STEP on Interface IF_BP_JOB_ENGINE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | BAD_PRIPARAMS |
Falsche Druck-/Archivierungsparameter | 20000229 | |
| 2 | BAD_XPGFLAGS |
Falsche Steuerungskennzeichen für externes Programm | 20000229 | |
| 3 | INVALID_JOBDATA |
Fehler in Jobdaten, siehe SYSLOG | 20000229 | |
| 4 | JOBNAME_MISSING |
Jobname nicht angegeben | 20000229 | |
| 5 | JOB_NOTEX |
Angegebener Job nicht vorhanden | 20000229 | |
| 6 | JOB_SUBMIT_FAILED |
Job-Übergabe mißlang, siehe SYSLOG | 20000229 | |
| 7 | PROGRAM_MISSING |
Auszuführendes Programm nicht angegeben | 20000229 | |
| 8 | PROG_ABAP_AND_EXTPG_SET |
ABAP- und externes Programm angegeben | 20000229 |
Method RELEASE_JOB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
I_TRG_OBJ | Call by reference | Object reference (TYPE REF TO) | CL_TC_REGULAR_TRIGGER | Jobstart-Trigger | 20000229 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANT_START_IMMEDIATE |
Falsche Druck-/Archivierungsparameter | 20000404 | |
| 2 | INVALID_STARTDATE |
Ungültiges Startdatum | 20000404 | |
| 3 | JOBNAME_MISSING |
Jobname fehlt (Platzhalter zulässig) | 20000229 | |
| 4 | JOB_CLOSE_FAILED |
Fehler bei JOB_CLOSE, siehe SYSLOG | 20000404 | |
| 5 | JOB_NOSTEPS |
Angegebener Job enthält keine Steps | 20000404 | |
| 6 | JOB_NOTEX |
Angegebener Job nicht vorhanden | 20000229 | |
| 7 | LOCK_FAILED |
Sperrversuch mißlang | 20000404 |
Method START_IMMEDIATELY Signature
Method START_IMMEDIATELY on Interface IF_BP_JOB_ENGINE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANT_START_IMMEDIATE |
Sofortstart nicht möglich | 20000229 | |
| 2 | INVALID_STARTDATE |
Startdaten nicht gültig | 20000229 | |
| 3 | JOBNAME_MISSING |
Jobname fehlt (Platzhalter zulässig) | 20000229 | |
| 4 | JOB_CLOSE_FAILED |
Fehler bei JOB_CLOSE, siehe SYSLOG | 20000229 | |
| 5 | JOB_NOSTEPS |
Angegebener Job enthält keine Steps | 20000229 | |
| 6 | JOB_NOTEX |
Angegebener Job nicht vorhanden | 20000229 |
History
| Last changed by/on | SAP | 00000000 |
| SAP Release Created in | 46D |
