SAP ABAP Class CL_INM_HC_API (HANA Content API)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PPM-CF (Application Component) Common Functions
     ⤷ INM_HANA (Package) HANA content creation and consumption

Properties

Class	CL_INM_HC_API
Short Description	HANA Content API
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	INM_HANA	HANA content creation and consumption
Created	20121109	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_INM_HC_API has no interface implemented.

Friends

Class CL_INM_HC_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_FALSE	Constant	Protected	☐	Type reference (TYPE)	STRING	'false'		20121120
2	MO_DDIC_VIEW_ACCESS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_DD_VIEW			20121126
3	MO_OBJECT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_NHI_OBJECT		IF_NHI_OBJECT	20121115
4	MO_OSTREAM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_IXML_OSTREAM		IF_IXML_ISTREAM	20121119
5	MO_REPOSITORY_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_NHI_API		IF_NHI_API	20121115
6	MS_T100_MESSAGE	Instance attribute	Protected	☐	Type reference (TYPE)	/RPM/TS_T100_MESSAGE		Log message structure for T100 message	20121121
7	MT_CONTENT_LIST	Instance attribute	Public	☐	Type reference (TYPE)	INM_TT_HC_LIST		Table type: Generated HANA Content	20121116
8	MT_HC_GENERATION_MSG	Instance attribute	Protected	☐	Type reference (TYPE)	INM_TT_HC_MESSAGE		HANA content generation message	20121123
9	MV_HC_RESPONSIBLE	Instance attribute	Private	☐	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20121115
10	MV_XML_CDATA	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20121119
11	SC_CHARACTER_SET_UTF_8	Constant	Protected	☐	Type reference (TYPE)	STRING	'UTF-8'	global constant CHAR-SET	20121129
12	SC_DELIVERED_PACKAGE	Constant	Private	☐	Type reference (TYPE)	STRING	'sap.ppm.cprxrpm'		20121130
13	SC_DOM_ATTRIBUTE_NAME	Constant	Protected	☐	See coding				20121129
14	SC_DOM_ELEMENT	Constant	Protected	☐	See coding				20121129
15	SC_DOM_NAMESPACE	Constant	Protected	☐	See coding				20121129
16	SC_GENERATED_PACKAGE	Constant	Private	☐	Type reference (TYPE)	STRING	'system-local.sap.ppm.cprxrpm'		20121129
17	SC_GROUP_BY	Constant	Public	☐	Type reference (TYPE)	STRING	'GROUP BY'		20121203
18	SC_HANA_VIEW_TYPE	Constant	Private	☐	See coding			HANA Repository Object Type	20121129
19	SC_LANGUAGE_KEY_EN	Constant	Protected	☐	Type reference (TYPE)	STRING	'EN'		20121129
20	SC_METADATA_INTERFACE	Constant	Public	☐	Type reference (TYPE)	STRING	'IF_INM_HC_METADATA'		20121130
21	SC_ORDER_BY	Constant	Public	☐	See coding				20121203
22	SC_SELECT_CRITERIA	Constant	Public	☐	See coding				20121203
23	SC_T100_MSG_HC_TYPE_NOT_SUPP	Constant	Protected	☐	See coding				20121129
24	SC_T100_MSG_PARSE_ERROR	Constant	Protected	☐	See coding				20121129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_EXTERNAL_VIEW	Instance method	Protected	Method	Activates external view	20121126
2	CREATE_HC_META_DATA	Instance method	Protected	Method	Create HC meta data	20121207
3	EXECUTE_HC_QUERY	Instance method	Public	Method	Executes a hana query and returns the execution result	20121129
4	EXT_VIEW_TRANSPORT_WRITE	Instance method	Protected	Method	Write transport request	20121126
5	GENERATE_EXTERNAL_VIEW	Instance method	Protected	Method	Generates an external view from Hana view	20121122
6	GENERATE_HC	Instance method	Public	Method	Generate HANA Content	20121109
7	GET_CONSUMABLE_HC_NAME	Static method	Public	Method	Get consumable Hana Content name	20121109
8	GET_CUSTOM_ATTRIBUTES	Instance method	Protected	Method	Get attributes list from Custom Include	20121109
9	GET_DDIC_VIEW_FACTORY	Instance method	Protected	Method	Get DDIC view factory for external view maintenance	20121126
10	GET_FIELDNAME_BY_STRUCTURE	Instance method	Protected	Method	Get field name by structure - Encapsulation for unit test	20121120
11	GET_HC_TYPE	Instance method	Protected	Method	Map ABAP representation to HANA type	20121115
12	GET_MESSAGE	Instance method	Protected	Method	Read single error message from buffer	20121121
13	GET_OBJECT_API_CLASS	Instance method	Protected	Method	Get object class	20121109
14	GET_REPOSITORY_API_INSTANCE	Instance method	Protected	Method	Get repository API instance	20121207
15	PREPARE_HC_CREATION_DATA	Instance method	Protected	Method	HANA Content data	20121115
16	SAVE_CONTENT_MAPPING	Instance method	Protected	Method	Update content mapping	20121122
17	UPDATE_CDATA	Instance method	Protected	Method	Attach new attributes to xml content	20121115

