SAP ABAP Class CL_CBN_ES_MODEL (Util Class)

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_ES_MODEL
Short Description	Util Class
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CBESH_ODATA_ADPT_GW	C'estBON Enterprise Search Adapter for OData in Gateway
Created	20130517	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/IF_MGW_MED_ODATA_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CBN_ES_MODEL has no interface implemented.

Friends

Class CL_CBN_ES_MODEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_ASSOCIATION	Instance attribute	Private	☐	Type reference (TYPE)	LTTY_ASSOCIATION			20130517
2	MT_ASSOC_METADATA	Instance attribute	Private	☐	Type reference (TYPE)	LTTY_ASSOC_METADATA			20130621
3	MT_ENTITY	Instance attribute	Private	☐	Type reference (TYPE)	LTTY_ENTITY			20130517
4	MT_ENTITY_METADATA	Instance attribute	Private	☐	Type reference (TYPE)	LTTY_ENTITY_METADATA			20130621
5	MT_MODEL_REF	Static Attribute	Private	☐	Type reference (TYPE)	LTTY_MODEL_REF			20130517
6	MV_BASE_MODEL_INSTANTIATED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130621
7	MV_META_MODEL_INSTANTIATED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130621
8	MV_TEMPLATE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Search Connector Template ID	20130517

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20130517
2	CONVERT_ENTITY_ASSOC_TO_ES	Static method	Public	Method		20130517
3	CONVERT_ES_TO_ENTITY_ASSOC	Instance method	Private	Method		20130517
4	CONVERT_ES_TO_ENTITY_SET_NAME	Instance method	Private	Method		20130517
5	CREATE_ASSOCIATION	Instance method	Private	Method		20130517
6	CREATE_BASE_MODEL	Instance method	Private	Method		20130517
7	CREATE_CE	Instance method	Private	Method		20130517
8	CREATE_ENTITY	Instance method	Private	Method		20130517
9	CREATE_RELATED_ENTITY_ASSOC	Instance method	Private	Method		20130517
10	GET_ASSOCIATIONS	Instance method	Public	Method		20130517
11	GET_ENTITIES	Instance method	Public	Method		20130517
12	GET_METADATA	Instance method	Public	Method		20130619
13	GET_MODEL_REF	Static method	Public	Method		20130517
14	INSTANTIATE_COMPLETE_MODEL	Instance method	Public	Method	complete instantiation of model (not Meta Model)	20130620
15	META_CREATE_ASSOCIATION	Instance method	Private	Method		20130619
16	META_CREATE_CE	Instance method	Private	Method		20130619
17	META_CREATE_ENTITY_TYPE_SET	Instance method	Private	Method		20130619
18	META_CREATE_REL_ENTITY_ASSOC	Instance method	Private	Method		20130619

Events

