DBA Data[Home] [Help]

PACKAGE: APPS.PY_DK_TAX_CARD

Source


1 PACKAGE py_dk_tax_card AS
2 /* $Header: pydktaxc.pkh 120.0.12010000.1 2008/07/27 22:27:29 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_taxcard >----------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --  This API will insert a tax card entry for a Norway Assignment.
11 --  This API delegates to the create_element_entry procedure of the
12 --  pay_element_entry_api package.
13 --
14 -- Prerequisites:
15 --  The element entry (of element type 'Tax Card') and the corresponding
16 --  element link should exist for the given assignment and business group.
17 --
18 -- In Parameters:
19 --  Name                Reqd    Type     Description
20 --  p_legislation_code  Yes     VARCHAR2 Legislation code.
21 --  p_effective_date    Yes     DATE     The effective date of the
22 --                                       change.
23 --  p_assignment_id     Yes     VARCHAR2 Id of the assignment.
24 --  p_person_id         Yes     VARCHAR2 Id of the person.
25 --  p_business_group_id Yes     VARCHAR2 Id of the business group.
26 --  p_tax_free_threshold        NUMBER   Element entry value.
27 --  p_weekly_td                 NUMBER   Element entry value.
28 --  p_daily_td                  DATE     Element entry value.
29 --  p_registration_date         DATE     Element entry value.
30 --  p_method_of_receipt         VARCHAR2 Element entry value.
31 --  p_tax_card_type             VARCHAR2 Element entry value.
32 --  p_tax_percentage            VARCHAR2 Element entry value.
33 --  p_monthly_td                VARCHAR2 Element entry value.
34 --  p_biweekly_td               VARCHAR2 Element entry value.
35 --  p_date_returned             DATE     Element entry value.
36 --  p_element_entry_id          VARCHAR2 Id of the element entry.
37 --  p_element_link_id           VARCHAR2 Id of the element link.
38 --
39 --
40 -- Post Success:
41 --
42 --  The API successfully updates the tax card entry.
43 --
44 -- Post Failure:
45 --   The API will raise an error.
46 --
47 -- Access Status:
48 --   Private. For Internal Development Use only.
49 --
50 -- {End Of Comments}
51 --
52    PROCEDURE insert_taxcard (
53     p_legislation_code      IN  VARCHAR2
54     ,p_effective_date       IN  DATE
55     ,p_assignment_id        IN  VARCHAR2
56     ,p_person_id            IN  VARCHAR2
57     ,p_business_group_id    IN  VARCHAR2
58     ,p_tax_free_threshold   IN  NUMBER      DEFAULT NULL
59     ,p_weekly_td            IN  NUMBER      DEFAULT NULL
60     ,p_daily_td             IN  NUMBER      DEFAULT NULL
61     ,p_registration_date    IN  DATE        DEFAULT NULL
62     ,p_method_of_receipt    IN  VARCHAR2    DEFAULT NULL
63     ,p_tax_card_type        IN  VARCHAR2    DEFAULT NULL
64     ,p_tax_percentage       IN  NUMBER      DEFAULT NULL
65     ,p_monthly_td           IN  NUMBER      DEFAULT NULL
66     ,p_biweekly_td          IN  NUMBER      DEFAULT NULL
67     ,p_date_returned        IN  DATE        DEFAULT NULL);
68 --
69 -- ----------------------------------------------------------------------------
70 -- |--------------------------< update_taxcard >----------------------------|
71 -- ----------------------------------------------------------------------------
72 -- {Start Of Comments}
73 --
74 -- Description:
75 --  This API will update the tax card entry for a Norway Assignment.
76 --  This API delegates to the update_element_entry procedure of the
77 --  pay_element_entry_api package.
78 --
79 -- Prerequisites:
80 --  The element entry (of element type 'Tax Card') and the corresponding
81 --  element link should exist for the given assignment and business group.
82 --
83 -- In Parameters:
84 --  Name            Reqd    Type     Description
85 --  p_legislation_code      Yes     VARCHAR2 Legislation code.
86 --  p_effective_date        Yes     DATE     The effective date of the
87 --                                       change.
88 --  p_assignment_id         Yes     VARCHAR2 Id of the assignment.
89 --  p_person_id             Yes     VARCHAR2 Id of the person.
90 --  p_business_group_id     Yes     VARCHAR2 Id of the business group.
91 --  p_tax_free_threshold            NUMBER   Element entry value.
92 --  p_weekly_td                     NUMBER   Element entry value.
93 --  p_daily_td                      DATE     Element entry value.
94 --  p_registration_date             DATE     Element entry value.
95 --  p_method_of_receipt             VARCHAR2 Element entry value.
96 --  p_tax_card_type                 VARCHAR2 Element entry value.
97 --  p_tax_percentage                VARCHAR2 Element entry value.
98 --  p_monthly_td                    VARCHAR2 Element entry value.
99 --  p_biweekly_td                   VARCHAR2 Element entry value.
100 --  p_date_returned                 DATE     Element entry value.
101 --  p_element_entry_id              VARCHAR2 Id of the element entry.
102 --  p_element_link_id               VARCHAR2 Id of the element link.
103 --  p_object_version_number Yes     VARCHAR2 Version number of the element
104 --                                           entry record.
105 --  p_input_value_id1               VARCHAR2 Id of the input value 1 for the
106 --                                              element.
107 --  p_input_value_id2               VARCHAR2 Id of the input value 2 for the
108 --                                               element.
109 --  p_input_value_id3               VARCHAR2 Id of the input value 3 for the
110 --                                              element.
111 --  p_input_value_id4               VARCHAR2 Id of the input value 4 for the
112 --                                              element.
113 --  p_input_value_id5               VARCHAR2 Id of the input value 5 for the
114 --                                              element.
115 --  p_input_value_id6               VARCHAR2 Id of the input value 6 for the
116 --                                              element.
117 --  p_input_value_id7               VARCHAR2 Id of the input value 7 for the
118 --                                               element.
119 --  p_input_value_id8               VARCHAR2 Id of the input value 8 for the
120 --                                               element.
121 --  p_input_value_id9               VARCHAR2 Id of the input value 9 for the
122 --                                               element.
123 --  p_datetrack_update_mode         VARCHAR2 The date track update mode for
124 --                                              the record
125 --
126 --
127 -- Post Success:
128 --
129 --  The API successfully updates the tax card entry.
130 --
131 -- Post Failure:
132 --   The API will raise an error.
133 --
134 -- Access Status:
135 --   Private. For Internal Development Use only.
136 --
137 -- {End Of Comments}
138 --
139 PROCEDURE update_taxcard (
140     p_legislation_code      IN  VARCHAR2
141     ,p_effective_date       IN  DATE
142     ,p_assignment_id        IN  VARCHAR2
143     ,p_person_id            IN  VARCHAR2
144     ,p_business_group_id    IN  VARCHAR2
145     ,p_tax_free_threshold   IN  NUMBER      DEFAULT NULL
146     ,p_weekly_td            IN  NUMBER      DEFAULT NULL
147     ,p_daily_td             IN  NUMBER      DEFAULT NULL
148     ,p_registration_date    IN  DATE        DEFAULT NULL
149     ,p_method_of_receipt    IN  VARCHAR2    DEFAULT NULL
150     ,p_tax_card_type        IN  VARCHAR2    DEFAULT NULL
151     ,p_tax_percentage       IN  NUMBER      DEFAULT NULL
152     ,p_monthly_td           IN  NUMBER      DEFAULT NULL
153     ,p_biweekly_td          IN  NUMBER      DEFAULT NULL
154     ,p_date_returned        IN  DATE        DEFAULT NULL
155     ,p_element_entry_id     IN  VARCHAR2
156     ,p_element_link_id      IN  VARCHAR2
157     ,p_object_version_number IN  VARCHAR2
158     ,p_input_value_id1      IN  VARCHAR2    DEFAULT NULL
159     ,p_input_value_id2      IN  VARCHAR2    DEFAULT NULL
160     ,p_input_value_id3      IN  VARCHAR2    DEFAULT NULL
161     ,p_input_value_id4      IN  VARCHAR2    DEFAULT NULL
162     ,p_input_value_id5      IN  VARCHAR2    DEFAULT NULL
163     ,p_input_value_id6      IN  VARCHAR2    DEFAULT NULL
164     ,p_input_value_id7      IN  VARCHAR2    DEFAULT NULL
165     ,p_input_value_id8      IN  VARCHAR2    DEFAULT NULL
166     ,p_input_value_id9      IN  VARCHAR2    DEFAULT NULL
167     ,p_input_value_id10     IN  VARCHAR2    DEFAULT NULL
168     ,p_datetrack_update_mode    IN  VARCHAR2    DEFAULT NULL);
169 --
170 -- ----------------------------------------------------------------------------
171 -- |--------------------------< find_dt_upd_modes >----------------------------|
172 -- ----------------------------------------------------------------------------
173 -- {Start Of Comments}
174 --
175 -- Description:
176 --   This API returns the DT modes for pay_element_entries_f for a given
177 --  element_entry_id (base key value) on a specified date
178 --
179 -- Prerequisites:
180 --   The element_entry (p_base_key_value) must exist as of the effective date
181 --   of the change (p_effective_date).
182 --
183 -- In Parameters:
184 --  Name                Reqd    Type    Description
185 --  p_effective_date    Yes     DATE    The effective date of the
186 --                                              change.
187 --  p_base_key_value    Yes     NUMBER  ID of the element entry.
188 --
189 --
190 -- Post Success:
191 --
192 --   The API sets the following out parameters:
193 --
194 --  Name                    Type    Description
195 --  p_correction            BOOLEAN True if correction mode is valid.
196 --  p_update                BOOLEAN True if update mode is valid.
197 --  p_update_override       BOOLEAN True if update override mode is valid.
198 --  p_update_change_insert  BOOLEAN True if update change insert mode is
199 --                                  valid.
200 --  p_update_start_date     DATE    Start date for Update record.
201 --  p_update_end_date       DATE    End date for Update record.
202 --  p_override_start_date   DATE    Start date for Override.
203 --  p_override_end_date     DATE    End date for Overrride.
204 --  p_upd_chg_start_date    DATE    Start date for Update Change.
205 --  p_upd_chg_end_date      DATE    End date for Update Change.
206 
207 -- Post Failure:
208 --   The API will raise an error.
209 --
210 -- Access Status:
211 --   Private. For Internal Development Use only.
212 --
213 -- {End Of Comments}
214 --
215 PROCEDURE  find_dt_upd_modes(
216     p_effective_date            IN          DATE
217     ,p_base_key_value           IN          NUMBER
218     ,p_correction               OUT NOCOPY  BOOLEAN
219     ,p_update                   OUT NOCOPY  BOOLEAN
220     ,p_update_override          OUT NOCOPY  BOOLEAN
221     ,p_update_change_insert     OUT NOCOPY  BOOLEAN
222     ,p_correction_start_date    OUT NOCOPY  DATE
223     ,p_correction_end_date      OUT NOCOPY  DATE
224     ,p_update_start_date        OUT NOCOPY  DATE
225     ,p_update_end_date          OUT NOCOPY  DATE
226     ,p_override_start_date      OUT NOCOPY  DATE
227     ,p_override_end_date        OUT NOCOPY  DATE
228     ,p_upd_chg_start_date       OUT NOCOPY  DATE
229     ,p_upd_chg_end_date         OUT NOCOPY  DATE);
230 --
231 -- -----------------------------------------------------------------------------
232 -- |--------------------------< get_global_value >-----------------------------|
233 -- -----------------------------------------------------------------------------
234 --
235 -- {Start of Comments}
236 --
237 -- Description:
238 --   Returns the value for the global on a given date.
239 --
240 -- Prerequisites:
241 --   None
242 --
243 -- In Parameters
244 --  Name            Reqd    Type        Description
245 --  p_global_name       Yes VARCHAR2    Assignment id
246 --  p_legislation_code  Yes VARCHAR2    Legislation Code
247 --  p_effective_date    Yes DATE        Effective date
248 --
249 -- Post Success:
250 --   The value of the global of type FF_GLOBALS_F.GLOBAL_VALUE is returned
251 --
252 -- Post Failure:
253 --   An error is raised
254 --
255 -- Access Status:
256 --   Internal Development Use Only
257 --
258 -- {End of Comments}
259 --
260 FUNCTION get_global_value(
261     p_global_name       VARCHAR2
262     ,p_legislation_code VARCHAR2
263     ,p_effective_date   DATE) RETURN ff_globals_f.global_value%TYPE;
264 
265 
266 END py_dk_tax_card;
267