Events

Class CL_INM_HC_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_HC_AGGREGATION	Public	See coding			20121205	tt_hc_aggregation TYPE STANDARD TABLE OF ty_hc_aggregation
2	TT_HC_COLUMN_NAME	Public	See coding			20121129	tt_hc_column_name TYPE STANDARD TABLE OF adbc_name
3	TT_HC_ORDER_BY	Public	See coding			20121203	tt_hc_order_by TYPE STANDARD TABLE OF ty_hc_order_by
4	TY_HC_AGGREGATION	Public	See coding			20121205	BEGIN OF ty_hc_aggregation, column_name TYPE string, function TYPE string, END OF ty_hc_aggregation
5	TY_HC_NAME_VALUE_TYPE	Public	See coding			20121203	BEGIN OF ty_hc_name_value_type, name TYPE string, value TYPE string, END OF ty_hc_name_value_type
6	TY_HC_ORDER_BY	Public	See coding			20121205	BEGIN OF ty_hc_order_by, column_name TYPE string, direction TYPE string, END OF ty_hc_order_by
7	TY_NAMES	Private	See coding			20121116	BEGIN OF ty_names, name TYPE string, END OF ty_names

Method Signatures

Method ACTIVATE_EXTERNAL_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXT_VIEW_NAME	Call by reference	☐	Type reference (TYPE)	VIEWNAME		Name of SAP table view	20121126
2	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20121126

Method ACTIVATE_EXTERNAL_VIEW on class CL_INM_HC_API has no exception.

Method CREATE_HC_META_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EOMETADATA_C	Value transfer	☐	Object reference (TYPE REF TO)	CL_NHI_METADATA		CL_NHI_METADATA	20121207

Method CREATE_HC_META_DATA on class CL_INM_HC_API has no exception.

Method EXECUTE_HC_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20121129
2	Importing	IT_ABAP_COMPONENT_TAB	Call by reference	☐	Type reference (TYPE)	ABAP_COMPONENT_TAB		Runtime Type Services	20121205
3	Importing	IT_AGGREGATION	Call by reference	☑	Type reference (TYPE)	TT_HC_AGGREGATION			20121205
4	Importing	IT_ORDER_BY	Call by reference	☑	Type reference (TYPE)	TT_HC_ORDER_BY			20121203
5	Importing	IV_HAVING	Call by reference	☑	Type reference (TYPE)	STRING			20121205
6	Importing	IV_HC_NAME	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121203
7	Importing	IV_HC_PACKAGE	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121203
8	Importing	IV_SCHEMA	Call by reference	☐	Type reference (TYPE)	STRING	'_SYS_BIC'		20121203
9	Importing	IV_SELECT_CRITERIA_BY	Call by reference	☐	Type reference (TYPE)	STRING			20121205
10	Importing	IV_WHERE_CONDITION	Call by reference	☑	Type reference (TYPE)	STRING			20121129

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Exception Class for SQL Error	20121203

Method EXT_VIEW_TRANSPORT_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXT_VIEW_NAME	Call by reference	☐	Type reference (TYPE)	VIEWNAME		Name of SAP table view	20121126
2	Importing	IV_EXT_VIEW_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package	20121126
3	Importing	IV_TRANSPORT_REQUEST	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20121126
4	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20121126

Method EXT_VIEW_TRANSPORT_WRITE on class CL_INM_HC_API has no exception.

Method GENERATE_EXTERNAL_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXT_VIEW_NAME	Call by reference	☐	Type reference (TYPE)	VIEWNAME		Name of SAP table view	20121123
2	Importing	IV_EXT_VIEW_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package	20121126
3	Importing	IV_HC_NAME	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121122
4	Importing	IV_HC_PACKAGE	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121122
5	Importing	IV_TRANSPORT_REQUEST	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20121126
6	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20121122

Method GENERATE_EXTERNAL_VIEW on class CL_INM_HC_API has no exception.

