SAP ABAP Class CL_O2C_CUST_COCKPIT_ETI_MODEL (Model Class for the Customer Cockpit Component)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ SD-SLS (Application Component) Sales
     ⤷ ERP_SALES_O2C_SLS (Package) ERP Sales Order 2 Cash - Sales

Properties

Class	CL_O2C_CUST_COCKPIT_ETI_MODEL
Short Description	Model Class for the Customer Cockpit Component
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	ERP_SALES_O2C_SLS	ERP Sales Order 2 Cash - Sales
Created	20080407	SAP
Last change	20100310	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_O2C_CUST_COCKPIT_ETI_MODEL has no interface implemented.

Friends

Class CL_O2C_CUST_COCKPIT_ETI_MODEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_BNAME_DISPLAY_CUSTOMER	Constant	Public	☐	Type reference (TYPE)	STRING	'B_DISPLAY_CUST'	Technical Name for the Display Customer Button	20080408
2	GC_BNAME_RETRIEVE_CALL	Constant	Public	☐	Type reference (TYPE)	STRING	'B_RETRIEVE_CALL'	Technical Name for the Call Retrieval Button	20080408
3	GC_CID_CUSTOMER_COCKPIT_VIEW	Constant	Public	☐	Type reference (TYPE)	STRING	'CUST_COCKPIT_COMP.CUST_COCKPIT_VIEW'	Caller ID for the Customer Cockpit ETI Model Class	20080414
4	GC_CID_CUSTOMER_ETI_VIEW	Constant	Public	☐	Type reference (TYPE)	STRING	'O2C_CUST_COCKPIT_ETI_COMP.V_CUST_COCKPI_ETI'	Caller ID for the Customer Cockpit ETI WD Component	20080414
5	GC_CUST_COCKPIT_APPLID	Constant	Public	☐	Type reference (TYPE)	STRING	'O2C-CUSTOMER_COCKPIT'	Technical Name of the POWL appl ID for the Customer Cockpit	20080407
6	GC_IRREL_ATTRIB	Constant	Private	☐	See coding		'/S'	Irrelevant attribute	20080407
7	GC_MSG_PERMANENT	Constant	Public	☐	Type reference (TYPE)	XFLAG	''	Flag indicating that the message is not permanent	20080407
8	GC_OBN_NAME_CUSTCOCKPIT	Constant	Public	☐	Type reference (TYPE)	STRING	'customer_cockpit'	OBN Name for the Customer Specific View	20080425
9	GC_OBN_OP_CUSTCOCKPIT_DISPLAY	Constant	Public	☐	Type reference (TYPE)	STRING	'display'	OBN Operation ID for the Customer View opening	20080425
10	GC_OBN_SYSTEM	Constant	Public	☐	Type reference (TYPE)	STRING	'SAP_ERP_SalesService'	OBN System Alias Name	20080407
11	GC_SCOPE_MSG_PERMANENT	Constant	Public	☐	Type reference (TYPE)	I	0	Flag indicating the permanent message scope	20080407
12	GC_SORT_ATTRIB_1	Constant	Private	☐	Type reference (TYPE)	C	'1'	Sort attribute	20080407
13	GC_STEP01	Constant	Public	☐	Type reference (TYPE)	I	1	Initialization step value in the communication process	20080407
14	GC_STEP02	Constant	Public	☐	Type reference (TYPE)	I	2	Selection step value in the communication process	20080407
15	GC_STEP03	Constant	Public	☐	Type reference (TYPE)	I	3	Cancellation step value in the communication process	20080407
16	GC_TREX_ATTRIBUTE	Constant	Private	☐	Type reference (TYPE)	STRING	'SEARCH_TERM_ATTR'	Attribute used to store the input field data	20080407
17	GC_TREX_BUSOBJ	Constant	Private	☐	Type reference (TYPE)	COM_SEARCH_TV_BUSOBJ	'KNA1'	TREX Business Object: customer master	20080407
18	GC_TREX_CONTENT_TYPE	Constant	Private	☐	Type reference (TYPE)	TREXD_CONTENT_TYPE	'A'	Content type	20080407
19	GC_TREX_FIELDNAME	Constant	Private	☐	Type reference (TYPE)	STRING	'SEARCH_TERM_FIELD'	Input field name used for TREX	20080407
20	GC_TREX_NODENAME	Constant	Private	☐	Type reference (TYPE)	STRING	'TREX_SELECTION'	Node storing TREX input fields	20080407
21	GC_TREX_OBJ_TYPE	Constant	Private	☐	Type reference (TYPE)	COM_SEARCH_TV_OBJECT_TYPE	'1'	TREX Business Object type	20080407
22	GC_TREX_OPERATOR	Constant	Private	☐	Type reference (TYPE)	TREXD_OPERATOR	'EQ'	Operator Equal	20080407
23	GC_TREX_ROWTYPE	Constant	Private	☐	Type reference (TYPE)	TREXD_ROWTYPE	'TERM'	Row type : full text search	20080407
24	GC_TREX_SHLPNAME	Constant	Private	☐	Type reference (TYPE)	SHLPNAME	'DEBI_TREX_ADVANCED'	TREX Search help name for customer	20080407
25	GC_TREX_SHLPTYPE	Constant	Private	☐	Type reference (TYPE)	DDSHLPTYP	'SH'	TREX Search help type	20080407
26	GC_TREX_TERM_ACTION	Constant	Private	☐	Type reference (TYPE)	TREXD_TERM_ACTION	'L'	Term Action	20080407
27	GC_WNAME_CUSTOMER_SELECTOR	Constant	Public	☐	Type reference (TYPE)	STRING	'W_POPUP_CUSTOMER_SEL'	Technical Name of the customer pop up window	20080407
28	GC_WNAME_SAS_SELECTOR	Constant	Public	☐	Type reference (TYPE)	STRING	'W_POPUP_SAS'	Technical Name of the sales area pop up window	20080407
29	MR_BADI_CUST_C_ETI_MODEL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	BADI_O2C_CUST_ETI_MODEL		BAdI Reference for the model class	20080409
30	MT_CUSTOMERS_LIST	Instance attribute	Private	☐	Type reference (TYPE)	TDT_CUSTOMER		Customer Master Data: Sales Area and Address Data	20080407
31	MV_CURRENT_TEL_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	SP_HANDLE		Call identifier assigned by WS software	20080512
32	MV_CURRENT_TEL_NO	Instance attribute	Private	☐	Type reference (TYPE)	SP_TELNO		Telephone number	20080512
33	MV_IS_SES_ACTIVATED	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D		Flag indicating if SES is active TRUE('X') FALSE(' ')	20080407
34	MV_IS_TELEPHONY_ACTIVATED	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D		Flag indicating if telephony is active TRUE('X') FALSE(' ')	20080407
35	MV_KUNNR	Instance attribute	Private	☐	Type reference (TYPE)	KUNNR		Customer Number 1	20080407
36	MV_MAX_ENTRIES	Instance attribute	Protected	☐	Type reference (TYPE)	TBMAXSEL	200	Maximum Of entries per search results	20080423
37	MV_SPART	Instance attribute	Private	☐	Type reference (TYPE)	SPART		Division	20080407
38	MV_VKORG	Instance attribute	Private	☐	Type reference (TYPE)	VKORG		Sales Organization	20080407
39	MV_VTWEG	Instance attribute	Private	☐	Type reference (TYPE)	VTWEG		Distribution Channel	20080407

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CUSTOMER_AUTH_GEN	Instance method	Private	Method	Method to perform the search general authority checks	20080408
2	CONSTRUCTOR	Instance method	Public	Constructor		20080423
3	CONVERT_RESULTS	Instance method	Private	Method	Method to convert the results from TREX	20080407
4	DO_TREX_SEARCH	Instance method	Private	Method	Method to launch the TREX search	20080407
5	GET_CUSTOMERS_LIST	Instance method	Public	Method	Method to get the selected sales area	20080407
6	GET_CUSTOMER_DEFAULT_SALESAREA	Instance method	Public	Method	Method to retrieve the default sales area to use for the CSV	20080409
7	GET_CUSTOMER_SALESAREA	Static method	Public	Method	Method to retrieve the customer sales areas	20080407
8	GET_CUSTOMER_SELECTED	Instance method	Public	Method	Method to get the selected customer	20080407
9	GET_CUSTOMER_SELECTED_SA	Instance method	Public	Method	Method to get the list of customers found	20080407
10	GET_INCOMING_CALL_NUMBER	Instance method	Public	Method	Method to retrieve the inbound call phone number	20080512
11	GET_TREX_SEARCHHELP_ATTR	Instance method	Private	Method	Method to retrieve the TREX Attributes	20080407
12	GET_USER_SALESAREA	Instance method	Public	Method	Method to retrieve the user sales area	20080407
13	IS_SES_ACTIVATED	Instance method	Public	Method	Method to check if the TREX search engine is activated	20080407
14	IS_TELEPHONY_ACTIVATED	Instance method	Public	Method	Method to check if the telephony is activated	20080407
15	RESET_ALL_DATA	Instance method	Public	Method	Method to reset the instance attributes	20080407
16	SEARCH_CUSTOMER_BY_NAME_KUNNR	Instance method	Public	Method	Method to search for a customer by name and/or kunnr	20080408
17	SEARCH_CUSTOMER_BY_PHONE	Instance method	Public	Method	Method to search a customer by phone	20080408
18	SEARCH_CUSTOMER_BY_SES	Instance method	Public	Method	Method to search a customer by TREX	20080408
19	SET_CUSTOMERS_LIST	Instance method	Public	Method	Method to set the list of customers found	20080407
20	SET_CUSTOMER_SELECTED	Instance method	Public	Method	Method to set the selected customer	20080407
21	SET_CUSTOMER_SELECTED_SA	Instance method	Public	Method	Method to set the selected sales area	20080407