Class CL_CBN_ES_MODEL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LSTY_ASSOCIATION	Public	See coding			20130517	BEGIN OF lsty_association, association_name TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_entity_name, nav_property_name TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_entity_name, source_entity_type_name TYPE /iwbep/mgw_tech_name, target_entity_type_name TYPE /iwbep/mgw_tech_name, left_card TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_cardinality, right_card TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_cardinality, END OF lsty_association
2	LSTY_ASSOC_METADATA	Public	See coding			20130517	BEGIN OF lsty_assoc_metadata, nav_property_name TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_entity_name, source_entity_type_name TYPE /iwbep/mgw_tech_name, target_entity_type_name TYPE /iwbep/mgw_tech_name, right_card TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_cardinality, left_card TYPE /iwbep/if_mgw_med_odata_types=>ty_e_med_cardinality, END OF lsty_assoc_metadata
3	LSTY_ATTRIBUTE	Public	See coding			20130517	BEGIN OF lsty_attribute, attribute_name TYPE /iwbep/med_external_name, ext_attr_name TYPE /iwbep/med_external_name, int_attr_name TYPE /iwbep/mgw_tech_name, label TYPE /iwbep/med_annotation_value, is_key TYPE abap_bool, attribute_id_cuky TYPE esh_e_if_attribute_entity_id, ui_areas TYPE esh_t_if_ui_areas, END OF lsty_attribute
4	LSTY_ENTITY	Public	See coding			20130517	BEGIN OF lsty_entity, entity_type_name TYPE /iwbep/mgw_tech_name, entity_set_name TYPE /iwbep/mgw_tech_name, connector_id TYPE esh_e_if_search_connector_id, ce_parent_entity_type_name TYPE /iwbep/mgw_tech_name, ce_parent_connector_id TYPE esh_e_if_search_connector_id, is_ce TYPE abap_bool, relation_type TYPE esh_e_if_relation_type, relation_type_adpt TYPE esh_e_if_relation_type, o_entity TYPE REF TO cl_cbn_es_entity, END OF lsty_entity
5	LSTY_ENTITY_METADATA	Public	See coding			20130517	BEGIN OF lsty_entity_metadata, entity_type_name TYPE /iwbep/mgw_tech_name, internal_entity_type_name TYPE /iwbep/mgw_tech_name, basis_template_id TYPE esh_e_if_template_id, is_root TYPE abap_bool, is_ce TYPE abap_bool, label TYPE /iwbep/med_annotation_value, attributes TYPE ltty_attribute, groups TYPE ltty_group, END OF lsty_entity_metadata
6	LSTY_GROUP	Public	See coding			20130517	BEGIN OF lsty_group, group_id TYPE esh_e_if_attribute_entity_id, description TYPE esh_e_if_name, ui_areas TYPE esh_t_if_ui_areas, grp_attributes TYPE ltty_grp_attribute, END OF lsty_group
7	LSTY_GRP_ATTRIBUTE	Public	See coding			20130517	BEGIN OF lsty_grp_attribute, ext_attr_name TYPE /iwbep/med_external_name, END OF lsty_grp_attribute
8	LSTY_MODEL_REF	Private	See coding			20130517	BEGIN OF lsty_model_ref, template_id TYPE esh_e_if_template_id, cbn_es_model TYPE REF TO cl_cbn_es_model, END OF lsty_model_ref
9	LTTY_ASSOCIATION	Public	See coding			20130517	ltty_association TYPE STANDARD TABLE OF lsty_association WITH NON-UNIQUE KEY table_line
10	LTTY_ASSOC_METADATA	Public	See coding			20130517	ltty_assoc_metadata TYPE STANDARD TABLE OF lsty_assoc_metadata
11	LTTY_ATTRIBUTE	Public	See coding			20130517	ltty_attribute TYPE SORTED TABLE OF lsty_attribute WITH NON-UNIQUE KEY attribute_name
12	LTTY_ENTITY	Public	See coding			20130517	ltty_entity TYPE SORTED TABLE OF lsty_entity WITH NON-UNIQUE KEY entity_type_name entity_set_name
13	LTTY_ENTITY_METADATA	Public	See coding			20130517	ltty_entity_metadata TYPE STANDARD TABLE OF lsty_entity_metadata
14	LTTY_GROUP	Public	See coding			20130517	ltty_group TYPE SORTED TABLE OF lsty_group WITH UNIQUE KEY group_id
15	LTTY_GRP_ATTRIBUTE	Public	See coding			20130517	ltty_grp_attribute TYPE SORTED TABLE OF lsty_grp_attribute WITH UNIQUE KEY ext_attr_name
16	LTTY_MODEL_REF	Private	See coding			20130517	ltty_model_ref TYPE SORTED TABLE OF lsty_model_ref WITH UNIQUE KEY template_id

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Search Connector Template ID	20130517

Method CONSTRUCTOR on class CL_CBN_ES_MODEL has no exception.

Method CONVERT_ENTITY_ASSOC_TO_ES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GW_ASSOC_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Externer Name eines Metamodellelements	20130517
2	Returning	RV_ESH_NAVIGATION_ID	Value transfer	☐	Type reference (TYPE)	STRING		Objekttyp	20130517

Method CONVERT_ENTITY_ASSOC_TO_ES on class CL_CBN_ES_MODEL has no exception.

Method CONVERT_ES_TO_ENTITY_ASSOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ESH_NAVIGATION_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TARGET_NAVIGATION_ID		Objekttyp	20130517
2	Returning	RV_GW_ASSOC_NAME	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME		Externer Name eines Metamodellelements	20130517

Method CONVERT_ES_TO_ENTITY_ASSOC on class CL_CBN_ES_MODEL has no exception.

Method CONVERT_ES_TO_ENTITY_SET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GW_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Objekttyp	20130517
2	Returning	RV_GW_ENTITY_SET_NAME	Value transfer	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130517

Method CONVERT_ES_TO_ENTITY_SET_NAME on class CL_CBN_ES_MODEL has no exception.

Method CREATE_ASSOCIATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ASSOCIATION_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME			20130517
2	Importing	IV_LEFT_CARD	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CARDINALITY			20130517
3	Importing	IV_RIGHT_CARD	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CARDINALITY			20130517
4	Importing	IV_SOURCE_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130517
5	Importing	IV_TARGET_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130517
6	Returning	RS_ASSOCIATION	Value transfer	☐	Type reference (TYPE)	LSTY_ASSOCIATION			20130517

Method CREATE_ASSOCIATION on class CL_CBN_ES_MODEL has no exception.

Method CREATE_BASE_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Search Connector Template ID	20130517

Method CREATE_BASE_MODEL on class CL_CBN_ES_MODEL has no exception.

Method CREATE_CE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ASSOCIATION	Call by reference	☐	Type reference (TYPE)	LSTY_ASSOCIATION			20130517
2	Exporting	ES_ENTITY	Call by reference	☐	Type reference (TYPE)	LSTY_ENTITY			20130517
3	Importing	IO_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR			20130517
4	Importing	IV_NAVPROP_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Name for navigation property	20130517
5	Importing	IV_POSTFIX	Call by reference	☑	Type reference (TYPE)	STRING		Postfix (Singular) for Entity Type	20130517
6	Importing	IV_SOURCE_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130517

