SAP ABAP Class CL_SAM_AMC_EVENT_HNDLR (SAM event to ABAP message channel)
Hierarchy
☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC (Application Component) Interaction Center WebClient
     ⤷ IC_APC (Package) ABAP Push Channel usage in IC
Properties
Class CL_SAM_AMC_EVENT_HNDLR  
Short Description SAM event to ABAP message channel    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package IC_APC   ABAP Push Channel usage in IC 
Created 20130415   SAP 
Last change 20140121   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_SAM_AMC_EVENT_HNDLR has no interface implemented.
Friends
Class CL_SAM_AMC_EVENT_HNDLR has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CR_APC_MSG_PRODUCER Instance attribute Protected Object reference (TYPE REF TO) IF_AMC_MESSAGE_PRODUCER_TEXT AMC producer for text (STRING) messages 20131030
2 CR_MCM_SESSION Instance attribute Private Object reference (TYPE REF TO) CL_CRM_MCM_SESSION MCM session (main class) 20131030
3 CV_APC_CUST_CHECK_DONE Instance attribute Private Type reference (TYPE) BOOLEAN ABAP_FALSE Was polling customizing already checked 20131030
4 CV_APC_CUST_ENABLED Instance attribute Private Type reference (TYPE) BOOLEAN ABAP_FALSE is APC enabled in polling profile 20131030
5 CV_APP_ID Instance attribute Private Type reference (TYPE) AMC_APPLICATION_ID ABAP Messaging Application identifier 20131030
6 CV_CHANNEL_ID Instance attribute Private Type reference (TYPE) AMC_CHANNEL_ID Identifier of the ABAP Messaging Channel 20131030
7 C_APP_ID_IC Constant Public Type reference (TYPE) AMC_APPLICATION_ID 'IC_SAM_NOTIFY_CNL' AMC App-ID for InteractionCenter 20131030
8 C_CHANNEL_ID_IC Constant Public Type reference (TYPE) AMC_CHANNEL_ID '/ic_notify' AMC Channel ID for Interaction Center 20131030
Methods
# Method Level Visibility Method type Description Created on
1 CREATE_MESSAGE_PRODUCER Instance method Protected Method 20131030
2 GET_AMC_ID Instance method Protected Method 20131030
3 GET_APC_MESSAGE_PRODUCER Instance method Protected Method 20131030
4 GET_DEFAULT_AMC_ID Instance method Protected Method 20131030
5 GET_MESSAGE_PRODUCER Instance method Protected Method 20131030
6 HANDLE_EVENT Instance method Public Event handling method Handling event NEW_SAM_MSG 20131030
7 IS_APC_CUSTOMIZING_ENABLED Instance method Public Method Check if APC is enabled in the Polling profile 20131030
8 REGISTER Instance method Public Method Register on event NEW_SAM_MSG 20131030
9 SET_AMC_CONFIG_DATA Instance method Public Method Set AMC application ID and channel ID 20131030
10 SET_MCM_SESSION Instance method Public Method Set MCM Session 20131030
11 UNREGISTER Instance method Public Method Unregister from event NEW_SAM_MSG 20131030
Events
Class CL_SAM_AMC_EVENT_HNDLR has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_AMC_ID Protected See coding 20131030 BEGIN OF TY_AMC_ID, APPLICATION_ID TYPE AMC_APPLICATION_ID, CHANNEL_ID TYPE AMC_CHANNEL_ID, END OF ty_amc_id
Method Signatures

Method CREATE_MESSAGE_PRODUCER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PRODUCER Value transfer Object reference (TYPE REF TO) IF_AMC_MESSAGE_PRODUCER_TEXT AMC producer for text (STRING) messages 20131030
# Exception Resumable Description Created on
1 CX_AMC_ERROR Error handling class for ABAP Messaging Channels (AMC) 20131030

Method GET_AMC_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_AMC_ID Value transfer Type reference (TYPE) TY_AMC_ID 20131030

Method GET_AMC_ID on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method GET_APC_MESSAGE_PRODUCER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPLICATION_ID Call by reference Type reference (TYPE) AMC_APPLICATION_ID ABAP Messaging Application identifier 20131030
2 Importing IV_CHANNEL_ID Call by reference Type reference (TYPE) AMC_CHANNEL_ID Identifier of the ABAP Messaging Channel 20131030
3 Returning RR_PRODUCER Value transfer Object reference (TYPE REF TO) IF_AMC_MESSAGE_PRODUCER_TEXT AMC producer for text (STRING) messages 20131030
# Exception Resumable Description Created on
1 CX_AMC_ERROR Error handling class for ABAP Messaging Channels (AMC) 20131030

Method GET_DEFAULT_AMC_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_AMC_ID Value transfer Type reference (TYPE) TY_AMC_ID 20131030

Method GET_DEFAULT_AMC_ID on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method GET_MESSAGE_PRODUCER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PRODUCER Value transfer Object reference (TYPE REF TO) IF_AMC_MESSAGE_PRODUCER_TEXT AMC producer for text (STRING) messages 20131030
# Exception Resumable Description Created on
1 CX_AMC_ERROR Error handling class for ABAP Messaging Channels (AMC) 20131030

Method HANDLE_EVENT Signature

Method HANDLE_EVENT on class CL_SAM_AMC_EVENT_HNDLR has no parameter.
Method HANDLE_EVENT on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method IS_APC_CUSTOMIZING_ENABLED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_IS_ENABLED Value transfer Type reference (TYPE) BOOLEAN Is APC customizing enabled 20131030

Method IS_APC_CUSTOMIZING_ENABLED on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method REGISTER Signature

Method REGISTER on class CL_SAM_AMC_EVENT_HNDLR has no parameter.
Method REGISTER on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method SET_AMC_CONFIG_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APP_ID Call by reference Type reference (TYPE) AMC_APPLICATION_ID ABAP Messaging Application identifier 20131030
2 Importing IV_CHANNEL_ID Call by reference Type reference (TYPE) AMC_CHANNEL_ID Identifier of the ABAP Messaging Channel 20131030

Method SET_AMC_CONFIG_DATA on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method SET_MCM_SESSION Signature

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

Method SET_MCM_SESSION on class CL_SAM_AMC_EVENT_HNDLR has no exception.

Method UNREGISTER Signature

Method UNREGISTER on class CL_SAM_AMC_EVENT_HNDLR has no parameter.
Method UNREGISTER on class CL_SAM_AMC_EVENT_HNDLR has no exception.
History
Last changed by/on SAP  20140121 
SAP Release Created in