Events

Class CL_O2C_CUST_COCKPIT_ETI_MODEL has no event.

Types

Class CL_O2C_CUST_COCKPIT_ETI_MODEL has no local type.

Method Signatures

Method CHECK_CUSTOMER_AUTH_GEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20080408

Method CHECK_CUSTOMER_AUTH_GEN on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method CONSTRUCTOR Signature

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

Method CONVERT_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_FIELDDESCR	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR-FIELDDESCR		Description of Search Help	20080407
2	Exporting	ET_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Customer Master Data: SD Area and Address Data	20080407
3	Importing	IT_RESULT_ITEM	Call by reference	☐	Type reference (TYPE)	COM_SEARCH_TT_RESULT_ITEM		Search Results List	20080407

Method CONVERT_RESULTS on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method DO_TREX_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Customer Master Data: SD Area and Address Data	20080407
2	Importing	IV_SEARCH_TERM	Call by reference	☐	Type reference (TYPE)	CHAR45		Char45	20080407

Method DO_TREX_SEARCH on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_CUSTOMERS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Customer Master Data: Sales Area and Address Data	20080407

Method GET_CUSTOMERS_LIST on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_CUSTOMER_DEFAULT_SALESAREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CUSTOMER_SALES_AREA	Call by reference	☐	Type reference (TYPE)	TDS_SALESAREA		Structure containing the customer default sales area	20080423
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Object containing any error messages raised	20080409
3	Importing	IV_KUNNR	Call by reference	☐	Type reference (TYPE)	KUNNR		Customer Number	20080409

