SAP ABAP Class CL_BS_ANLY_HRY_READER (Class for reading BW hierarchies)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-ANL-LST (Application Component) List Reporting
     ⤷ BS_ANLY_LIST_REPORTING (Package) Business Suite Analytics: Simple List Reporting

Properties

Class	CL_BS_ANLY_HRY_READER
Short Description	Class for reading BW hierarchies
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	BS_ANLY_LIST_REPORTING	Business Suite Analytics: Simple List Reporting
Created	20101019	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RSDM	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RSHI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_BS_ANLY_HRY_READER has no interface implemented.

Friends

Class CL_BS_ANLY_HRY_READER has no friend class.

Attributes

Class CL_BS_ANLY_HRY_READER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHA_VALUES_GET	Static method	Public	Method		20110322
2	CHA_VALUES_WITH_ATTR_GET	Static method	Public	Method	Get Chavalues and attributes in external nc format	20110428
3	DISPLAY_REST_NODE	Static method	Public	Method	Determines, whether the rest node should be displayed	20110407
4	FILL_HIERNODET	Static method	Private	Method		20110311
5	GET_DEP_HIER_NODES	Static method	Public	Method		20110224
6	GET_HRY_NODES_FAST	Static method	Public	Method		20110310
7	GET_HRY_READER	Static method	Private	Method		20101019
8	HIERNODE_GET	Static method	Public	Method		20101019

Events

Class CL_BS_ANLY_HRY_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_CVH_X_REQ_IOBJ	Public	See coding			20110322	ts_cvh_x_req_iobj TYPE STANDARD TABLE OF rspls_s_cvh_x_req_iobj
2	T_BAPIRET2	Public	See coding			20110322	t_bapiret2 TYPE STANDARD TABLE OF bapiret2
3	T_CVH_X_ATTR_CHAVL	Public	See coding			20110322	t_cvh_x_attr_chavl TYPE STANDARD TABLE OF rspls_s_cvh_x_attr_chavl

Method Signatures

Method CHA_VALUES_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20110322
2	Exporting	E_T_RETURN	Call by reference	☐	Type reference (TYPE)	T_BAPIRET2		Error Messages	20110322
3	Exporting	E_T_VALUE	Call by reference	☐	Type reference (TYPE)	RSPLS_T_CVH_X_CHAVLKEYTEXT			20110322
4	Importing	I_INFOPROVIDER	Call by reference	☐	Type reference (TYPE)	RSINFOCUBE		InfoCube	20110322
5	Importing	I_KEYDATE	Call by reference	☐	Type reference (TYPE)	SYDATUM	SY-DATUM	Current Date of Application Server	20110322
6	Importing	I_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20110322
7	Importing	I_MAX_ROWS	Call by reference	☐	Type reference (TYPE)	INT4	99999	Max number of returned values	20110322
8	Importing	I_READ_MODE	Call by reference	☐	Type reference (TYPE)	RSMD_RS_READ_MODE	RSDM_C_F4_MASTER	Read Mode(F4) for Master Data Read Services	20110322
9	Importing	I_T_REQ_IOBJ	Call by reference	☐	Type reference (TYPE)	TS_CVH_X_REQ_IOBJ		Request Structure for InfoObjects for Reading Master Data	20110322
10	Importing	I_T_SELOPT	Call by reference	☑	Type reference (TYPE)	RSMD_RS_T_SELOPT		Select options for master data read services	20110322

Method CHA_VALUES_GET on class CL_BS_ANLY_HRY_READER has no exception.

