SAP ABAP Class CL_FMHIE_TREE_HANDLER (Sevices for budget distribution)

Hierarchy

☛ EA-PS (Software Component) SAP Enterprise Extension Public Services
   ⤷ PSM-FM-BCS-BU (Application Component) Budgeting
     ⤷ FMBMA_E (Package) Budgeting Rules, BCS

Properties

Class	CL_FMHIE_TREE_HANDLER
Short Description	Sevices for budget distribution
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	FMBMA_E	Budgeting Rules, BCS
Created	20050321	SAP
Last change	20050411	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_FMHIE_TREE_HANDLER has no forward declaration.

Interfaces

Class CL_FMHIE_TREE_HANDLER has no interface implemented.

Friends

Class CL_FMHIE_TREE_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	OFF	Constant	Public	☐	Type reference (TYPE)	BOOLE_D	''	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050321
2	ON	Constant	Public	☐	Type reference (TYPE)	BOOLE_D	'X'	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050321
3	T_HEADER	Static Attribute	Protected	☐	Type reference (TYPE)	TYPE_TH_HEADER_BUFFER		Buffer of hie headers and MD checks	20050321

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_ADDRESS_COMPATIBLE	Static method	Public	Method	Check whether address can be placed under parent address	20050331
2	GET_ADDRESS	Static method	Public	Method		20050321
3	GET_ADDR_FROM_SELCRITTABS	Static method	Public	Method		20050324
4	GET_HIE_HEADER	Static method	Protected	Method	Gets hierarchy header reference for a header (do not use)	20050321
5	GET_HIE_ID_FOR_ADDRESS	Static method	Public	Method	Gets hierarchy id, constant address part and objnr.	20050321
6	GET_HIE_SETTINGS_FOR_VERSION	Static method	Public	Method	Gets Budget structure and hier. settings for budget version	20050323
7	GET_MD_CHECKER	Static method	Public	Method	Gets MD checker for a header (can be used as factory method)	20050321
8	GET_NODE	Static method	Public	Method	Get the node information	20050321
9	GET_OBJNR	Static method	Public	Method		20050321
10	GET_PATH	Static method	Public	Method	Get path from the given node to the root	20050322
11	GET_RECEIVERS	Static method	Public	Method	Get possible receivers (get_subtree with adjusted interface)	20050323
12	GET_RELATIONSHIP	Static method	Public	Method	Get relationship info for two addresses	20050322
13	GET_SINGLE_ADDRESS_INFO	Static method	Public	Method	Reads hier. information about single address	20050321
14	GET_SUBTREE	Static method	Public	Method	Get subtree for an entry address	20050322

Events

Class CL_FMHIE_TREE_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYPE_S_HEADER_BUFFER	Protected	See coding			20050321	BEGIN OF type_s_header_buffer, header TYPE fmhie_s_key, ref_md_checker TYPE REF TO cl_fm_md_checker_hie, * ref_hie_head TYPE REF TO cl_fmhie_headers, END OF type_s_header_buffer
2	TYPE_TH_HEADER_BUFFER	Protected	See coding			20050321	type_th_header_buffer TYPE HASHED TABLE OF type_s_header_buffer WITH UNIQUE KEY header

Method Signatures

Method CHECK_ADDRESS_COMPATIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERRORS_FOUND	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050331
2	Importing	IM_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050331
3	Importing	IM_APPL_LOG	Call by reference	☑	Object reference (TYPE REF TO)	CL_BUBAS_APPL_LOG_CTX		Application log with context	20050331
4	Importing	IM_HIE_HEADER_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_S_HIE_ID_KEY		Keys for Hierarchy ID	20050331
5	Importing	IM_PARENT	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050331

Method CHECK_ADDRESS_COMPATIBLE on class CL_FMHIE_TREE_HANDLER has no exception.

Method GET_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_OBJNR	Value transfer	☐	Type reference (TYPE)	BUBAS_OBJNR		Object number for FM budgeting and AVC	20050321
2	Returning	R_ADDRESS	Value transfer	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321

#	Exception	Resumable	Description	Created on
1	INVALID_OBJNR	☐		20050321

