SAP ABAP Interface IF_BICS_HIERARCHY (Hierarchy Selector Layer)

Hierarchy

☛

SAP_BW (Software Component) SAP Business Warehouse
⤷

BW-BEX-OT (Application Component) OLAP Technology
⤷

BW_BICS_CONSUMER_SELECTOR (Package) BW BICS Consumer Selector

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	IF_BICS_QV_HIERARCHY	Hierarchy QV Layer	20100323
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_BICS_HIERARCHY	Hierarchy in Selector Layer	20100323

Properties

Interface	IF_BICS_HIERARCHY
Short Description	Hierarchy Selector Layer

General Data

Package	BW_BICS_CONSUMER_SELECTOR	BW BICS Consumer Selector
Created	20100323	SAP
Last changed	20130531	SAP
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)
2	IF_BICS_LEVEL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_BICS_MD_HIERARCHY	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_BICS_MD_IOBJ	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_BICS_NODE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
6	IF_BICS_NODE_TYPE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
7	IF_BICS_OBJECT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Description	Created on
1	IF_BICS_ATTR_CONTAINER	Attribute Container	20100421
2	IF_BICS_CONTEXT	Context of an Object	20100329
3	IF_BICS_EVENT_SOURCE	Basis Event Source	20100323
4	IF_BICS_IOBJ_MEMBER_ACCESSOR	Access Object for Attributes	20100407
5	IF_BICS_MD_ATTR_CONTAINER	Attribute Container MD Layer	20100421
6	IF_BICS_MD_HIERARCHY	Hierarchy MD Layer	20100323
7	IF_BICS_MD_IOBJ	InfoObject MD Layer	20100323
8	IF_BICS_OBJECT	Root Object for BICS Entities	20100323

Friends

Interface IF_BICS_HIERARCHY has no friend.

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Description	Created on
1	N_INITIAL_DRILL_LEVEL	Instance attribute	Public	Type reference (TYPE)	IF_BICS_MD_HIERARCHY=>TN_DRILL_LEVEL	Initial Drilldown Level According to Query	20110805
2	N_IS_ACTIVE	Instance attribute	Public	Type reference (TYPE)	ABAP_BOOL	Hierarchy Active	20110617
3	N_R_CHARACTERISTIC	Instance attribute	Public	Object reference (TYPE REF TO)	IF_BICS_CHARACTERISTIC	Characteristic Selector Layer	20100621

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ARE_LEAVES_VISIBLE	Instance method	Public	Method	Check Visibility of Leaves	20100323
2	GET_CHILDREN	Instance method	Public	Method	Read Child Nodes	20100329
3	GET_INITIAL_DRILL_LEVEL	Instance method	Public	Method	Read Initial Drill State	20100323
4	GET_LEVEL	Instance method	Public	Method	Read a Certain Level	20100323
5	GET_LEVELS	Instance method	Public	Method	Read All Levels	20100323
6	GET_MAXIMUM_LEVEL	Instance method	Public	Method	Read Deepest Level	20100323
7	GET_MD_HIERARCHY	Instance method	Public	Method	Read MD Hierarchy	20100323
8	GET_MINIMUM_LEVEL	Instance method	Public	Method	Read Highest Level	20100323
9	GET_NODE	Instance method	Public	Method	Read a Certain Node	20100323
10	GET_NODES	Instance method	Public	Method	Read All Noded up to Specified Level	20100323
11	GET_NODES_AT_LEVEL	Instance method	Public	Method	Read Nodes for One Level	20100401
12	GET_NODE_ALIGNMENT	Instance method	Public	Method	Read Node Alignment	20100323
13	GET_NODE_CONDENSATION	Instance method	Public	Method	Check Combination of Nodes	20100323
14	GET_PARENT	Instance method	Public	Method	Read Parent Node of a Member	20100323
15	GET_ROOT_NODES	Instance method	Public	Method	Read Root Node	20100323
16	GET_VISIBILITY_OF_POSTED_NODES	Instance method	Public	Method	Read Visibility of the Postable Nodes	20100323
17	HAS_DEFAULT_NODE_ALIGNMENT	Instance method	Public	Method	Check Node for Default Alignment	20100323
18	HAS_HIDDEN_LEVELS	Instance method	Public	Method	Check for Hidden Levels	20100323
19	HAS_HIDDEN_NODE_TYPES	Instance method	Public	Method	Check for Hidden Node Types	20100323
20	IS_LEVELLED	Instance method	Public	Method	Check for Level Property	20100323
21	SET_ACTIVE	Instance method	Public	Method	Set Hierarchy to Active	20100323
22	SET_INITIAL_DRILL_LEVEL	Instance method	Public	Method	Set Initial Drill Step	20100323
23	SET_LEAVES_VISIBLE	Instance method	Public	Method	Set Visibility of Leaves	20100323
24	SET_NODE_ALIGNMENT	Instance method	Public	Method	Set Node Alignment	20100323
25	SET_NODE_CONDENSATION	Instance method	Public	Method	Set Combination of Nodes	20100323
26	SET_VISIBILITY_OF_POSTED_NODES	Instance method	Public	Method	Set Visibility of Postable Nodes	20100323
27	SUPPORTS_NODE_ALIGNMENT	Instance method	Public	Method	Check Ability of Node to Align to Certain Type	20100323

