SAP ABAP Class CL_CBN_GW_SEARCH_GENERATOR (C'estBON search OData Generator Utility)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ CA-GTF-CBN-ODT (Application Component) Contextual Business Navigation OData Backend Adaptation lay.
     ⤷ CBESH_ODATA_ADPT_GW (Package) C'estBON Enterprise Search Adapter for OData in Gateway

Properties

Class	CL_CBN_GW_SEARCH_GENERATOR
Short Description	C'estBON search OData Generator Utility
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CBESH_ODATA_ADPT_GW	C'estBON Enterprise Search Adapter for OData in Gateway
Created	20130430	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWBEP/CL_OCI_UTILITY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_CBN_COMMON_UTILITY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	ZCB_COMMON_UTILITY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_CBN_GW_SEARCH_GENERATOR has no interface implemented.

Friends

Class CL_CBN_GW_SEARCH_GENERATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MS_ADMIN_DATA	Instance attribute	Private	☐	Type reference (TYPE)	CL_CBN_COMMON_UTILITY=>TY_S_ADMIN_DATA			20130430

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SEMANTIC_NAV_OBJ	Instance method	Private	Method	Add Semantic Navigation Object to system table	20130503
2	CHECK_BEFORE_GENERATION	Instance method	Private	Method	Perform Checks Generation	20130430
3	COMPLETE_GENERATION	Instance method	Private	Method	Initiate generation	20130430
4	CONSTRUCTOR	Instance method	Public	Constructor		20130430
5	DELETE_ARTIFACTS	Instance method	Public	Method	Delete Generated Artifacts	20130430
6	GENERATE	Instance method	Public	Method	Generate Classes and Configs	20130430
7	GENERATE_CLASS	Instance method	Public	Method	Generate Model Provider and Data Provider clases	20130430
8	GENERATE_CONFIG	Instance method	Public	Method	Generate Model and Service Configuration	20130430
9	GENERATE_DPC	Instance method	Public	Method	Generate Data Provider Class	20130430
10	GENERATE_MPC	Instance method	Public	Method	Generate Model Provider Class	20130430
11	INITIATE_GENERATION	Instance method	Private	Method	Initiate generation	20130430

Events

Class CL_CBN_GW_SEARCH_GENERATOR has no event.

Types

Class CL_CBN_GW_SEARCH_GENERATOR has no local type.

Method Signatures

Method ADD_SEMANTIC_NAV_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRET2_TAB		Error Messages	20130513
2	Importing	IV_SEM_NAV_PROP	Call by reference	☐	Type reference (TYPE)	/UI2/NAVIGATION_OBJECT		Navigation object (semantic element)	20130513
3	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Search Connector Template ID	20130513

Method ADD_SEMANTIC_NAV_OBJ on class CL_CBN_GW_SEARCH_GENERATOR has no exception.

Method CHECK_BEFORE_GENERATION Signature

Method CHECK_BEFORE_GENERATION on class CL_CBN_GW_SEARCH_GENERATOR has no parameter.

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130430

Method COMPLETE_GENERATION Signature

Method COMPLETE_GENERATION on class CL_CBN_GW_SEARCH_GENERATOR has no parameter.
Method COMPLETE_GENERATION on class CL_CBN_GW_SEARCH_GENERATOR has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DP_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	CHAR30		Data provider Class	20130430
2	Importing	IV_MODEL_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_DESCRIPTION		Model Description	20130430
3	Importing	IV_MODEL_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_MDL_TECHNICAL_NAME		Technical Model Name	20130430
4	Importing	IV_MODEL_VERSION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_MDL_VERSION		Model Version	20130430
5	Importing	IV_MP_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	CHAR30		Model Provider Class	20130430
6	Importing	IV_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package Name	20130430
7	Importing	IV_SEM_NAV_PROP	Call by reference	☑	Type reference (TYPE)	/UI2/NAVIGATION_OBJECT		Navigation object (semantic element)	20130430
8	Importing	IV_SERVICE_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_DESCRIPTION		service Description	20130430
9	Importing	IV_SERVICE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_GRP_TECHNICAL_NAME		Technical Service Name	20130430
10	Importing	IV_SERVICE_VERSION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_GRP_VERSION		Service Version	20130430
11	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Template ID	20130430
12	Importing	IV_TRANSPORT_REQUEST	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20130430

Method CONSTRUCTOR on class CL_CBN_GW_SEARCH_GENERATOR has no exception.

Method DELETE_ARTIFACTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DPC_EXIST	Call by reference	☐	Type reference (TYPE)	XFELD			20130430
2	Importing	IV_MODEL_EXIST	Call by reference	☐	Type reference (TYPE)	XFELD			20130430
3	Importing	IV_MPC_EXIST	Call by reference	☐	Type reference (TYPE)	XFELD			20130430
4	Importing	IV_SEM_OBJ_EXIST	Call by reference	☐	Type reference (TYPE)	XFELD			20130503
5	Importing	IV_SERVICE_EXIST	Call by reference	☐	Type reference (TYPE)	XFELD			20130430

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130430

Method GENERATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRET2_TAB		Error Messages	20130430
2	Importing	IT_PARAMETERS	Call by reference	☐	Type reference (TYPE)	CL_CBN_COMMON_UTILITY=>TY_T_PARAMS			20130430
3	Importing	IV_DPC	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20130430
4	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_MDL_TECHNICAL_NAME		Technical Model Name	20130430
5	Importing	IV_MPC	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20130430
6	Importing	IV_OVERWRITE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20130430
7	Importing	IV_SERVICE	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_GRP_TECHNICAL_NAME		Technical Service Name	20130430

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_COS_TRANSPORT_UTIL	☐	OData Channel : Transport Utility Exceptions	20130430
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130430

Method GENERATE_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRET2_TAB		Messages	20130430

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_COS_TRANSPORT_UTIL	☐	OData Channel : Transport Utility Exceptions	20130430
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130430

Method GENERATE_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRET2_TAB		Error Messages	20130430
2	Changing	CV_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package	20130430
3	Changing	CV_TASK	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20130430
4	Importing	IV_DPC	Call by reference	☐	Type reference (TYPE)	SEOCLNAME		Data Provider Class Name	20130430
5	Importing	IV_MODEL_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_DESCRIPTION		Description	20130430
6	Importing	IV_MODEL_TECHNICAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_MDL_TECHNICAL_NAME		Technical Model Name	20130430
7	Importing	IV_MODEL_VERSION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_MDL_VERSION		Model Version	20130430
8	Importing	IV_MPC	Call by reference	☐	Type reference (TYPE)	SEOCLNAME		Model Provider Class Name	20130430
9	Importing	IV_SERVICE_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_DESCRIPTION		Description	20130430
10	Importing	IV_SERVICE_TECHNICAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_GRP_TECHNICAL_NAME		Technical Service Name	20130430
11	Importing	IV_SERVICE_VERSION	Call by reference	☐	Type reference (TYPE)	/IWBEP/MED_GRP_VERSION		Service Version	20130430

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_MED_EXCEPTION	☐	Meta data exception	20130430

Method GENERATE_DPC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRET2_TAB		Error Messages	20130430
2	Importing	IV_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Data Provider Class Name	20130430

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_COS_TRANSPORT_UTIL	☐	OData Channel : Transport Utility Exceptions	20130430
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130430

Method GENERATE_MPC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRET2_TAB		Error Messages	20130430
2	Importing	IV_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Model Provider Class Name	20130430

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_COS_TRANSPORT_UTIL	☐	OData Channel : Transport Utility Exceptions	20130430
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130430

Method INITIATE_GENERATION Signature

Method INITIATE_GENERATION on class CL_CBN_GW_SEARCH_GENERATOR has no parameter.
Method INITIATE_GENERATION on class CL_CBN_GW_SEARCH_GENERATOR has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in	617