Method GET_ADDR_FROM_SELCRITTABS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_T_DIMPART		Table with FM account assignments	20050324
2	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_S_KEY		Basic Key for Budget Hierarchies	20050324
3	Importing	IM_ROLE	Call by reference	☐	Type reference (TYPE)	FMHIE_HIE_ROLE		Hierarchical Role of FM AA Element	20050324
4	Importing	IM_SELCRITTABS	Call by reference	☐	Type reference (TYPE)	FMBAS_S_DIMSELTABS		Select options for dimensions	20050324

Method GET_ADDR_FROM_SELCRITTABS on class CL_FMHIE_TREE_HANDLER has no exception.

Method GET_HIE_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_S_KEY		Basic Key for Budget Hierarchies	20050321
2	Returning	REF_HIE_HEADER	Value transfer	☐	Object reference (TYPE REF TO)	CL_FMHIE_HEADERS		Services for Hierarchy Headers	20050321

Method GET_HIE_HEADER on class CL_FMHIE_TREE_HANDLER has no exception.

Method GET_HIE_ID_FOR_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_HIE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_HIE_ID		Hierarchy ID	20050321
2	Importing	IM_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
3	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_S_KEY		Basic Key for Budget Hierarchies	20050321

#	Exception	Resumable	Description	Created on
1	NO_HIE_ID_ASSIGNED	☐	For this address there is no hie id assigned	20050321

Method GET_HIE_SETTINGS_FOR_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HEADER_BU	Call by reference	☐	Type reference (TYPE)	FMHIE_BU_INTERFACE_HEADER		Interface structure for hiearchy services	20050323
2	Returning	R_HEADER_HIE	Value transfer	☐	Type reference (TYPE)	FMHIE_S_KEY		Basic Key for Budget Hierarchies	20050323

#	Exception	Resumable	Description	Created on
1	HIERARCHY_NOT_ACTIVE	☐		20050323

Method GET_MD_CHECKER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_S_KEY		Basic Key for Budget Hierarchies	20050321
2	Returning	REF_CHECKER	Value transfer	☐	Object reference (TYPE REF TO)	CL_FM_MD_CHECKER_HIE			20050321

#	Exception	Resumable	Description	Created on
1	CUSTOMIZING_INCONSISTENT	☐		20050321
2	CUSTOMIZING_INCONSISTENT_HIE	☐		20050321
3	WRONG_INPUT	☐		20050321

Method GET_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CHILD	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
2	Exporting	E_NEXT_SIBLING	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
3	Exporting	E_NODE	Call by reference	☐	Type reference (TYPE)	FMHIE_S_ADDRESS_LEVEL		FM address with hierarchy level	20050321
4	Exporting	E_PARENT	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
5	Exporting	E_ROOT	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
6	Importing	IM_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		Part addresses for hierarchical part and rest	20050322
7	Importing	IM_HEADER_HIE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_S_HIE_ID_KEY		Keys for Hierarchy ID	20050321

#	Exception	Resumable	Description	Created on
1	NO_HIE_NODE	☐		20050321
2	WRONG_INPUT	☐		20050322

Method GET_OBJNR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
2	Returning	R_OBJNR	Value transfer	☐	Type reference (TYPE)	BUBAS_OBJNR		Object number for FM budgeting and AVC	20050321

#	Exception	Resumable	Description	Created on
1	NO_OBJNR_FOUND	☐		20050321

Method GET_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NODE	Call by reference	☐	Type reference (TYPE)	FMHIE_S_ADDRESS_LEVEL		Entry node	20050322
2	Exporting	E_T_PATH	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Table for FM address with hierarchical level	20050322
3	Importing	IM_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		Part addresses for hierarchical part and rest	20050322
4	Importing	IM_HEADER_HIE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_S_HIE_ID_KEY		Keys for Hierarchy ID	20050322
5	Importing	IM_INCLUDE_ENTRY_NODE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ON	The result should also contain the entry node?	20050322

#	Exception	Resumable	Description	Created on
1	NO_HIE_NODE	☐		20050322

Method GET_RECEIVERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_SUBTREE	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Table for FM address with hierarchical level	20050323
2	Importing	IM_ENTRY_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		Entry node	20050323
3	Importing	IM_FLG_DIRECT_DISTRIBUTION	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	Read only one level (number of leves not relevant then)	20050323
4	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_BU_INTERFACE_HEADER		Key	20050323
5	Importing	IM_MAX_NUMBER_OF_LEVELS	Call by reference	☑	Type reference (TYPE)	I		Read all if initial	20050323

