SAP ABAP Class CL_MCM_EVENT_DISPATCHER (MCM Event Dispatcher)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-CHA (Application Component) Communication Channel
     ⤷ IC_CCS_MCM (Package) IC Communication Channels Service Multi-Channel Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAM_MESSAGE_ACCESSOR	Helper Interface	20040224

Properties

Class	CL_MCM_EVENT_DISPATCHER
Short Description	MCM Event Dispatcher
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	IC_CCS_MCM	IC Communication Channels Service Multi-Channel Management
Created	20040205	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ICWC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SAM_MESSAGE_ACCESSOR	☐	☐	Helper Interface	20040224

Friends

Class CL_MCM_EVENT_DISPATCHER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_MIMC_AGENT_SESSION_ID	Constant	Private	☐	Type reference (TYPE)	STRING	'session_id'		20071214
2	M_SAM_QUEUE	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20040205

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	INIT_MCM	Instance method	Public	Method		20041028
2	ON_PUBLISH_BSP_INVOKE	Instance method	Public	Event handling method	MCM bsp invoke	20040206
3	ON_PUBLISH_CHAT_APP_EVENT	Instance method	Public	Event handling method	MCM chat application event	20040211
4	ON_PUBLISH_CHAT_CLIENT	Instance method	Public	Event handling method	MCM chat client visibility	20040211
5	ON_PUBLISH_CHAT_INPUT	Instance method	Public	Event handling method	MCM chat input	20040211
6	ON_PUBLISH_CHAT_MESSAGE	Instance method	Public	Event handling method	MCM chat message	20040211
7	ON_PUBLISH_CMS_STATE	Instance method	Public	Event handling method	MCM cms state - logged or loggedoff	20080320
8	ON_PUBLISH_CURRENT_QUEUE	Instance method	Public	Event handling method	MCM current queue	20040211
9	ON_PUBLISH_ERROR_MSG	Instance method	Public	Event handling method	MCM error message	20040211
10	ON_PUBLISH_IM_EVENT	Instance method	Public	Event handling method	MCM event	20081122
11	ON_PUBLISH_IM_MESSAGE	Instance method	Public	Event handling method	MCM IM message	20081210
12	ON_PUBLISH_MCM_EVENT	Instance method	Public	Event handling method	MCM event	20040205
13	ON_PUBLISH_NOTREADY_WRKMODES	Instance method	Public	Event handling method	MCM not ready workmode list	20040211
14	ON_PUBLISH_OPEN_DIALOGUE	Instance method	Public	Event handling method	MCM open dialogue	20081205
15	ON_PUBLISH_QUEUE_TOOLTIP	Instance method	Public	Event handling method		20040211
16	ON_PUBLISH_USER_STATE	Instance method	Public	Event handling method	MCM user state	20040206
17	ON_PUBLISH_WARM_TRANSFER	Instance method	Public	Event handling method		20080408
18	SEND_TO_CLIENT	Instance method	Public	Method	send message to client	20040224
19	SEND_TO_SESSION	Instance method	Public	Method	send to different session	20040224

Events

Class CL_MCM_EVENT_DISPATCHER has no event.

Types

Class CL_MCM_EVENT_DISPATCHER has no local type.

Method Signatures

Method INIT_MCM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MCM_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_MCM_SESSION		MCM session (main class)	20041028

Method INIT_MCM on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_BSP_INVOKE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MIMC_AGENT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20071221
2	Importing	MIMC_INTERACTION_ID	Call by reference	☐	Attribute reference (LIKE)				20081125
3	Importing	NAME	Call by reference	☐	Attribute reference (LIKE)				20040206
4	Importing	PARAM_1	Call by reference	☐	Attribute reference (LIKE)				20040206
5	Importing	PARAM_2	Call by reference	☐	Attribute reference (LIKE)				20040206
6	Importing	PARAM_3	Call by reference	☐	Attribute reference (LIKE)				20040206
7	Importing	PARAM_4	Call by reference	☐	Attribute reference (LIKE)				20040206
8	Importing	PARAM_5	Call by reference	☐	Attribute reference (LIKE)				20040206
9	Importing	PARAM_6	Call by reference	☐	Attribute reference (LIKE)				20040206
10	Importing	PARAM_7	Call by reference	☐	Attribute reference (LIKE)				20040206
11	Importing	PARAM_8	Call by reference	☐	Attribute reference (LIKE)				20040206
12	Importing	TOPIC	Call by reference	☐	Attribute reference (LIKE)				20040206

