SAP ABAP Class /BOBF/CL_SEA_BO_METADATA (Abstract BO descriptor for Enterprise Search)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ AP-RC-BOF (Application Component) Business Object Processing Framework
     ⤷ /BOBF/SEARCH (Package) BOPF Enterprise Search

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_DESCRIPTOR	Object type descriptor	20130124

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/BOBF/CL_SEA_BO_METADATA_PERS	BO descriptor of persistency model for Enterprise Search	20130128

Properties

Class	/BOBF/CL_SEA_BO_METADATA
Short Description	Abstract BO descriptor for Enterprise Search
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/BOBF/SEARCH	BOPF Enterprise Search
Created	20130123	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /BOBF/CL_SEA_BO_METADATA has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_OBJECT_DESCRIPTOR	☐	☐	Object type descriptor	20130124

Friends

Class /BOBF/CL_SEA_BO_METADATA has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_THIS	Static Attribute	Public	☐	Type reference (TYPE)	SEOCLSNAME	'/BOBF/CL_SEA_BO_METADATA'	Object Type Name	20130123
2	MO_CONF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CONFIGURATION		Interface for Configuration	20130124

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130124
2	DESCRIBE_FIELDS	Instance method	Protected	Method		20130124
3	DESCRIBE_NODE_TYPES	Instance method	Protected	Method		20130124
4	DESCRIBE_NODE_TYPE_TEXTS	Instance method	Protected	Method		20130124
5	DESCRIBE_OBJECT_TYPE	Instance method	Protected	Method		20130124
6	DESCRIBE_OBJECT_TYPE_TEXTS	Instance method	Protected	Method		20130124
7	DESCRIBE_RELATIONS	Instance method	Protected	Method		20130124
8	DESCRIBE_RELATION_FIELDS	Instance method	Protected	Method		20130124
9	DESCRIBE_REQUESTS	Instance method	Protected	Method		20130124
10	DESCRIBE_REQUEST_FIELDS	Instance method	Protected	Method		20130124
11	DESCRIBE_RESPONSE_FIELDS	Instance method	Protected	Method		20130124
12	MAP_ASSOCIATION_CARDINALITY	Instance method	Protected	Method		20130125
13	MAP_BOPF_NODE_TO_ES_NODE_TYPE	Instance method	Protected	Method		20130128
14	MAP_ENTITY_NAME_TO_ESH_ID	Instance method	Protected	Method		20130125

Events

Class /BOBF/CL_SEA_BO_METADATA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTT_KEY_ESH_ID_MAP	Protected	See coding			20130125	gtt_key_esh_id_map TYPE SORTED TABLE OF gty_key_esh_id_map WITH UNIQUE KEY esh_id WITH NON-UNIQUE SORTED KEY bopf_key COMPONENTS bopf_key
2	GTY_ESH_ID	Protected	See coding			20130125	gty_esh_id TYPE c LENGTH 19
3	GTY_KEY_ESH_ID_MAP	Protected	See coding			20130125	BEGIN OF gty_key_esh_id_map. TYPES esh_id TYPE gty_esh_id. TYPES bopf_key TYPE /bobf/conf_key. TYPES END OF gty_key_esh_id_map

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONF	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CONFIGURATION		Business Object	20130128

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	BOPF Exception Class	20130124

Method DESCRIBE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_FIELDS		Fields	20130124
2	Importing	IT_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_NODE_TYPES		Node Types	20130125

Method DESCRIBE_FIELDS on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_NODE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NODE_KEY_ESH_ID_MAP	Call by reference	☐	Type reference (TYPE)	GTT_KEY_ESH_ID_MAP		Configuration: Node	20130125
2	Exporting	ET_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_NODE_TYPES		Node Types	20130124

Method DESCRIBE_NODE_TYPES on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_NODE_TYPE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NODE_TYPE_TEXTS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_NODE_TYPES_T		short texts of node types	20130124
2	Importing	IT_NODE_KEY_ESH_ID_MAP	Call by reference	☐	Type reference (TYPE)	GTT_KEY_ESH_ID_MAP		Configuration: Node	20130125

Method DESCRIBE_NODE_TYPE_TEXTS on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_OBJECT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE		Object Type	20130124

Method DESCRIBE_OBJECT_TYPE on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_OBJECT_TYPE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT_TYPE_TEXT	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_OBJECT_TYPE_T		short texts of object type	20130124

Method DESCRIBE_OBJECT_TYPE_TEXTS on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_RELATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RELATION	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_RELATIONS		relations	20130124
2	Exporting	ET_RELATION_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_RELATION_FIELDS		relation fields	20130128
3	Importing	IT_NODE_KEY_ESH_ID_MAP	Call by reference	☐	Type reference (TYPE)	GTT_KEY_ESH_ID_MAP			20130125

Method DESCRIBE_RELATIONS on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_RELATION_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RELATION_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_RELATION_FIELDS		relation fields	20130128
2	Importing	IS_ASSOCIATION	Call by reference	☐	Type reference (TYPE)	/BOBF/S_CONFRO_ASSOC		Configuration: Association	20130128
3	Importing	IT_FIELD_MAP	Call by reference	☐	Type reference (TYPE)	/BOBF/T_CONFRO_MAPPING		Configuration: Field Name Mapping	20130128

Method DESCRIBE_RELATION_FIELDS on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method DESCRIBE_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_REQUESTS		Requests	20130124
2	Exporting	ET_REQUEST_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_REQUEST_FIELDS		request fields	20130128
3	Importing	IT_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_NODE_TYPES		Node Types	20130128

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General Error in Provider	20130214

Method DESCRIBE_REQUEST_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_REQUEST_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_REQUEST_FIELDS		request fields	20130128
2	Importing	IS_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_NODE_TYPE		Node Type	20130128
3	Importing	IS_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_REQUEST		request fields	20130128

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General Error in Provider	20130128

Method DESCRIBE_RESPONSE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESPONSE_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_RESPONSE_FIELDS		Response fields	20130124
2	Importing	IT_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_NODE_TYPES		Node Types	20130128

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General Error in Provider	20130128

Method MAP_ASSOCIATION_CARDINALITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ES_CARDINALITY	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20130125
2	Importing	IV_BOPF_CARDINALITY	Call by reference	☐	Type reference (TYPE)	/BOBF/OBM_CARDINALITY		Association Cardinality	20130125

Method MAP_ASSOCIATION_CARDINALITY on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method MAP_BOPF_NODE_TO_ES_NODE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE_KEY_ESH_ID_MAP	Call by reference	☐	Type reference (TYPE)	GTT_KEY_ESH_ID_MAP			20130128
2	Exporting	ES_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_NODE_TYPE		Node Type	20130128
3	Exporting	EV_SKIP	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20130129
4	Importing	IS_BOPF_NODE	Call by reference	☐	Type reference (TYPE)	/BOBF/S_CONFRO_NODE		Configuration: Node	20130128

Method MAP_BOPF_NODE_TO_ES_NODE_TYPE on class /BOBF/CL_SEA_BO_METADATA has no exception.

Method MAP_ENTITY_NAME_TO_ESH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_KEY_ESH_ID_MAP	Call by reference	☐	Type reference (TYPE)	GTT_KEY_ESH_ID_MAP			20130125
2	Exporting	EV_ESH_ID	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20130125
3	Importing	IV_BOPF_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_KEY		NodeID	20130125
4	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20130125

Method MAP_ENTITY_NAME_TO_ESH_ID on class /BOBF/CL_SEA_BO_METADATA has no exception.

History

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