SAP ABAP Class CL_FMHIE_HEADERS (Services for Hierarchy Headers)
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_HEADERS  
Short Description Services for Hierarchy Headers    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package FMBMA_E   Budgeting Rules, BCS 
Created 20050314   SAP 
Last change 20050409   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_FMHIE_HEADERS has no forward declaration.
Interfaces
Class CL_FMHIE_HEADERS has no interface implemented.
Friends
Class CL_FMHIE_HEADERS has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CON_MAX_NBR_ENQUEUES Constant Protected Type reference (TYPE) I 500 Maximum number of enqueues 20050314
2 G_COUNT_E_ENQUEUES Instance attribute Protected Type reference (TYPE) I 0 Current number of exclusive enqueues 20050314
3 G_COUNT_S_ENQUEUES Instance attribute Protected Type reference (TYPE) I 0 Current number of shared enqueues 20050314
4 G_FLG_GENERIC_E_LOCK Instance attribute Protected Type reference (TYPE) XFELD ' ' Flag: Generic exclusive lock was set 20050314
5 G_FLG_GENERIC_S_LOCK Instance attribute Protected Type reference (TYPE) XFELD ' ' Flag: Generic shared lock was set 20050314
6 G_REF_HEADERS_BUFFER Instance attribute Protected Object reference (TYPE REF TO) CL_BUBAS_MASS_HASHED_BUFFER Hashed buffer with direct reference methods 20050314
7 G_S_HIE_ID_KEY Instance attribute Protected Type reference (TYPE) FMHIE_S_HIE_ID_KEY Keys for Hierarchy ID 20050314
8 G_S_HIE_KEY Instance attribute Protected Type reference (TYPE) FMHIE_S_KEY Basic Key for Budget Hierarchies 20050314
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20050314
2 DEQUEUE_ALL Instance method Public Method Unlocks all header entries 20050314
3 DEQUEUE_SINGLE Instance method Public Method Unlocks single header entry 20050314
4 ENQUEUE_ALL Instance method Public Method Locks all header entries 20050314
5 ENQUEUE_SINGLE Instance method Public Method Locks single header entry 20050314
6 GET_ALL Instance method Public Method Reads all header entries from the list 20050314
7 GET_KEY Instance method Public Method Gets instance attributes 20050314
8 GET_SINGLE Instance method Public Method Reads single header entry from the list 20050314
9 READ_ALL Instance method Public Method Reads all header entries from the DB 20050314
10 READ_SINGLE Instance method Public Method Reads single header entry from the DB 20050314
11 REASSIGN Instance method Public Method Assigns or re-assigns single header entry to hierarchy ID 20050314
12 REFRESH Instance method Public Method Refreshs internal buffer 20050314
13 SAVE Instance method Public Method Saves header entry data to the DB 20050314
14 SET_KEY Instance method Public Method Sets instance attributes 20050314
15 UNASSIGN Instance method Public Method Unassigns single header entry from hierarchy ID 20050314
Events
Class CL_FMHIE_HEADERS has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 T_BUFFER Protected See coding Hashed buffer 20050314 t_buffer TYPE HASHED TABLE OF t_buffer_line WITH UNIQUE KEY keys header_objnr
2 T_BUFFER_LINE Protected See coding Line of headers buffer 20050314 BEGIN OF t_buffer_line , keys TYPE fmhie_s_key, header_objnr TYPE fmhieheaders-header_objnr, attributes TYPE fmhie_s_header, flg_delete TYPE xfeld, END OF t_buffer_line
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_S_KEY Call by reference Type reference (TYPE) FMHIE_S_KEY Basic Key for Budget Hierarchies 20050314

Method CONSTRUCTOR on class CL_FMHIE_HEADERS has no exception.

Method DEQUEUE_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ENQMODE Call by reference Type reference (TYPE) ENQMODE 'E' Lock mode 20050314

Method DEQUEUE_ALL on class CL_FMHIE_HEADERS has no exception.

Method DEQUEUE_SINGLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ENQMODE Call by reference Type reference (TYPE) ENQMODE 'E' Lock mode 20050314
2 Importing IM_HEADER_OBJNR Call by reference Type reference (TYPE) FMHIEHEADERS-HEADER_OBJNR Object number for FM budgeting and AVC 20050314

