SAP ABAP Class CL_RSOS_ES_DATAMODEL (Implementation of Object Type Templates for ES)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-MTD (Application Component) Metadata (Repository)
     ⤷ RSOS_ES (Package) BI Implementation of the Enterprise Search Connector

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_SW_COMP_DESCRIPTOR	Software Component Descriptor	20090630

Properties

Class	CL_RSOS_ES_DATAMODEL
Short Description	Implementation of Object Type Templates for ES
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSOS_ES	BI Implementation of the Enterprise Search Connector
Created	20090630	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_RSOS_ES_DATAMODEL has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_SW_COMP_DESCRIPTOR	☐	☐	Software Component Descriptor	20090630

Friends

Class CL_RSOS_ES_DATAMODEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_C_AUTHTMPL_ROLEOBJECT	Constant	Public	☐	Type reference (TYPE)	STRING	'ROLES_OBJECTS'	Role-Object authorization template	20100129
2	N_C_AUTHTMPL_USERMAPPING	Constant	Public	☐	Type reference (TYPE)	STRING	'USER_MAPPING'	User mapping authorization template	20100129
3	N_C_AUTHTMPL_USEROBJECT	Constant	Public	☐	Type reference (TYPE)	STRING	'USER_OBJECTS'	User-Object Authorization template	20100129
4	N_C_AUTHTMPL_USERROLE	Constant	Public	☐	Type reference (TYPE)	STRING	'USER_ROLES'	User-Role authorization template	20100129
5	N_C_DATAELEM_GUID	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'HIER_GUID'	Data Element 'HIER_GUID'	20100204
6	N_C_DATAELEM_ROLE	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'AGR_NAME'	Data Element 'AGR_NAME'	20100204
7	N_C_DATAELEM_USER	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	' SYUNAME'	Data Element ' SYUNAME'	20100204
8	N_C_OBJECT_ID	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'OBJECT_ID'	Field 'OBJECT_ID'	20100204
9	N_C_ROLE_NAME	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'AGR_NAME'	Field 'AGR_NAME'	20100204
10	N_C_TECHNAME	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'TECHNAME'	Field 'TECHNAME'	20100204
11	N_C_USER_NAME	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'UNAME'	Field 'UNAME'	20100204
12	N_C_USER_NAME_BACKEND	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'USER_ID_BACKEND'	Field 'USER_ID_BACKEND'	20100204
13	P_ATTR_PROP	Instance attribute	Private	☐	See coding			Enterprise Search specific attribute properties	20091214
14	P_C_CATG_BWOBJECTS	Constant	Private	☐	Type reference (TYPE)	STRING	'BW_OBJECTS'	Category 'BW Objects'	20100212
15	P_C_CATG_INFOPROVIDERS	Constant	Private	☐	Type reference (TYPE)	STRING	'INFOPROVIDERS'	Category 'Info Providers'	20100212
16	P_C_CATG_REPORTS	Constant	Private	☐	Type reference (TYPE)	STRING	'REPORTS'	Category 'Reports'	20100212
17	P_C_CATG_WHMOBJECTS	Constant	Private	☐	Type reference (TYPE)	STRING	'WHM_OBJECTS'	Category 'WHM Objects'	20100212
18	P_PROVIDER_ID	Constant	Private	☐	Type reference (TYPE)	ESH_E_IF_PROVIDER_ID	'CL_RSOS_ES_REGISTER'	Provider ID	20090706
19	P_SEARCH_ATTR	Instance attribute	Private	☐	See coding			Searchable attributes for Object Types	20091124
20	P_SW_COMP	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME	'SAP_BW'	Backend Name	20090702
21	P_TLOGO_PROP	Instance attribute	Private	☐	Type reference (TYPE)	RSOS_ES_T_TLOGO_PROP		BW TLOGO Objects Properties	20091124

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090702
2	DEFINE_AUTHORIZATION_CHECKS	Instance method	Private	Method	Define Authorization checks	20091124
3	DEFINE_BACKEND_NAVIGATION	Instance method	Private	Method	Define Backend Navigation	20100118
4	DEFINE_CATEGORIES	Instance method	Private	Method	Define Categories for BW Objects	20100120
5	DEFINE_NAVIGATION_PATHS	Instance method	Private	Method	Define Navigation Paths	20090901
6	DEFINE_RELATION	Instance method	Private	Method	Define relationship among nodes and object types	20100705
7	GET_DATA_ELEMENTS	Instance method	Private	Method	Get Data Elements	20090710
8	GET_NODE_FIELDS	Instance method	Private	Method	Get Field for Nodes	20090702
9	GET_NODE_TYPES	Instance method	Private	Method	Get Template Node Details	20090702
10	GET_OBJECT_TYPE	Instance method	Private	Method	Get basic Template Details	20090702
11	GET_REQUESTS	Instance method	Private	Method	Get Requests for the Object Types	20090704
12	GET_RESPONSE	Instance method	Private	Method	Get response attributes for the Object Types	20090704
13	GET_SW_COMPONENT	Instance method	Private	Method	Get SW Component Details	20090702