Events

Interface IF_BICS_HIERARCHY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TN_S_HIER	Public	See coding		Structure Container of this Object	20100323	`BEGIN OF tn_s_hier, name TYPE if_bics_object=>tn_name, ref TYPE REF TO if_bics_hierarchy, END OF tn_s_hier`
2	TN_T_HIER	Public	See coding		Table of Objects	20100323	`tn_t_hier TYPE STANDARD TABLE OF tn_s_hier`

Method Signatures

Method ARE_LEAVES_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_LEAVES_VISIBLE	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method ARE_LEAVES_VISIBLE on Interface IF_BICS_HIERARCHY has no exception.

Method GET_CHILDREN Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LEVEL	Call by reference	Type reference (TYPE)	IF_BICS_LEVEL=>TN_LEVEL_NUMBER	1	Levelnummer	20100329
2	Importing	I_NODE_ID	Call by reference	Type reference (TYPE)	IF_BICS_OBJECT=>TN_ID		Knoten-ID	20100329
3	Returning	R_R_NODE_CONTAINER	Value transfer	Object reference (TYPE REF TO)	IF_BICS_IOBJ_MEMBER_CONTAINER		Behälter für (einen oder mehrere) Knoten	20100408

#	Exception	Resumable	Description	Created on
1	CX_BICS_LIST_MEMBER_NOT_FOUND		Ausnahme für Listen: unbekannter Eintrag	20100330

Method GET_INITIAL_DRILL_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_INITIAL_DRILL_LEVEL	Value transfer		Type reference (TYPE)	I			20100323

Method GET_INITIAL_DRILL_LEVEL on Interface IF_BICS_HIERARCHY has no exception.

Method GET_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LEVEL_NUMBER	Call by reference		Type reference (TYPE)	IF_BICS_LEVEL=>TN_LEVEL_NUMBER		Levelnummer	20100323
2	Returning	R_R_LEVEL	Value transfer		Object reference (TYPE REF TO)	IF_BICS_LEVEL		Hierarchielevel	20100323

Method GET_LEVEL on Interface IF_BICS_HIERARCHY has no exception.

Method GET_LEVELS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TS_LEVEL	Value transfer		Type reference (TYPE)	IF_BICS_LEVEL=>TN_TS_LEVEL			20100325

Method GET_LEVELS on Interface IF_BICS_HIERARCHY has no exception.

Method GET_MAXIMUM_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_MAXIMUM_LEVEL	Value transfer		Object reference (TYPE REF TO)	IF_BICS_LEVEL		Hierarchielevel	20100323

Method GET_MAXIMUM_LEVEL on Interface IF_BICS_HIERARCHY has no exception.

Method GET_MD_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_MD_HIERARCHY	Value transfer		Object reference (TYPE REF TO)	IF_BICS_MD_HIERARCHY		Hierarchie MD-Layer	20100323

