SAP ABAP Class CL_XMS_JOBS (Message Processing Jobs)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-IEN (Application Component) Integration Engine
     ⤷ SXMSJOB (Package) XI: Time-Driven Message Processing
Properties
Class CL_XMS_JOBS  
Short Description Message Processing Jobs    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SXMSJOB   XI: Time-Driven Message Processing 
Created 20030417   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_XMS_JOBS has no forward declaration.
Interfaces
Class CL_XMS_JOBS has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_XMS_JOB 20030422 Job for Delayed Message Processing
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 _INSTANCE Static Attribute Protected Object reference (TYPE REF TO) CL_XMS_JOBS 20030417
2 _JOBS_TAB Instance attribute Protected Type reference (TYPE) SXMSJOBS_TTYP 20030422
3 _MSGDEFS Instance attribute Protected Object reference (TYPE REF TO) CL_XMS_FILTERS_JOB 20030417
Methods
# Method Level Visibility Method type Description Created on
1 ACTIVATION_AUTHORITY Instance method Public Method Activation Authorization 20030630
2 ALLOW_JOB_TO_RUN Instance method Public Method Removes read lock 20030910
3 CHANGE_AUTHORITY Instance method Public Method Change Authorization 20030630
4 CHECK_AND_DELETE Instance method Public Method Consistency Check and Delete 20030915
5 CHECK_AND_INSERT Instance method Public Method Consistency Check and Insert 20030915
6 CHECK_AND_UPDATE Instance method Public Method Consistency Check and Update 20030915
7 CHECK_DELETE Instance method Public Method Consistency Check During Delete 20030915
8 CHECK_INSERT Instance method Public Method Consistency Check During Insert 20030915
9 CHECK_MESSAGE Instance method Public Method Checks XI message for filter criteria 20030424
10 CHECK_MESSAGE_OUTBOUND Instance method Public Method Checks XI message for filter criteria 20040206
11 CHECK_NAME_RULE Instance method Public Method Consistency Check During Insert 20031105
12 CHECK_ON_RUNNING_JOB Instance method Public Method Checks whether a job is running 20030606
13 CHECK_UPDATE Instance method Public Method Consistency Check During Update 20031020
14 COMMIT_WORK Instance method Public Method Commit 20030606
15 CONSTRUCTOR Instance method Public Constructor Constructor 20030417
16 DELETE_JOB Instance method Protected Method Deletes Job 20030423
17 DETERMINE_MINUTES_FROM_UNIT Instance method Public Method Calculates in Minutes 20031013
18 DISPLAY_AUTHORITY Instance method Public Method Display Authorization 20030630
19 DISPLAY_AUTHORITY_S Static method Public Method Display Authorization 20070911
20 EXECUTE_AUTHORITY Instance method Public Method Start Authorization 20030630
21 EXISTS_JOB Instance method Public Method Does Job Exist Inactively in SXMSJOBS or as WebAS Job? 20031022
22 GET_INSTANCE Static method Public Method 20030417
23 GET_JOB Instance method Public Method Factory Method for CL_XMS_JOB 20030422
24 GET_JOBS_TO_START Instance method Public Method Determines all jobs that have to be started 20030422
25 GET_JOB_ID_IN_CLIENTS Instance method Public Method In which client is JOB ID used? 20030725
26 GET_JOB_INT Instance method Protected Method 20050228
27 GET_JOB_LIST Instance method Public Method Transfers a list of jobs 20030506
28 GET_SCHEDULER_JOBS Instance method Public Method 20041117
29 INSERT_JOB Instance method Public Method Creates job 20030506
30 LOCK_AGAINST_RUNNING_JOB Instance method Public Method Sets read lock 20030910
31 LOCK_JOB Instance method Public Method Locks job 20030606
32 ROLLBACK_WORK Instance method Public Method Rollback 20030606
33 SCHEDULER_OFF Instance method Public Method Scheduler is finished with job 20031017
34 SCHEDULER_ON Instance method Public Method Lock selects "Scheduler currently running for job" 20031017
35 SET_DIRTY Instance method Public Method Invalidates buffer 20030425
36 START_JOB_STOP_ACTION Instance method Public Method Set Read Lock to Stop Job 20050223
37 TEST_JOB_STOP_ACTION Instance method Public Method Set Write Lock when Processing Each Message 20050223
38 UNLOCK_JOB Instance method Public Method Unlocks job 20030606
39 UNLOCK_START_JOB_STOP_ACTION Instance method Public Method Remove Write Lock 20050223
40 UNLOCK_TEST_JOB_STOP_ACTION Instance method Public Method Remove Write Lock 20050223
41 UPDATE_JOB Instance method Protected Method Changes job 20030423
Events
Class CL_XMS_JOBS has no event.
Types
Class CL_XMS_JOBS has no local type.
Method Signatures

