DBA Data[Home] [Help]

PACKAGE: APPS.PAY_HK_BAL_UPLOAD

Source


1 package pay_hk_bal_upload as
2 -- /* $Header: pyhkupld.pkh 120.0 2005/05/29 05:40:41 appldev noship $ */
3 --
4 -- +======================================================================+
5 -- |              Copyright (c) 2001 Oracle Corporation UK Ltd            |
6 -- |                        Reading, Berkshire, England                   |
7 -- |                           All rights reserved.                       |
8 -- +======================================================================+
9 -- SQL Script File Name : pyhkupld.pkh
10 -- Description          : This script delivers balance upload support
11 --                        functions for the Hong Kong localization (HK).
12 --
13 -- DELIVERS EXTERNAL functions
14 --   expiry_date
15 --   include_adjustment
16 --   is_supported
17 --   validate_batch_lines
18 --
19 -- Change List:
20 -- ------------
21 --
22 -- ======================================================================
23 -- Version  Date         Author    Bug No.  Description of Change
24 -- -------  -----------  --------  -------  -----------------------------
25 -- 115.0    02-JAN-2001  JBailie            Initial Version - based on the
26 --                                          pay_sg_bal_upload
27 --
28 -- ======================================================================
29 --
30   -----------------------------------------------------------------------------
31   -- FUNCTION NAME
32   --  expiry_date
33   -- PURPOSE
34   --  Returns the expiry date of a given dimension relative to a date.
35   -- ARGUMENTS
36   --  p_upload_date       - the date on which the balance should be correct.
37   --  p_dimension_name    - the dimension being set.
38   --  p_assignment_id     - the assignment involved.
39   --  p_original_entry_id - ORIGINAL_ENTRY_ID context.
40   -- USES
41   -- NOTES
42   --  This is used by pay_balance_upload.dim_expiry_date.
43   -----------------------------------------------------------------------------
44  --
45  function expiry_date
46  (
47   p_upload_date       date
48  ,p_dimension_name    varchar2
49  ,p_assignment_id     number
50  ,p_original_entry_id number
51  ) return date;
52  --
53  pragma restrict_references(expiry_date, WNDS, WNPS);
54  --
55   -----------------------------------------------------------------------------
56   -- NAME
57   --  is_supported
58   -- PURPOSE
59   --  Checks if the dimension is supported by the upload process.
60   -- ARGUMENTS
61   --  p_dimension_name - the balance dimension to be checked.
62   -- USES
63   -- NOTES
64   --  Only a subset of the HK dimensions are supported and these have been
65   --  picked to allow effective migration to release 10.
66   --  This is used by pay_balance_upload.validate_dimension.
67   -----------------------------------------------------------------------------
68  --
69  function is_supported
70  (
71   p_dimension_name varchar2
72  ) return number;
73  --
74   -----------------------------------------------------------------------------
75   -- NAME
76   --  include_adjustment
77   -- PURPOSE
78   --  Given a dimension, and relevant contexts and details of an existing
79   --  balanmce adjustment, it will find out if the balance adjustment effects
80   --  the dimension to be set. Both the dimension to be set and the adjustment
81   --  are for the same assignment and balance. The adjustment also lies between
82   --  the expiry date of the new balance and the date on which it is to set.
83   -- ARGUMENTS
84   --  p_balance_type_id    - the balance to be set.
85   --  p_dimension_name     - the balance dimension to be set.
86   --  p_original_entry_id  - ORIGINAL_ENTRY_ID context.
87   --  p_upload_date        - the date of the upload
88   --  p_batch_line_id      - the batch_line_id from pay_balance_batch_line
89   --  p_test_batch_line_id - the batch_line-id from pay_temp_balance_adjustments
90   -- USES
91   -- NOTES
92   --  All the HK dimensions affect each other when they share the same context
93   --  values so there is no special support required for individual dimensions.
94   --  This is used by pay_balance_upload.get_current_value.
95   -----------------------------------------------------------------------------
96  --
97  function include_adjustment
98  (
99   p_balance_type_id    number
100  ,p_dimension_name     varchar2
101  ,p_original_entry_id  number
102  ,p_upload_date        date
103  ,p_batch_line_id      number
104  ,p_test_batch_line_id number
105 ) return number;
106   --
107   -----------------------------------------------------------------------------
108   -- NAME
109   --  validate_batch_lines
110   -- PURPOSE
111  --   Applies HK specific validation to the batch.
112   -- ARGUMENTS
113   --  p_batch_id - the batch to be validate_batch_linesd.
114   -- USES
115   -- NOTES
116   --  This is used by pay_balance_upload.validate_batch_lines.
117   -----------------------------------------------------------------------------
118  --
119  procedure validate_batch_lines
120  (
121   p_batch_id number
122  );
123  --
124 end pay_hk_bal_upload;