Method ON_PUBLISH_BSP_INVOKE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_CHAT_APP_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20040211
2	Importing	EVENT_NAME	Call by reference	☐	Attribute reference (LIKE)				20040211
3	Importing	PARAM1_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20040225
4	Importing	PARAM1_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040225

Method ON_PUBLISH_CHAT_APP_EVENT on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_CHAT_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20040211
2	Importing	MESSAGE	Call by reference	☐	Attribute reference (LIKE)				20040211
3	Importing	PARAM_1	Call by reference	☐	Attribute reference (LIKE)				20040211
4	Importing	PARAM_2	Call by reference	☐	Attribute reference (LIKE)				20040211
5	Importing	PARAM_3	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_CHAT_CLIENT on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_CHAT_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20040211
2	Importing	MESSAGE	Call by reference	☐	Attribute reference (LIKE)				20040211
3	Importing	PARAM_1	Call by reference	☐	Attribute reference (LIKE)				20040211
4	Importing	PARAM_2	Call by reference	☐	Attribute reference (LIKE)				20040211
5	Importing	PARAM_3	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_CHAT_INPUT on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_CHAT_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20040211
2	Importing	MESSAGE	Call by reference	☐	Attribute reference (LIKE)				20040211
3	Importing	PARAM_1	Call by reference	☐	Attribute reference (LIKE)				20040211
4	Importing	PARAM_2	Call by reference	☐	Attribute reference (LIKE)				20040211
5	Importing	PARAM_3	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_CHAT_MESSAGE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_CMS_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CMS_STATE	Call by reference	☐	Attribute reference (LIKE)				20080320

Method ON_PUBLISH_CMS_STATE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_CURRENT_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUEUE_TEXT	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_CURRENT_QUEUE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_ERROR_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MIMC_AGENT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20071214
2	Importing	MSG_CLASS	Call by reference	☐	Attribute reference (LIKE)				20040211
3	Importing	MSG_HANDLER_CLASS	Call by reference	☐	Attribute reference (LIKE)				20040211
4	Importing	MSG_LEVEL	Call by reference	☐	Attribute reference (LIKE)				20040211
5	Importing	MSG_NUMBER	Call by reference	☐	Attribute reference (LIKE)				20040211
6	Importing	MSG_TYPE	Call by reference	☐	Attribute reference (LIKE)				20040211
7	Importing	MSG_VAR1	Call by reference	☐	Attribute reference (LIKE)				20040211
8	Importing	MSG_VAR2	Call by reference	☐	Attribute reference (LIKE)				20040211
9	Importing	MSG_VAR3	Call by reference	☐	Attribute reference (LIKE)				20040211
10	Importing	MSG_VAR4	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_ERROR_MSG on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_IM_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTACT_ID	Value transfer	☐	Attribute reference (LIKE)				20081122
2	Importing	DURATION_OF_ACCEPTED_STATE	Value transfer	☐	Attribute reference (LIKE)				20081122
3	Importing	DURATION_OF_CONTACT	Value transfer	☐	Attribute reference (LIKE)				20081122
4	Importing	DURATION_OF_CURRENT_STATE	Value transfer	☐	Attribute reference (LIKE)				20081122
5	Importing	EVENT_NAME	Call by reference	☐	Attribute reference (LIKE)				20081122
6	Importing	OPEN_BUDDYLIST	Call by reference	☐	Attribute reference (LIKE)				20081205
7	Importing	PROPERTIES	Value transfer	☐	Attribute reference (LIKE)				20081122
8	Importing	TIMEOUT_ACCEPT	Value transfer	☐	Attribute reference (LIKE)				20081122