Method GENERATE_HC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	INM_TT_HC_MESSAGE		HANA content generation message	20121123
2	Importing	IT_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	INM_TT_OBJECT_TYPE		Object Type	20121122
3	Importing	IV_DELIVERY_UNIT	Call by reference	☑	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121122
4	Importing	IV_HC_RESPONSIBLE	Call by reference	☐	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20121115
5	Importing	IV_HC_TARGET_PACKAGE	Call by reference	☑	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121115

Method GENERATE_HC on class CL_INM_HC_API has no exception.

Method GET_CONSUMABLE_HC_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_HC_NAME	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121130
2	Exporting	EV_HC_PACKAGE	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121130
3	Exporting	EV_STANDARD_HC	Call by reference	☐	Type reference (TYPE)	RPM_FLAG		Flag	20121130
4	Importing	IV_HC_NAME	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121130
5	Importing	IV_HC_PACKAGE	Call by reference	☐	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121130

Method GET_CONSUMABLE_HC_NAME on class CL_INM_HC_API has no exception.

Method GET_CUSTOM_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TABLE_CI	Call by reference	☐	Type reference (TYPE)	INM_TT_HC_TABLE_CI		Tables and Custom Inculdes for HANA Content	20121115
2	Returning	RT_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	INM_TT_HC_CUST_ATTRIBUTES		Table type: Custom Attributes	20121115

Method GET_CUSTOM_ATTRIBUTES on class CL_INM_HC_API has no exception.

Method GET_DDIC_VIEW_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_DDIC_VIEW_ACCESS	Value transfer	☐	Object reference (TYPE REF TO)	IF_DD_VIEW			20121126

Method GET_DDIC_VIEW_FACTORY on class CL_INM_HC_API has no exception.

Method GET_FIELDNAME_BY_STRUCTURE 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)	DD_X031L_TABLE			20121120
2	Importing	IV_STRUCTNAME	Call by reference	☐	Type reference (TYPE)	INM_TS_HC_TABLE_CI-CI_NAME			20121120

Method GET_FIELDNAME_BY_STRUCTURE on class CL_INM_HC_API has no exception.

Method GET_HC_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HC_TYPE	Call by reference	☐	Type reference (TYPE)	INM_TV_HOBJ_TYPE		HANA Repository Object Type	20121115
2	Returning	RR_HC_TYPE	Value transfer	☐	Object reference (TYPE REF TO)	CE_NHI_OBJECT_TYPE		CE_NHI_OBJECT_TYPE	20121115

Method GET_HC_TYPE on class CL_INM_HC_API has no exception.

Method GET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_T100_MESSAGE	Value transfer	☐	Type reference (TYPE)	/RPM/TS_T100_MESSAGE		Log message structure for T100 message	20121121

Method GET_MESSAGE on class CL_INM_HC_API has no exception.

Method GET_OBJECT_API_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	/RPM/OBJECT_TYPE		Object Type	20121109
2	Returning	RV_OBJECT_API	Value transfer	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20121109

Method GET_OBJECT_API_CLASS on class CL_INM_HC_API has no exception.

Method GET_REPOSITORY_API_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_REPOSITORY_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_NHI_API		IF_NHI_API	20121207

#	Exception	Resumable	Description	Created on
1	CX_NHI_NOT_SUPPORTED	☐	Not supported	20121207

Method PREPARE_HC_CREATION_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HC_METADATA	Call by reference	☐	Type reference (TYPE)	INM_TT_HC_METADATA		HANA Content metadata	20121115
2	Importing	IV_PACKAGE_NAME	Call by reference	☑	Type reference (TYPE)	INM_TV_HC_NAME		HANA Content name	20121116
3	Returning	RT_HC_CREATION_DETAILS	Value transfer	☐	Type reference (TYPE)	INM_TT_HC_CREATION_DETAIL		Table Type: HC Creation Details	20121115

Method PREPARE_HC_CREATION_DATA on class CL_INM_HC_API has no exception.

Method SAVE_CONTENT_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	''	Boolean Variable (X=True, -=False, Space=Unknown)	20121122

Method SAVE_CONTENT_MAPPING on class CL_INM_HC_API has no exception.

Method UPDATE_CDATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	INM_TT_HC_CUST_ATTRIBUTES		Table type: Custom Attributes	20121115
2	Importing	IV_HC_TYPE	Call by reference	☐	Type reference (TYPE)	INM_TV_HOBJ_TYPE		HANA Repository Object Type	20121127
3	Importing	IV_XML_CDATA	Call by reference	☐	Type reference (TYPE)	STRING			20121115
4	Returning	RV_XML_CDATA	Value transfer	☐	Type reference (TYPE)	STRING			20121115

Method UPDATE_CDATA on class CL_INM_HC_API has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	600_740