Method GET_MD_HIERARCHY on Interface IF_BICS_HIERARCHY has no exception.

Method GET_MINIMUM_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_MINIMUM_LEVEL	Value transfer		Object reference (TYPE REF TO)	IF_BICS_LEVEL		Hierarchielevel	20100323

Method GET_MINIMUM_LEVEL on Interface IF_BICS_HIERARCHY has no exception.

Method GET_NODE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	I_NODE_ID	Call by reference	Type reference (TYPE)	IF_BICS_OBJECT=>TN_ID	Knoten-ID	20100325
2	Importing	I_NODE_NAME	Call by reference	Type reference (TYPE)	IF_BICS_OBJECT=>TN_NAME	Knotenname	20100323
3	Importing	I_NODE_TYPE_ID	Call by reference	Type reference (TYPE)	IF_BICS_NODE_TYPE=>TN_ID	ID des Knotentyps	20100326
4	Importing	I_NODE_TYPE_NAME	Call by reference	Type reference (TYPE)	IF_BICS_NODE_TYPE=>TN_NAME	Name des Knotentyps	20100415
5	Importing	I_R_PRESENTATION	Call by reference	Object reference (TYPE REF TO)	CL_BICS_PRESENTATION	Darstellung von Membern in BICS	20100326
6	Returning	R_R_NODE	Value transfer	Object reference (TYPE REF TO)	IF_BICS_NODE	Ausprägung eines InfoObjekts	20100507

#	Exception	Resumable	Description	Created on
1	CX_BICS_LIST_MEMBER_NOT_FOUND		Ausnahme für Listen: unbekannter Eintrag	20100330

Method GET_NODES Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	I_LEVEL_NUMBER	Call by reference	Type reference (TYPE)	IF_BICS_LEVEL=>TN_LEVEL_NUMBER	Drillstufe	20100428
2	Importing	I_MAX_NODES	Call by reference	Type reference (TYPE)	I	Maximale Anzahl der zu lesenden Knoten	20110718
3	Returning	R_R_NODE_CONTAINER	Value transfer	Object reference (TYPE REF TO)	IF_BICS_IOBJ_MEMBER_CONTAINER	Behälter für (einen oder mehrere) Knoten	20100408

Method GET_NODES on Interface IF_BICS_HIERARCHY has no exception.

Method GET_NODES_AT_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LEVEL	Call by reference		Type reference (TYPE)	IF_BICS_LEVEL=>TN_LEVEL_NUMBER		Levelnummer	20100401
2	Returning	R_R_NODE_CONTAINER	Value transfer		Object reference (TYPE REF TO)	IF_BICS_IOBJ_MEMBER_CONTAINER		Behälter für (einen oder mehrere) Knoten	20100408

Method GET_NODES_AT_LEVEL on Interface IF_BICS_HIERARCHY has no exception.

Method GET_NODE_ALIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_NODE_ALIGNMENT	Value transfer		Object reference (TYPE REF TO)	CL_BICS_ALIGNMENT		Objektausrichtung	20100323

Method GET_NODE_ALIGNMENT on Interface IF_BICS_HIERARCHY has no exception.

Method GET_NODE_CONDENSATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_NODE_CONDENSATION	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method GET_NODE_CONDENSATION on Interface IF_BICS_HIERARCHY has no exception.

Method GET_PARENT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	I_LEVEL	Call by reference	Type reference (TYPE)	IF_BICS_LEVEL=>TN_LEVEL_NUMBER	Relative Anzahl von Level lesen	20100325
2	Importing	I_NODE_ID	Call by reference	Type reference (TYPE)	IF_BICS_OBJECT=>TN_ID	ID eines Objektes	20100325
3	Importing	I_NODE_NAME	Call by reference	Type reference (TYPE)	IF_BICS_OBJECT=>TN_NAME	Knotenname	20100325
4	Importing	I_NODE_TYPE_ID	Call by reference	Type reference (TYPE)	IF_BICS_NODE_TYPE=>TN_ID	Knotentyp-ID	20100326
5	Importing	I_R_PRESENTATION	Call by reference	Object reference (TYPE REF TO)	CL_BICS_PRESENTATION	Darstellung von Membern in BICS	20100326
6	Returning	R_R_PARENT	Value transfer	Object reference (TYPE REF TO)	IF_BICS_NODE	Übergeordnete Knoten	20100507

