SAP ABAP Class CL_XMS_JOB (Job for Delayed Message Processing)

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_JOB
Short Description	Job for Delayed Message Processing
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SXMSJOB	XI: Time-Driven Message Processing
Created	20030422	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XMS_JOB has no forward declaration.

Interfaces

Class CL_XMS_JOB has no interface implemented.

Friends

Class CL_XMS_JOB has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CPACKAGE	Constant	Public	☐	Type reference (TYPE)	TRFCQNAM	'PACKAGE'	Name of tRFC Queue	20041116
2	_JOBS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_JOBS			20030422
3	_JOB_ID	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSJOB			20030422
4	_MSGDEFS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_FILTERS_JOB			20030423
5	_MSGREFS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REFS			20030422
6	_PERIODIC	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1			20030423
7	_STATUS	Instance attribute	Protected	☐	Type reference (TYPE)	SXMSJOBS-STATUS			20030526

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE	Instance method	Public	Method	Activate	20030801
2	ADD_MESSAGE	Instance method	Public	Method	Adds message to job	20030422
3	ADD_MESSAGE_OUTBOUND	Instance method	Public	Method	Adds message to job	20040206
4	CHECK_START	Instance method	Public	Method	Does the job have to be started?	20030701
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20030422
6	CONTAINS_ACTIVE_FILTER	Instance method	Public	Method	Does an EOIO filter belong to the job?	20050621
7	DEACTIVATE	Instance method	Public	Method	Deactivate	20030801
8	DETERMINE_SECONDS_FROM_UNIT	Instance method	Protected	Method	Convert the unit to seconds	20030703
9	EXECUTE_DIRECTLY	Instance method	Public	Method	Executes job directly in background	20031119
10	GET_ATTRIBUTES	Instance method	Public	Method	Job Attributes	20031014
11	GET_JOB_ID	Instance method	Public	Method	Finds JOB_ID for the job	20030422
12	GET_NUMBER_MESSAGES	Static method	Public	Method	Determines number of messages for jobs	20070911
13	GET_NUMBER_OF_MSGS	Instance method	Public	Method	Determines the number of messages for the job	20030509
14	GET_NUMBER_OF_MSGS_AND_COMPARE	Instance method	Public	Method	Determines the number of messages for the job	20031112
15	GET_STATUS	Instance method	Public	Method	Determines the job status	20030526
16	IS_ACTIVE	Instance method	Public	Method	Is the job active?	20030508
17	IS_PERIODIC	Instance method	Public	Method	Is the job periodic?	20030630
18	IS_START_DATE_INITIAL	Instance method	Public	Method	Start date initial?	20030724
19	LAUNCH	Instance method	Public	Method	Starts the messages	20030422
20	NEXT_TIME_INTERVALL	Instance method	Public	Method	Calculates the next execution interval	20030429
21	RECALCULATE_VALIDITY	Instance method	Public	Method	Recalculates job validity	20030422
22	STOP	Instance method	Public	Method		20050223
23	STOP_LOCK	Instance method	Protected	Method		20050223
24	UPDATE	Instance method	Public	Method	Change	20030801

Events

Class CL_XMS_JOB has no event.

Types

Class CL_XMS_JOB has no local type.

Method Signatures

Method ACTIVATE Signature

Method ACTIVATE on class CL_XMS_JOB has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030801

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILTER	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_DEF			20050304
2	Returning	MSGREF	Value transfer	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_REF			20040818
3	Importing	MSG_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB			20030730
4	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID			20030505

Method ADD_MESSAGE on class CL_XMS_JOB has no exception.

Method ADD_MESSAGE_OUTBOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILTER	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_MSG_DEF			20041116
2	Importing	IF_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_RUN_TIME_ENV			20040206
3	Importing	MSG_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB			20040206
4	Importing	PACKAGE	Call by reference	☐	Type reference (TYPE)	SXMS_PACKAGE		Message reference for package	20041116
5	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID			20040206
6	Importing	SPLIT_MSG	Call by reference	☐	Type reference (TYPE)	SXMSMREC		Receiver und Message-Guid einer gesplitteten Message	20040206
7	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20040206

Method ADD_MESSAGE_OUTBOUND on class CL_XMS_JOB has no exception.

Method CHECK_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1			20030701

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030701

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	JOB	Call by reference	☐	Type reference (TYPE)	SXMSJOB			20030422
2	Importing	JOBS	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_JOBS			20030422

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030625

Method CONTAINS_ACTIVE_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1			20050621

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20050621

Method DEACTIVATE Signature

Method DEACTIVATE on class CL_XMS_JOB has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030801

Method DETERMINE_SECONDS_FROM_UNIT Signature

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

Method DETERMINE_SECONDS_FROM_UNIT on class CL_XMS_JOB has no exception.

Method EXECUTE_DIRECTLY Signature

Method EXECUTE_DIRECTLY on class CL_XMS_JOB has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20031119

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	JOB_WA	Value transfer	☐	Type reference (TYPE)	SXMSJOBS			20031014

Method GET_ATTRIBUTES on class CL_XMS_JOB has no exception.

Method GET_JOB_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	JOB_ID	Value transfer	☐	Type reference (TYPE)	CHAR40			20030422

Method GET_JOB_ID on class CL_XMS_JOB has no exception.

Method GET_NUMBER_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMSJOB		Job-ID	20070911
2	Importing	I_T_JOB_ID	Call by reference	☐	Type reference (TYPE)	SXMS_JOB_ID_TTYP		TTYP für JOB_ID	20070911
3	Returning	R_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20070911

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070911

Method GET_NUMBER_OF_MSGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	SXMSNO_OF_MSGS			20030509

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030623

Method GET_NUMBER_OF_MSGS_AND_COMPARE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	SXMSNO_OF_MSGS			20031112

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20031112

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATUS	Value transfer	☐	Type reference (TYPE)	SXMSJOBS-STATUS			20030526

Method GET_STATUS on class CL_XMS_JOB has no exception.

Method IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1			20030508

Method IS_ACTIVE on class CL_XMS_JOB has no exception.

Method IS_PERIODIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1			20030630

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030811

Method IS_START_DATE_INITIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1			20030724

Method IS_START_DATE_INITIAL on class CL_XMS_JOB has no exception.

Method LAUNCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	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	20030425

Method NEXT_TIME_INTERVALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INVALID	Value transfer	☐	Type reference (TYPE)	CHAR1			20030429

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030507

Method RECALCULATE_VALIDITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INVALID	Value transfer	☐	Type reference (TYPE)	CHAR1			20030422

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030507

Method STOP Signature

Method STOP on class CL_XMS_JOB has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050223

Method STOP_LOCK Signature

Method STOP_LOCK on class CL_XMS_JOB has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050223

Method 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			20030805

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XMS: Ausnahmeklasse für Systemfehler	20030801

History

Last changed by/on	SAP	20110908
SAP Release Created in	640