#	Exception	Resumable	Description	Created on
1	HIERARCHY_NOT_ACTIVE	☐	Budget structure assigned to the given version is not hierar	20050323
2	NO_HIE_NODE	☐	The address is not in the hierarchy	20050323

Method GET_RELATIONSHIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_COMMON_PARENT	Call by reference	☐	Type reference (TYPE)	FMHIE_S_ADDRESS_LEVEL		First common parent	20050322
2	Exporting	E_FLG_COMMON_PARENT_EXISTS	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Common parent exist?	20050322
3	Exporting	E_FLG_DISTRIB_POSSIBLE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Is distribution possible	20050322
4	Exporting	E_FLG_IS_CHILD	Call by reference	☐	Type reference (TYPE)	BOOLE_D		The lower address is direct child	20050322
5	Exporting	E_T_PATH_LOWER	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Path to the top for the lower address	20050322
6	Exporting	E_T_PATH_UPPER	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Table for FM address with hierarchical level	20050322
7	Importing	IM_ADDRESS_LOWER	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		Lower address (exception if lower level <= upper level)	20050322
8	Importing	IM_ADDRESS_UPPER	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		Upper address (exception if lower level <= upper level)	20050322
9	Importing	IM_FLG_CHECK_ADDRESS_ORDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ON	Is lower address really lower?	20050404
10	Importing	IM_FLG_CHECK_CHILD	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ON	check parent of Lower address = = upper_address?	20050322
11	Importing	IM_FLG_CHECK_DISTRIB_POSSIBLE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	is distribution possible from upper to lower?	20050322
12	Importing	IM_FLG_GET_COMMON_PARENT	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	get first common parent?	20050322
13	Importing	IM_FLG_GET_PATH	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	get path for both addresses	20050322
14	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_BU_INTERFACE_HEADER		Basic Key for Budget Hierarchies	20050322

#	Exception	Resumable	Description	Created on
1	HIERARCHY_NOT_ACTIVE	☐	Budget structure assigned to the given version is not hierar	20050323
2	INVALID_LOWER_ADDRESS	☐	The lower address level < upper address level	20050322
3	NO_HIE_NODE	☐	The node is not part of the hierarchy (with message)	20050322
4	NO_RELATIONSHIP	☐	Different hie ids or have different not relevant addresses	20050322

Method GET_SINGLE_ADDRESS_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_ROOT	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Is IM_ADDRESS a root in the hierarchy?	20050321
2	Exporting	E_PARENT	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
3	Exporting	E_T_PATH	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Table for FM address with hierarchical level	20050321
4	Exporting	E_T_SUBTREE	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Table for FM address with hierarchical level	20050321
5	Importing	IM_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		FM account assignment	20050321
6	Importing	IM_FLG_GET_PATH	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	Get path to the top	20050322
7	Importing	IM_FLG_GET_SUBTREE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	Get the subtree for the entry node (without entry node)	20050321
8	Importing	IM_HEADER	Call by reference	☐	Type reference (TYPE)	FMHIE_BU_INTERFACE_HEADER		Basic Key for Budget Hierarchies	20050321

#	Exception	Resumable	Description	Created on
1	HIERARCHY_NOT_ACTIVE	☐	Budget structure assigned to the given version is not hierar	20050323
2	NO_HIE_NODE	☐	The FM address does not exist in the hierarchy	20050321

Method GET_SUBTREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_SUBTREE	Call by reference	☐	Type reference (TYPE)	FMHIE_T_ADDRESS_LEVEL		Table for FM address with hierarchical level	20050322
2	Importing	IM_ENTRY_ADDRESS	Call by reference	☐	Type reference (TYPE)	FMKU_S_DIMPART		Entry node	20050322
3	Importing	IM_HEADER_HIE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_S_HIE_ID_KEY		Key with hiearchy ID	20050322
4	Importing	IM_INCLUDE_ENTRY_NODE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ON	The result should also contain entry node?	20050322
5	Importing	IM_MAX_NUMBER_OF_LEVELS	Call by reference	☑	Type reference (TYPE)	I		Read all if initial	20050322

#	Exception	Resumable	Description	Created on
1	NO_HIE_NODE	☐		20050322

History

Last changed by/on	SAP	20050411
SAP Release Created in	600