Method CREATE_CE on class CL_CBN_ES_MODEL has no exception.

Method CREATE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ENTITY	Call by reference	☐	Type reference (TYPE)	LSTY_ENTITY			20130517
2	Importing	IO_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR			20130517
3	Importing	IV_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130517
4	Importing	IV_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_RELATION_TYPE		Beziehungsart	20130517
5	Importing	IV_RELATION_TYPE_ADPT	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_RELATION_TYPE		Beziehungsart	20130517

Method CREATE_ENTITY on class CL_CBN_ES_MODEL has no exception.

Method CREATE_RELATED_ENTITY_ASSOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ASSOCIATION	Call by reference	☐	Type reference (TYPE)	LTTY_ASSOCIATION			20130517
2	Changing	CT_ENTITY	Call by reference	☐	Type reference (TYPE)	LTTY_ENTITY			20130517
3	Importing	IO_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR			20130517
4	Importing	IV_SOURCE_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130517

Method CREATE_RELATED_ENTITY_ASSOC on class CL_CBN_ES_MODEL has no exception.

Method GET_ASSOCIATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ASSOCIATION	Value transfer	☐	Type reference (TYPE)	LTTY_ASSOCIATION			20130517

Method GET_ASSOCIATIONS on class CL_CBN_ES_MODEL has no exception.

Method GET_ENTITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ENTITY	Value transfer	☐	Type reference (TYPE)	LTTY_ENTITY			20130517

Method GET_ENTITIES on class CL_CBN_ES_MODEL has no exception.

Method GET_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ASSOC_METADATA	Call by reference	☐	Type reference (TYPE)	LTTY_ASSOC_METADATA			20130619
2	Exporting	ET_ENTITY_METADATA	Call by reference	☐	Type reference (TYPE)	LTTY_ENTITY_METADATA			20130619

Method GET_METADATA on class CL_CBN_ES_MODEL has no exception.

Method GET_MODEL_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Search Connector Template ID	20130517
2	Returning	RO_CBN_ES_MODEL	Value transfer	☐	Object reference (TYPE REF TO)	CL_CBN_ES_MODEL		Util Class	20130517

Method GET_MODEL_REF on class CL_CBN_ES_MODEL has no exception.

Method INSTANTIATE_COMPLETE_MODEL Signature

Method INSTANTIATE_COMPLETE_MODEL on class CL_CBN_ES_MODEL has no parameter.
Method INSTANTIATE_COMPLETE_MODEL on class CL_CBN_ES_MODEL has no exception.

Method META_CREATE_ASSOCIATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LEFT_CARD	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CARDINALITY			20130619
2	Importing	IV_NAV_PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME			20130619
3	Importing	IV_RIGHT_CARD	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CARDINALITY			20130619
4	Importing	IV_SOURCE_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130619
5	Importing	IV_TARGET_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130619
6	Returning	RS_META_ASSOCIATION	Value transfer	☐	Type reference (TYPE)	LSTY_ASSOC_METADATA			20130619

Method META_CREATE_ASSOCIATION on class CL_CBN_ES_MODEL has no exception.

Method META_CREATE_CE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_META_ASSOCIATION	Call by reference	☐	Type reference (TYPE)	LSTY_ASSOC_METADATA			20130619
2	Exporting	ES_META_ENTITY_TYPE_SET	Call by reference	☐	Type reference (TYPE)	LSTY_ENTITY_METADATA			20130619
3	Importing	IO_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR			20130619
4	Importing	IV_SOURCE_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130619

Method META_CREATE_CE on class CL_CBN_ES_MODEL has no exception.

Method META_CREATE_ENTITY_TYPE_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_META_ENTITY_TYPE_SET	Call by reference	☐	Type reference (TYPE)	LSTY_ENTITY_METADATA			20130619
2	Importing	IO_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR			20130619
3	Importing	IS_CREATE_CE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130619
4	Importing	IV_ENTITY_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Externer Name eines Metamodellelements	20130619
5	Importing	IV_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_RELATION_TYPE		Beziehungsart	20130619

Method META_CREATE_ENTITY_TYPE_SET on class CL_CBN_ES_MODEL has no exception.

Method META_CREATE_REL_ENTITY_ASSOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CT_META_ASSOCIATION	Call by reference	☐	Type reference (TYPE)	LTTY_ASSOC_METADATA			20130619
2	Exporting	CT_META_ENTITY_TYPE_SET	Call by reference	☐	Type reference (TYPE)	LTTY_ENTITY_METADATA			20130619
3	Importing	IO_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Metadata: Search Connector	20130619
4	Importing	IV_SOURCE_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		external name of a meta model element	20130619

Method META_CREATE_REL_ENTITY_ASSOC on class CL_CBN_ES_MODEL has no exception.

History

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