[Home] [Help]
1: PACKAGE BODY GCS_HIERARCHIES_PKG AS
2: /* $Header: gcshierb.pls 120.3 2006/05/22 12:36:19 smatam noship $ */
3: --
4: -- Package
5: -- gcs_hierarchies_pkg
1: PACKAGE BODY GCS_HIERARCHIES_PKG AS
2: /* $Header: gcshierb.pls 120.3 2006/05/22 12:36:19 smatam noship $ */
3: --
4: -- Package
5: -- gcs_hierarchies_pkg
6: -- Purpose
7: -- Package procedures for Consolidation Hierarchies
8: -- History
9: -- 28-JUN-04 M Ward Created
11: --
12: -- Private Global Variables
13: --
14: -- The API name
15: g_api CONSTANT VARCHAR2(40) := 'gcs.plsql.GCS_HIERARCHIES_PKG';
16: -- Action types for writing module information to the log file. Used for
17: -- the procedure log_file_module_write.
18: g_module_enter CONSTANT VARCHAR2(2) := '>>';
19: g_module_success CONSTANT VARCHAR2(2) := '<<';
53: -- last_update_login
54: -- creation_date
55: -- created_by
56: -- Example
57: -- GCS_HIERARCHIES_PKG.Insert_Row(...);
58: -- Notes
59: --
60: PROCEDURE Insert_Row(row_id IN OUT NOCOPY VARCHAR2,
61: hierarchy_id VARCHAR2,
187: -- last_update_date
188: -- last_udpated_by
189: -- last_update_login
190: -- Example
191: -- GCS_HIERARCHIES_PKG.Update_Row(...);
192: -- Notes
193: --
194: PROCEDURE Update_Row(hierarchy_id VARCHAR2,
195: top_entity_id NUMBER,
294: -- object_version_number
295: -- hierarchy_name
296: -- description
297: -- Example
298: -- GCS_HIERARCHIES_PKG.Load_Row(...);
299: -- Notes
300: --
301: PROCEDURE Load_Row(hierarchy_id VARCHAR2,
302: owner VARCHAR2,
397: -- custom_mode
398: -- hierarchy_name
399: -- description
400: -- Example
401: -- GCS_HIERARCHIES_PKG.Translate_Row(...);
402: -- Notes
403: --
404: PROCEDURE Translate_Row(hierarchy_id NUMBER,
405: owner VARCHAR2,
448: -- Purpose
449: --
450: -- Arguments
451: --
452: -- GCS_HIERARCHIES_PKG.ADD_LANGUAGE();
453: -- Notes
454: --
455: procedure ADD_LANGUAGE is
456: begin
499: -- Arguments
500: -- p_module Name of the module
501: -- p_action_type Entered, Exited Successfully, or Exited with Failure
502: -- Example
503: -- GCS_HIERARCHIES_PKG.Module_Log_Write
504: -- Notes
505: --
506: PROCEDURE Module_Log_Write(p_module VARCHAR2, p_action_type VARCHAR2) IS
507: BEGIN
526: -- p_module Name of the module
527: -- p_level Logging level
528: -- p_text Text to write
529: -- Example
530: -- GCS_HIERARCHIES_PKG.Write_To_Log
531: -- Notes
532: --
533: PROCEDURE Write_To_Log(p_module VARCHAR2,
534: p_level NUMBER,
564: -- p_entity_id The key
565: -- Return Value
566: -- The value in the hashtable, of NULL if no value exists
567: -- Example
568: -- GCS_HIERARCHIES_PKG.Entity_In_Hashtable(...);
569: -- Notes
570: --
571: FUNCTION Entity_Exists(p_entities_hashtable IN OUT NOCOPY EntitiesTableType,
572: p_entity_id NUMBER) RETURN NUMBER IS
599: -- get to the current entity
600: -- p_calc_parent_entities List of entities for which we have already run
601: -- delta calculations
602: -- Example
603: -- GCS_HIERARCHIES_PKG.Calc_Delta_To_Single_Parent(...);
604: -- Notes
605: --
606: PROCEDURE Calc_Delta_To_Single_Parent(p_hierarchy_id NUMBER,
607: p_original_entity_id NUMBER,
911: -- p_end_date Date range for performing the logic
912: -- p_calc_parent_entities List of entities we have already gone through
913: -- to get to this parent
914: -- Example
915: -- GCS_HIERARCHIES_PKG.Calc_Delta_To_All_Parents(...);
916: -- Notes
917: --
918: PROCEDURE Calc_Delta_To_All_Parents(p_hierarchy_id NUMBER,
919: p_original_entity_id NUMBER,
1046: -- p_effective_date Date range for performing the logic
1047: -- p_calc_child_entities Entities for which the calculation has already
1048: -- been performed
1049: -- Example
1050: -- GCS_HIERARCHIES_PKG.Calculate_Delta_Internal(...);
1051: -- Notes
1052: --
1053: PROCEDURE Calculate_Delta_Internal(p_hierarchy_id NUMBER,
1054: p_child_entity_id NUMBER,
1146: -- p_hierarchy_id Hierarchy for which the logic must be performed
1147: -- p_child_entity_id Entity for which the logic must be performed
1148: -- p_effective_date Start date for performing the logic
1149: -- Example
1150: -- GCS_HIERARCHIES_PKG.Calculate_Delta(...);
1151: -- Notes
1152: --
1153: PROCEDURE Calculate_Delta(p_hierarchy_id NUMBER,
1154: p_child_entity_id NUMBER,
1186: -- p_parent_id Entity to start the search from
1187: -- p_start_date Effective date range
1188: -- p_end_date Effective date range
1189: -- Example
1190: -- GCS_HIERARCHIES_PKG.Reciprocal_Exists(...);
1191: -- Notes
1192: --
1193: FUNCTION Reciprocal_Exists(p_hierarchy_id NUMBER,
1194: p_child_id NUMBER,
1243: -- p_parent_id Parent entity
1244: -- p_parent_id Child entity
1245: -- p_date Date
1246: -- Example
1247: -- GCS_HIERARCHIES_PKG.Calc_Delta_To_All_Parents(...);
1248: -- Notes
1249: --
1250: FUNCTION get_Ccy_Treat(p_hierarchy_id NUMBER,
1251: p_parent_id NUMBER,
1321: -- entity in the update flow.
1322: -- Arguments
1323: -- p_rel_id New relationship identifier
1324: -- Example
1325: -- GCS_HIERARCHIES_PKG.Set_Dominance(123, 'ADD');
1326: -- Notes
1327: --
1328: PROCEDURE Set_Dominance(p_rel_id NUMBER) IS
1329: l_hierarchy_id NUMBER;
2073: -- Arguments
2074: -- p_hier_id Hierarchy identifier
2075: -- p_removal_date Date of the removal
2076: -- Example
2077: -- GCS_HIERARCHIES_PKG.Set_Dominance(123, 'ADD');
2078: -- Notes
2079: --
2080: PROCEDURE Handle_Remove(p_hier_id NUMBER, p_removal_date DATE) IS
2081: CURSOR all_child_rels_c IS
2195: -- .
2196: -- Arguments
2197: -- p_data_type_code Data Type Code identifier
2198: -- Example
2199: -- GCS_HIERARCHIES_PKG.Update_Hierarchies_Datatype('TEST' );
2200: -- Notes
2201: --
2202: PROCEDURE Update_Hierarchies_Datatype(p_data_type_code VARCHAR2) IS
2203: TYPE hier_info_rec_type IS RECORD(
2386: -- .
2387: -- Arguments
2388: -- p_hier_id Hierarchy identifier
2389: -- Example
2390: -- GCS_HIERARCHIES_PKG.Handle_Datatypes(123 );
2391: -- Notes
2392: --
2393: PROCEDURE Handle_Datatypes(p_hierarchy_id NUMBER) IS
2394: TYPE data_type_info_rec_type IS RECORD(
2585: -- Updates the Dataset name/desc and Ledger Name/Desc when Hierarchy Name is changed.
2586: -- Arguments
2587: -- p_hier_id Hierarchy identifier
2588: -- Example
2589: -- GCS_HIERARCHIES_PKG.Handle_Datasets_Ledger(hierarchyId );
2590: -- Notes
2591: --
2592: PROCEDURE Handle_Datasets_Ledger(p_hierarchy_id NUMBER) IS
2593: TYPE dataset_info_rec_type IS RECORD(balance_type_code VARCHAR2(30),
2681: AND language = userenv('LANG');
2682:
2683: END Handle_Datasets_Ledger;
2684:
2685: END GCS_HIERARCHIES_PKG;