Method ON_PUBLISH_IM_EVENT on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_IM_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IM_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20081210
2	Importing	IV_MESSAGE	Call by reference	☐	Attribute reference (LIKE)				20081210
3	Importing	PARAM_1	Call by reference	☐	Attribute reference (LIKE)				20081210
4	Importing	PARAM_2	Call by reference	☐	Attribute reference (LIKE)				20081210
5	Importing	PARAM_3	Call by reference	☐	Attribute reference (LIKE)				20081210

Method ON_PUBLISH_IM_MESSAGE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_MCM_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTACT_ID	Call by reference	☐	Attribute reference (LIKE)				20040205
2	Importing	CONTACT_TYPE	Call by reference	☐	Attribute reference (LIKE)				20040205
3	Importing	DURATION_OF_ACCEPTED_STATE	Call by reference	☐	Attribute reference (LIKE)				20040205
4	Importing	DURATION_OF_CONTACT	Call by reference	☐	Attribute reference (LIKE)				20040205
5	Importing	DURATION_OF_CURRENT_STATE	Call by reference	☐	Attribute reference (LIKE)				20040205
6	Importing	EVENT_NAME	Call by reference	☐	Attribute reference (LIKE)				20040205
7	Importing	MIMC_AGENT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20071221
8	Importing	MIMC_INTERACTION_ID	Call by reference	☐	Attribute reference (LIKE)				20081125
9	Importing	PROPERTIES	Call by reference	☐	Attribute reference (LIKE)				20040205
10	Importing	TIMEOUT_ACCEPT	Call by reference	☐	Attribute reference (LIKE)				20040205

Method ON_PUBLISH_MCM_EVENT on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_NOTREADY_WRKMODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NOT_READY_WORKMODES	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_NOTREADY_WRKMODES on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_OPEN_DIALOGUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIALOGUE_NAME	Call by reference	☐	Attribute reference (LIKE)				20081205
2	Importing	NUMBER	Call by reference	☐	Attribute reference (LIKE)				20081205

Method ON_PUBLISH_OPEN_DIALOGUE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_QUEUE_TOOLTIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHANNELS_ADDRESSES_TEXT	Call by reference	☐	Attribute reference (LIKE)				20040211
2	Importing	QUEUES_TEXT	Call by reference	☐	Attribute reference (LIKE)				20040211

Method ON_PUBLISH_QUEUE_TOOLTIP on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_USER_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	USER_STATE	Call by reference	☐	Attribute reference (LIKE)				20040206
2	Importing	USER_STATE_TEXT	Call by reference	☐	Attribute reference (LIKE)				20040206

Method ON_PUBLISH_USER_STATE on class CL_MCM_EVENT_DISPATCHER has no exception.

Method ON_PUBLISH_WARM_TRANSFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MIMC_AGENT_SESSION_ID	Call by reference	☐	Attribute reference (LIKE)				20090612
2	Importing	NUMBER	Call by reference	☐	Attribute reference (LIKE)				20080408

Method ON_PUBLISH_WARM_TRANSFER on class CL_MCM_EVENT_DISPATCHER has no exception.

Method SEND_TO_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAM_TEXT_MESSAGE		Message	20040224

#	Exception	Resumable	Description	Created on
1	CX_SAM_MESSAGING_EXCEPTION	☐	Messaging Exception	20040224

Method SEND_TO_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAM_TEXT_MESSAGE		Message	20040224

#	Exception	Resumable	Description	Created on
1	CX_SAM_MESSAGING_EXCEPTION	☐		20040224

History

Last changed by/on	SAP	20130531
SAP Release Created in	400