Method GET_CUSTOMER_DEFAULT_SALESAREA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_CUSTOMER_SALESAREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CUSTOMER_SALES_AREA	Call by reference	☐	Type reference (TYPE)	TDT_SALESAREA		Customer Sales Areas	20080407
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20080423
3	Importing	IV_CUSTOMER	Call by reference	☐	Type reference (TYPE)	KUNNR		Current Customer	20080407

Method GET_CUSTOMER_SALESAREA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_CUSTOMER_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_KUNNR	Call by reference	☐	Type reference (TYPE)	KUNNR		Customer Number 1	20080407

Method GET_CUSTOMER_SELECTED on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_CUSTOMER_SELECTED_SA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SPART	Call by reference	☐	Type reference (TYPE)	SPART		Division	20080407
2	Exporting	EV_VKORG	Call by reference	☐	Type reference (TYPE)	VKORG		Sales Organization	20080407
3	Exporting	EV_VTWEG	Call by reference	☐	Type reference (TYPE)	VTWEG		Distribution Channel	20080407

Method GET_CUSTOMER_SELECTED_SA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_INCOMING_CALL_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Error, Warning, Information Messages	20080512
2	Exporting	EV_TEL_NO	Call by reference	☐	Type reference (TYPE)	SP_TELNO		Telephone number	20080512