Method CHA_VALUES_WITH_ATTR_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20110428
2	Exporting	E_T_ATTR_VALUES	Call by reference	☐	Type reference (TYPE)	T_CVH_X_ATTR_CHAVL		Transfer Structure for Attribute Values for Internal Values	20110428
3	Exporting	E_T_RETURN	Call by reference	☐	Type reference (TYPE)	T_BAPIRET2		Error Messages	20110428
4	Exporting	E_T_VALUE	Call by reference	☐	Type reference (TYPE)	RSPLS_T_CVH_X_CHAVLKEYTEXT			20110428
5	Importing	IF_INT_FORMAT	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	General Flag	20110919
6	Importing	IF_WITH_TEXTS	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	General Flag	20110525
7	Importing	I_INFOPROVIDER	Call by reference	☑	Type reference (TYPE)	RSINFOCUBE		InfoCube	20110428
8	Importing	I_KEYDATE	Call by reference	☐	Type reference (TYPE)	SYDATUM	SY-DATUM	Current Date of Application Server	20110428
9	Importing	I_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20110428
10	Importing	I_MAX_ROWS	Call by reference	☐	Type reference (TYPE)	INT4	99999	Max number of returned values	20110428
11	Importing	I_READ_MODE	Call by reference	☐	Type reference (TYPE)	RSMD_RS_READ_MODE	RSDM_C_F4_MASTER	Read Mode(F4) for Master Data Read Services	20110428
12	Importing	I_T_REQ_IOBJ	Call by reference	☐	Type reference (TYPE)	TS_CVH_X_REQ_IOBJ		Request Structure for InfoObjects for Reading Master Data	20110428
13	Importing	I_T_SELOPT	Call by reference	☑	Type reference (TYPE)	RSMD_RS_T_SELOPT		Select options for master data read services	20110428

Method CHA_VALUES_WITH_ATTR_GET on class CL_BS_ANLY_HRY_READER has no exception.

Method DISPLAY_REST_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HRY_INFO	Call by reference	☐	Type reference (TYPE)	BSANLY_S_HRY_INFO		Info about a Hierarchy	20110407
2	Returning	RF_DISPLAY_RESTNODE	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20110407

Method DISPLAY_REST_NODE on class CL_BS_ANLY_HRY_READER has no exception.

Method FILL_HIERNODET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_HIERNODET	Call by reference	☐	Type reference (TYPE)	RSSH_T_RSTHIERNODE		Text Node Text Table	20110311
2	Importing	I_CHANM	Call by reference	☐	Type reference (TYPE)	RSDIOBJNM		InfoObject	20110311
3	Importing	I_HIEID	Call by reference	☐	Type reference (TYPE)	RSHIEID		Internal hierarchy ID (unique ID)	20110311
4	Importing	I_KEYDATE	Call by reference	☐	Type reference (TYPE)	SY-DATUM		Current Date of Application Server	20110311
5	Importing	I_TH_HIENODETD	Call by reference	☐	Type reference (TYPE)	RSHI_TH_HIENODETD			20110311

Method FILL_HIERNODET on class CL_BS_ANLY_HRY_READER has no exception.

Method GET_DEP_HIER_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_HIERNODE	Call by reference	☐	Type reference (TYPE)	RSMD_RS_T_HIERNODE		Description of Hierarchy Nodes	20110224
2	Importing	IO_HIER_READER	Call by reference	☐	Object reference (TYPE REF TO)	IF_RSMD_RSH		Value Help Read Services for Hierarchy Node	20110224
3	Importing	I_PARENT	Call by reference	☑	Type reference (TYPE)	RSMD_RS_NODEKEY		nodekey in the hierachy structure	20110224

#	Exception	Resumable	Description	Created on
1	CX_RS_ERROR	☐	BW: General Error Class	20110224

Method GET_HRY_NODES_FAST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20110310
2	Exporting	E_T_HIERNODE	Call by reference	☐	Type reference (TYPE)	RSPLS_T_CVH_X_HIERNODE		Description of Hierarchy Nodes	20110310
3	Exporting	E_T_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20110310
4	Importing	IF_NO_LEAFS	Call by reference	☐	Type reference (TYPE)	RS_BOOL	SPACE	No leafs!	20110310
5	Importing	I_CHANM	Call by reference	☑	Type reference (TYPE)	RSIOBJNM		InfoObject	20110310
6	Importing	I_GET_ALL_NODES	Call by reference	☐	Type reference (TYPE)	RS_BOOL	SPACE	Get all nodes with one call	20110310
7	Importing	I_HIEDATETO	Value transfer	☐	Type reference (TYPE)	RSDATETO		Valid-to date	20110310
8	Importing	I_HIENM	Call by reference	☐	Type reference (TYPE)	RSHIENM		Hierarchy name	20110310
9	Importing	I_HIEVERS	Call by reference	☐	Type reference (TYPE)	RSVERSION		Hierarchy version	20110310
10	Importing	I_INFOPROVIDER	Value transfer	☑	Type reference (TYPE)	RSINFOCUBE		InfoCube	20110310
11	Importing	I_KEYDATE	Value transfer	☐	Type reference (TYPE)	SY-DATUM	SY-DATUM	Current Date of Application Server	20110310
12	Importing	I_WITH_REST_NODE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110310

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_OBJECT_NOT_FOUND	☐	Cannot Find Planning Object	20110310
2	CX_RSR_HIERARCHY_EXCEPTIONS	☐	Basis Exception für Fehler bei Hierarchien im OLAP	20110310