Events

Class CL_RSOS_ES_DATAMODEL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	RSOS_ES_S_AUTHOR_FIELDS	Public	See coding			20091126	BEGIN OF rsos_es_s_author_fields, field TYPE xufield, txtlg TYPE xutext, END OF rsos_es_s_author_fields
2	RSOS_ES_S_RSOBJS_OBJ_TYPE	Public	See coding			20091126	BEGIN OF rsos_es_s_rsobjs_obj_type, obj_type TYPE rsobjs_type, txtlg TYPE rstxtlg, langu TYPE langu, END OF rsos_es_s_rsobjs_obj_type
3	RSOS_ES_S_RSOTLOGOSEARATR	Public	See coding			20091126	BEGIN OF rsos_es_s_rsotlogosearatr, obj_type TYPE rsobjs_type, search_atr TYPE rso_search_atr, dtelnm TYPE rsos_dtelnm, END OF rsos_es_s_rsotlogosearatr
4	RSOS_ES_S_SEARCHATTR_AUTH	Public	See coding			20091126	BEGIN OF rsos_es_s_searchattr_auth, obj_type TYPE rsobjs_type, search_atr TYPE rso_search_atr, authfield TYPE xufield, END OF rsos_es_s_searchattr_auth
5	RSOS_ES_S_TLOGO_PROP	Public	See coding			20091126	BEGIN OF rsos_es_s_tlogo_prop, tlogo TYPE rstlogo, authobject TYPE xuobject, END OF rsos_es_s_tlogo_prop
6	RSOS_ES_T_AUTHOR_FIELDS	Public	See coding			20091124	rsos_es_t_author_fields TYPE TABLE OF rsos_es_s_author_fields
7	RSOS_ES_T_RSOBJS_OBJ_TYPE	Public	See coding			20090824	rsos_es_t_rsobjs_obj_type TYPE TABLE OF rsos_es_s_rsobjs_obj_type
8	RSOS_ES_T_TLOGO_PROP	Public	See coding			20091126	rsos_es_t_tlogo_prop TYPE TABLE OF rsos_es_s_tlogo_prop

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SW_COMP_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20090706

Method CONSTRUCTOR on class CL_RSOS_ES_DATAMODEL has no exception.

Method DEFINE_AUTHORIZATION_CHECKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Describe complete object	20091125
2	Changing	C_T_AUTH_CHECKS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_AUTH_CHECK_MODELS		Authorization check model definitions	20100127
3	Changing	C_T_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20091216
4	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100705

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20091216

Method DEFINE_BACKEND_NAVIGATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Describe complete object	20100118
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100702

Method DEFINE_BACKEND_NAVIGATION on class CL_RSOS_ES_DATAMODEL has no exception.

Method DEFINE_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_CATEGORIES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_CATEG_DEF		Category definitions (not namespace dependent!)	20100120

Method DEFINE_CATEGORIES on class CL_RSOS_ES_DATAMODEL has no exception.

Method DEFINE_NAVIGATION_PATHS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20091216
2	Changing	C_T_NAVIGATION_PATHS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_NAV_PATH_MODELS		Navigation path models	20090901
3	Changing	C_T_OBJECT_TYPES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_OBJECT_TYPE_MODEL		Describe complete Object	20090901
4	Importing	I_T_AUTH_CHECKS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_AUTH_CHECK_MODELS		Authorization check model definitions	20100127
5	Importing	I_T_RELATIONS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_RELATION_MODELS		Relation models	20090901

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20091216

Method DEFINE_RELATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_RELATIONS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_RELATION_MODELS		Relation models	20100705
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100705

Method DEFINE_RELATION on class CL_RSOS_ES_DATAMODEL has no exception.

Method GET_DATA_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_DATA_ELEMENTS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_DCB_DATA_ELEM_MODELS		Data element models	20090710
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100706

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20091216

Method GET_NODE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Describe complete object	20090702
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Tlogo information	20100701

Method GET_NODE_FIELDS on class CL_RSOS_ES_DATAMODEL has no exception.

Method GET_NODE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Describe complete object	20090702
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100630

Method GET_NODE_TYPES on class CL_RSOS_ES_DATAMODEL has no exception.

Method GET_OBJECT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Object Type	20090702
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Tlogo information	20100630

Method GET_OBJECT_TYPE on class CL_RSOS_ES_DATAMODEL has no exception.

Method GET_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Describe complete object	20090704
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100701

Method GET_REQUESTS on class CL_RSOS_ES_DATAMODEL has no exception.

Method GET_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_OBJECT_TYPE_MODEL		Describe complete object	20090704
2	Importing	I_R_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOS_ES_OBJ		Base class for templates	20100701

Method GET_RESPONSE on class CL_RSOS_ES_DATAMODEL has no exception.

Method GET_SW_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_SW_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_NAMESPACE_DEF		Namespace definition	20090702

Method GET_SW_COMPONENT on class CL_RSOS_ES_DATAMODEL has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	730