Method GET_INCOMING_CALL_NUMBER on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_TREX_SEARCHHELP_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_FIELDDESCR	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR-FIELDDESCR		Field description	20080407
2	Changing	CT_REQ_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTRIBUTES		Attributes	20080407
3	Changing	CT_SORT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TREXT_SORT_ATTRIBUTES		Sort attributes	20080407
4	Importing	IV_SHLPNAME	Call by reference	☐	Type reference (TYPE)	SHLPNAME		Name of a Search Help	20080407
5	Importing	IV_SHLPTYPE	Call by reference	☐	Type reference (TYPE)	DDSHLPTYP		Type of an input help (see fixed values)	20080407

Method GET_TREX_SEARCHHELP_ATTR on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method GET_USER_SALESAREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_USERPARAMS	Call by reference	☐	Type reference (TYPE)	WDY_KEY_VALUE_TABLE		Returning the User Sales Area in a key-value structure	20080407
2	Exporting	ET_USERPARAMS_SA	Call by reference	☐	Type reference (TYPE)	TDT_SALESAREA		Returning the User Sales Area in a specific structure	20080407
3	Importing	IV_USERNAME	Call by reference	☐	Type reference (TYPE)	SY-UNAME		User Name	20080407

Method GET_USER_SALESAREA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method IS_SES_ACTIVATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SES_ACTIVATED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Flag indicating is SES is activated	20080407

Method IS_SES_ACTIVATED on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method IS_TELEPHONY_ACTIVATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TELEPHONY_ACTIVATED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Value identifyin if the telephony is activated	20080407

Method IS_TELEPHONY_ACTIVATED on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method RESET_ALL_DATA Signature

Method RESET_ALL_DATA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no parameter.
Method RESET_ALL_DATA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method SEARCH_CUSTOMER_BY_NAME_KUNNR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Results Table for Customer Master Record Search	20080408
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Error messages to return	20080408
3	Exporting	EV_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Number of customers found	20080408
4	Importing	IV_KUNNR	Call by reference	☐	Type reference (TYPE)	KUNNR		Selection Criteria Value for the kunnr Field	20080408
5	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	NAME1_GP		Selection Criteria Value for the Name1 Field	20080408

Method SEARCH_CUSTOMER_BY_NAME_KUNNR on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method SEARCH_CUSTOMER_BY_PHONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Results Table for Customer Master Record Search	20080408
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Error messages to return	20080408
3	Exporting	EV_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Number of customers found	20080408
4	Importing	IV_PHONE	Call by reference	☐	Type reference (TYPE)	STRING		Selection Criteria Value for the Phone	20080408

Method SEARCH_CUSTOMER_BY_PHONE on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method SEARCH_CUSTOMER_BY_SES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Results Table for Customer Master Record Search	20080408
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Error messages to return	20080408
3	Exporting	EV_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Number of customers found	20080408
4	Importing	IV_SEARCH_TERM	Call by reference	☐	Type reference (TYPE)	STRING		Search Term value	20080408

Method SEARCH_CUSTOMER_BY_SES on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method SET_CUSTOMERS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CUSTOMERS_FOUND	Call by reference	☐	Type reference (TYPE)	TDT_CUSTOMER		Customer Master Data: Sales Area and Address Data	20080407

Method SET_CUSTOMERS_LIST on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method SET_CUSTOMER_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KUNNR	Call by reference	☐	Type reference (TYPE)	KUNNR		Customer Number 1	20080407

Method SET_CUSTOMER_SELECTED on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

Method SET_CUSTOMER_SELECTED_SA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SPART	Call by reference	☐	Type reference (TYPE)	SPART		Division	20080407
2	Importing	IV_VKORG	Call by reference	☐	Type reference (TYPE)	VKORG		Sales Organization	20080407
3	Importing	IV_VTWEG	Call by reference	☐	Type reference (TYPE)	VTWEG		Distribution Channel	20080407

Method SET_CUSTOMER_SELECTED_SA on class CL_O2C_CUST_COCKPIT_ETI_MODEL has no exception.

History

Last changed by/on	SAP	20100310
SAP Release Created in	604