#	Exception	Resumable	Description	Created on
1	CX_BICS_LIST_MEMBER_NOT_FOUND		Ausnahme für Listen: unbekannter Eintrag	20100330

Method GET_ROOT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_NODE_CONTAINER	Value transfer		Object reference (TYPE REF TO)	IF_BICS_IOBJ_MEMBER_CONTAINER		Behälter für (einen oder mehrere) Knoten	20100408

Method GET_ROOT_NODES on Interface IF_BICS_HIERARCHY has no exception.

Method GET_VISIBILITY_OF_POSTED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_VISIBILITY	Value transfer		Object reference (TYPE REF TO)	CL_BICS_VISIBILITY		Sichtbarkeit von Objekten	20100326

Method GET_VISIBILITY_OF_POSTED_NODES on Interface IF_BICS_HIERARCHY has no exception.

Method HAS_DEFAULT_NODE_ALIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_DEFAULT_NODE_ALIGNMENT	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method HAS_DEFAULT_NODE_ALIGNMENT on Interface IF_BICS_HIERARCHY has no exception.

Method HAS_HIDDEN_LEVELS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HIDDEN_LEVELS	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method HAS_HIDDEN_LEVELS on Interface IF_BICS_HIERARCHY has no exception.

Method HAS_HIDDEN_NODE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HIDDEN_NODE_TYPES	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method HAS_HIDDEN_NODE_TYPES on Interface IF_BICS_HIERARCHY has no exception.

Method IS_LEVELLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_LEVELLED	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method IS_LEVELLED on Interface IF_BICS_HIERARCHY has no exception.

Method SET_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVE	Call by reference		Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Hierarchie aktiv	20100323
2	Returning	R_CHANGED	Value transfer		Type reference (TYPE)	ABAP_BOOL			20110616

Method SET_ACTIVE on Interface IF_BICS_HIERARCHY has no exception.

Method SET_INITIAL_DRILL_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LEVEL	Call by reference		Type reference (TYPE)	IF_BICS_LEVEL=>TN_LEVEL_NUMBER		Initiale Drill-Stufe	20100323

Method SET_INITIAL_DRILL_LEVEL on Interface IF_BICS_HIERARCHY has no exception.

Method SET_LEAVES_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_VISIBLE	Call by reference		Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Default: Sichtbar	20100323

Method SET_LEAVES_VISIBLE on Interface IF_BICS_HIERARCHY has no exception.

Method SET_NODE_ALIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_ALIGNMENT	Call by reference		Object reference (TYPE REF TO)	CL_BICS_ALIGNMENT		Objektausrichtung	20100323

Method SET_NODE_ALIGNMENT on Interface IF_BICS_HIERARCHY has no exception.

Method SET_NODE_CONDENSATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONDENSE	Call by reference		Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Default: Kondensieren	20100323

Method SET_NODE_CONDENSATION on Interface IF_BICS_HIERARCHY has no exception.

Method SET_VISIBILITY_OF_POSTED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_VISIBILITY	Call by reference		Object reference (TYPE REF TO)	CL_BICS_VISIBILITY		Sichtbarkeit von Objekten	20100323

Method SET_VISIBILITY_OF_POSTED_NODES on Interface IF_BICS_HIERARCHY has no exception.

Method SUPPORTS_NODE_ALIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_ALIGNMENT	Call by reference		Object reference (TYPE REF TO)	CL_BICS_ALIGNMENT		Objektausrichtung	20100323
2	Returning	R_SUPPORTS_NODE_ALIGNMENT	Value transfer		Type reference (TYPE)	ABAP_BOOL			20100323

Method SUPPORTS_NODE_ALIGNMENT on Interface IF_BICS_HIERARCHY has no exception.

History

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

Object Hierarchy

Using

Used by

Advertise Links