Method GET_HRY_READER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_R_HIER_READER	Value transfer	☐	Object reference (TYPE REF TO)	IF_RSMD_RSH		Value Help Read Services for Hierarchy Node	20101019
2	Importing	I_CHANM	Call by reference	☐	Type reference (TYPE)	RSCHANM		Characteristic	20101019
3	Importing	I_HIENM	Call by reference	☐	Type reference (TYPE)	RSHIENM		Hierarchy name	20101019
4	Importing	I_HIEVER	Call by reference	☐	Type reference (TYPE)	RSVERSION		Hierarchy version	20101019
5	Importing	I_HIE_DATETO	Call by reference	☐	Type reference (TYPE)	RSDATETO		Valid-to date	20101019
6	Importing	I_INFOPROV	Call by reference	☐	Type reference (TYPE)	RSINFOPROV		InfoProvider	20101019

#	Exception	Resumable	Description	Created on
1	CX_BS_ANLY_ERR_MESSAGE	☐	General error message	20101019
2	CX_RS_ERROR	☐	BW: General Error Class	20101019

Method HIERNODE_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20101019
2	Exporting	E_T_HIERNODE	Call by reference	☐	Type reference (TYPE)	RSPLS_T_CVH_X_HIERNODE		Description of Hierarchy Nodes	20101019
3	Exporting	E_T_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20101019
4	Importing	IF_FAST_MODE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Just for comparission/testing	20110310
5	Importing	IF_NO_LEAFS	Call by reference	☐	Type reference (TYPE)	RS_BOOL	SPACE	No leafs!	20110224
6	Importing	I_CHANM	Call by reference	☑	Type reference (TYPE)	RSIOBJNM		InfoObject	20101019
7	Importing	I_GET_ALL_NODES	Call by reference	☐	Type reference (TYPE)	RS_BOOL	SPACE	Get all nodes with one call	20110223
8	Importing	I_HIEDATETO	Value transfer	☐	Type reference (TYPE)	RSDATETO		Valid-to date	20101019
9	Importing	I_HIENM	Call by reference	☐	Type reference (TYPE)	RSHIENM		Hierarchy name	20101019
10	Importing	I_HIEVERS	Call by reference	☐	Type reference (TYPE)	RSVERSION		Hierarchy version	20101019
11	Importing	I_INFOPROVIDER	Value transfer	☑	Type reference (TYPE)	RSINFOCUBE		InfoCube	20101019
12	Importing	I_KEYDATE	Value transfer	☐	Type reference (TYPE)	SY-DATUM	SY-DATUM	Current Date of Application Server	20101019
13	Importing	I_PARENT	Call by reference	☑	Type reference (TYPE)	RSMD_RS_NODEKEY		nodekey in the hierachy structure	20101019
14	Importing	I_READ_INITIAL_NODES	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20101019
15	Importing	I_START_LEVEL	Call by reference	☐	Type reference (TYPE)	I	1		20101019
16	Importing	I_S_VAR_ID	Call by reference	☑	Type reference (TYPE)	RSR_S_VAR_ID		Variable ID	20101019
17	Importing	I_WITH_REST_NODE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20101019

Method HIERNODE_GET on class CL_BS_ANLY_HRY_READER has no exception.

History

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