Method ACTIVATION_AUTHORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET Value transfer Type reference (TYPE) STRING 20030630
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20030903

Method ALLOW_JOB_TO_RUN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030910

Method ALLOW_JOB_TO_RUN on class CL_XMS_JOBS has no exception.

Method CHANGE_AUTHORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET Value transfer Type reference (TYPE) STRING 20030630
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20030903

Method CHECK_AND_DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing JOB Call by reference Object reference (TYPE REF TO) CL_XMS_JOB 20030915
2 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030915
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20030915

Method CHECK_AND_INSERT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_WA Call by reference Type reference (TYPE) SXMSJOBS 20030915
# Exception Resumable Description Created on
1 CX_STATIC_CHECK XI: Systemfehler 20031121

Method CHECK_AND_UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_WA Call by reference Type reference (TYPE) SXMSJOBS 20030915
# Exception Resumable Description Created on
1 CX_STATIC_CHECK XI: Systemfehler 20031121

Method CHECK_DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing JOB Call by reference Object reference (TYPE REF TO) CL_XMS_JOB 20030915
2 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030915
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20030915

Method CHECK_INSERT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_WA Call by reference Type reference (TYPE) SXMSJOBS 20030915
# Exception Resumable Description Created on
1 CX_STATIC_CHECK XI: Systemfehler 20031121

Method CHECK_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting JOB_ID Value transfer Type reference (TYPE) SXMSJOB 20030514
2 Importing MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB 20030717
3 Exporting PACK Value transfer Type reference (TYPE) CHAR1 Einstelliges Kennzeichen 20050303
4 Exporting QOS Value transfer Type reference (TYPE) SXMSQOS 20030521
5 Exporting QUEUE Value transfer Type reference (TYPE) TRFCQNAM Name einer tRFC-Queue 20040818
6 Exporting REF_TAB Value transfer Type reference (TYPE) SXMS_MSGID_EOREF_TTYP TTYP für SXMS_MSGID_EOREF 20060922
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030505

Method CHECK_MESSAGE_OUTBOUND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting JOB_ID Value transfer Type reference (TYPE) SXMSJOB 20040206
2 Importing MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB 20040206
3 Exporting PACK Value transfer Type reference (TYPE) CHAR1 Einstelliges Kennzeichen 20041116
4 Exporting QOS Value transfer Type reference (TYPE) SXMSQOS 20040206
5 Exporting QUEUE Value transfer Type reference (TYPE) TRFCQNAM Name einer tRFC-Queue 20040818
6 Importing RUNTIME_IF Call by reference Object reference (TYPE REF TO) IF_XMS_RUN_TIME_ENV 20040206
7 Importing SPLIT_MSG Call by reference Type reference (TYPE) SXMSMREC Receiver und Message-Guid einer gesplitteten Message 20040206
8 Importing VERSION Call by reference Type reference (TYPE) SXMSLSQNBR Fortlaufende Nummer für ID eines Message-Log 20040206
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20040206

Method CHECK_NAME_RULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB Job-ID 20031105
# Exception Resumable Description Created on
1 CX_STATIC_CHECK XI: Systemfehler 20031121

Method CHECK_ON_RUNNING_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030606
2 Returning RET Value transfer Type reference (TYPE) CHAR1 20030811
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030606

Method CHECK_UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_WA Call by reference Type reference (TYPE) SXMSJOBS 20031020
# Exception Resumable Description Created on
1 CX_STATIC_CHECK XI: Systemfehler 20031121

Method COMMIT_WORK Signature

Method COMMIT_WORK on class CL_XMS_JOBS has no parameter.
Method COMMIT_WORK on class CL_XMS_JOBS has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_XMS_JOBS has no parameter.
Method CONSTRUCTOR on class CL_XMS_JOBS has no exception.

Method DELETE_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID Call by reference Type reference (TYPE) SXMSJOBS-JOB_ID 20030506
2 Changing JOB Call by reference Object reference (TYPE REF TO) CL_XMS_JOB 20030423
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030507