Method DEQUEUE_SINGLE on class CL_FMHIE_HEADERS has no exception.

Method ENQUEUE_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ENQMODE Call by reference Type reference (TYPE) ENQMODE 'E' Lock mode 20050314
2 Importing IM_FLG_ONLY_BUFFER_ITEMS Call by reference Type reference (TYPE) XFELD 'X' Flag: Only lock entries from the buffer 20050314
# Exception Resumable Description Created on
1 ENQ_ERROR Lock error 20050314

Method ENQUEUE_SINGLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ENQMODE Call by reference Type reference (TYPE) ENQMODE 'E' Lock mode 20050314
2 Importing IM_HEADER_OBJNR Call by reference Type reference (TYPE) FMHIEHEADERS-HEADER_OBJNR Object number for FM budgeting and AVC 20050314
# Exception Resumable Description Created on
1 ENQ_ERROR Lock error 20050314

Method GET_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_T_HEADER Call by reference Type reference (TYPE) FMHIE_T_HEADER Table of hierarchy header entries 20050314

Method GET_ALL on class CL_FMHIE_HEADERS has no exception.

Method GET_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_S_KEY Value transfer Type reference (TYPE) FMHIE_S_KEY Basic Key for Budget Hierarchies 20050314

Method GET_KEY on class CL_FMHIE_HEADERS has no exception.

Method GET_SINGLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_FLG_TO_BE_DELETED Call by reference Type reference (TYPE) XFELD Flag: Assignment is to be deleted 20050316
2 Exporting EX_S_HEADER Call by reference Type reference (TYPE) FMHIE_S_HEADER Hierarchy Header Entry: Object Number and Attributes 20050314
3 Importing IM_HEADER_OBJNR Call by reference Type reference (TYPE) FMHIEHEADERS-HEADER_OBJNR Object number for FM budgeting and AVC 20050314
# Exception Resumable Description Created on
1 INVALID_HEADER_OBJNR No entry for the specified header object number 20050314

Method READ_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_T_HEADER Call by reference Type reference (TYPE) FMHIE_T_HEADER Table of hierarchy header entries 20050314
2 Importing IM_FLG_ADD_TO_BUFFER Call by reference Type reference (TYPE) XFELD 'X' Flag: Add DB records to internal buffer 20050314

Method READ_ALL on class CL_FMHIE_HEADERS has no exception.

Method READ_SINGLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_S_HEADER Call by reference Type reference (TYPE) FMHIE_S_HEADER Hierarchy Header Entry: Object Number and Attributes 20050314
2 Importing IM_FLG_ADD_TO_BUFFER Call by reference Type reference (TYPE) XFELD 'X' Flag: Add DB record to internal buffer 20050314
3 Importing IM_HEADER_OBJNR Call by reference Type reference (TYPE) FMHIEHEADERS-HEADER_OBJNR Object number for FM budgeting and AVC 20050314
# Exception Resumable Description Created on
1 INVALID_HEADER_OBJNR No entry for the specified header object number 20050314

Method REASSIGN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_HEADER_OBJNR Call by reference Type reference (TYPE) FMHIEHEADERS-HEADER_OBJNR Object number for FM budgeting and AVC 20050314
2 Importing IM_HIE_ID Call by reference Type reference (TYPE) FMHIE_HIE_ID Hierarchy ID 20050314
# Exception Resumable Description Created on
1 INVALID_HIE_ID Invalid hierarchy ID 20050314

Method REFRESH Signature

Method REFRESH on class CL_FMHIE_HEADERS has no parameter.
Method REFRESH on class CL_FMHIE_HEADERS has no exception.

Method SAVE Signature

Method SAVE on class CL_FMHIE_HEADERS has no parameter.
# Exception Resumable Description Created on
1 ACCESS_ERROR Error during DB access 20050314

Method SET_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_S_KEY Call by reference Type reference (TYPE) FMHIE_S_KEY Basic Key for Budget Hierarchies 20050314

Method SET_KEY on class CL_FMHIE_HEADERS has no exception.

Method UNASSIGN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_HEADER_OBJNR Call by reference Type reference (TYPE) FMHIEHEADERS-HEADER_OBJNR Object number for FM budgeting and AVC 20050314

Method UNASSIGN on class CL_FMHIE_HEADERS has no exception.
History
Last changed by/on SAP  20050409 
SAP Release Created in 600