Method DETERMINE_MINUTES_FROM_UNIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning MINUTES Value transfer Type reference (TYPE) I 20031013
2 Importing PERIOD Call by reference Type reference (TYPE) SXMSPERIOD 20031013
3 Importing UNIT Call by reference Type reference (TYPE) SXMSUNIT 20031013

Method DETERMINE_MINUTES_FROM_UNIT on class CL_XMS_JOBS has no exception.

Method DISPLAY_AUTHORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET Value transfer Type reference (TYPE) STRING 20030630
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20030903

Method DISPLAY_AUTHORITY_S Signature

Method DISPLAY_AUTHORITY_S on class CL_XMS_JOBS has no parameter.
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20070911

Method EXECUTE_AUTHORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET Value transfer Type reference (TYPE) STRING 20030630
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20030903

Method EXISTS_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20031022
2 Returning RET Value transfer Type reference (TYPE) CHAR1 20031022

Method EXISTS_JOB on class CL_XMS_JOBS has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning INSTANCE Value transfer Object reference (TYPE REF TO) CL_XMS_JOBS 20030417

Method GET_INSTANCE on class CL_XMS_JOBS has no exception.

Method GET_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning JOB Value transfer Object reference (TYPE REF TO) CL_XMS_JOB 20030422
2 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030422
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030819

Method GET_JOBS_TO_START Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning JOB_TAB Value transfer Type reference (TYPE) SXMSJOBS_CL 20030422
2 Importing LOG Value transfer Object reference (TYPE REF TO) CL_XMS_LOG 20030723
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030507

Method GET_JOB_ID_IN_CLIENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CLIENT Value transfer Type reference (TYPE) SY-MANDT 20030725
2 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030725

Method GET_JOB_ID_IN_CLIENTS on class CL_XMS_JOBS has no exception.

Method GET_JOB_INT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB Job-ID 20050228
2 Returning JOB_WA Value transfer Type reference (TYPE) SXMSJOBS Jobs für verzögerte Message Verarbeitung 20050228

Method GET_JOB_INT on class CL_XMS_JOBS has no exception.

Method GET_JOB_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning JOB_TAB Value transfer Type reference (TYPE) SXMSJOBS_TTYP 20030506

Method GET_JOB_LIST on class CL_XMS_JOBS has no exception.

Method GET_SCHEDULER_JOBS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SCHEDULER_TAB Value transfer Type reference (TYPE) TBTCJOB_TTYP TTYP für tbtcjob 20041117

Method GET_SCHEDULER_JOBS on class CL_XMS_JOBS has no exception.

Method INSERT_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_WA Call by reference Type reference (TYPE) SXMSJOBS 20030506
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030507

Method LOCK_AGAINST_RUNNING_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030910
2 Returning RET Value transfer Type reference (TYPE) CHAR1 20030910
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030910

Method LOCK_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030606
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030606

Method ROLLBACK_WORK Signature

Method ROLLBACK_WORK on class CL_XMS_JOBS has no parameter.
Method ROLLBACK_WORK on class CL_XMS_JOBS has no exception.

Method SCHEDULER_OFF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20031017

Method SCHEDULER_OFF on class CL_XMS_JOBS has no exception.

Method SCHEDULER_ON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20031017
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20031017

Method SET_DIRTY Signature

Method SET_DIRTY on class CL_XMS_JOBS has no parameter.
Method SET_DIRTY on class CL_XMS_JOBS has no exception.

Method START_JOB_STOP_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB Job-ID 20050223
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR 20050223

Method TEST_JOB_STOP_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB Job-ID 20050223
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20050223

Method UNLOCK_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB 20030606

Method UNLOCK_JOB on class CL_XMS_JOBS has no exception.

Method UNLOCK_START_JOB_STOP_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB Job-ID 20050223

Method UNLOCK_START_JOB_STOP_ACTION on class CL_XMS_JOBS has no exception.

Method UNLOCK_TEST_JOB_STOP_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_ID Call by reference Type reference (TYPE) SXMSJOB Job-ID 20050223

Method UNLOCK_TEST_JOB_STOP_ACTION on class CL_XMS_JOBS has no exception.

Method UPDATE_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_WA Value transfer Type reference (TYPE) SXMSJOBS 20030423
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20030507
History
Last changed by/on SAP  20110908 
SAP Release Created in 640