DBA Data[Home] [Help]

PACKAGE: APPS.PAY_RETRO_STATUS_INTERNAL

Source


1 Package pay_retro_status_internal as
2 /* $Header: pyrtsbsi.pkh 120.2.12010000.1 2008/11/19 08:52:59 nerao ship $ */
3 
4 --
5 -- Global constants
6 --
7 
8 -- Constants for the owner type.
9 g_user   constant varchar2(10) := 'U'; -- User
10 g_system constant varchar2(10) := 'S'; -- System
11 
12 --
13 -- ----------------------------------------------------------------------------
14 -- |-----------------------< get_unprocessed_retro_asg >----------------------|
15 -- ----------------------------------------------------------------------------
16 -- {Start Of Comments}
17 --
18 -- Description:
19 -- This function returns the unprocessed retro assignment ID for the specified
20 -- assignment. If no record is found, this returns null.
21 --
22 -- Prerequisites:
23 --   None.
24 --
25 -- In Parameters:
26 --   Name                           Reqd Type     Description
27 --   p_assignment_id                Yes  Number   Assignment ID.
28 --
29 -- Post Success:
30 --   The procedure will return the following value:
31 --   Name                           Type     Description
32 --   N/A                            Number   Retro Assignment ID
33 --
34 -- Post Failure:
35 --
36 -- Access Status:
37 --   Internal Development Use Only.
38 --
39 -- {End Of Comments}
40 --
41 function get_unprocessed_retro_asg
42   (p_assignment_id                 in     number
43   ) return number;
44 
45 --
46 -- ----------------------------------------------------------------------------
47 -- |------------------------< create_super_retro_asg >------------------------|
48 -- ----------------------------------------------------------------------------
49 -- {Start Of Comments}
50 --
51 -- Description:
52 -- This procedure creates an unprocessed retro assignment that supersedes
53 -- an existing unprocessed retro assignment.
54 --
55 -- Prerequisites:
56 --   None.
57 --
58 -- In Parameters:
59 --   Name                           Reqd Type     Description
60 --   p_assignment_id                Yes  Number   Assignment ID.
61 --   p_reprocess_date               Yes  Date     Reprocess Date.
62 --   p_start_date                   Yes  Date     Start Date.
63 --   p_approval_status              No   Varchar2 Approval Status.
64 --   p_owner_type                   No   Varchar2 Owner type.
65 --
66 -- Post Success:
67 --   The procedure will set the following out parameters:
68 --   Name                           Type     Description
69 --   p_retro_assignment_id          Number   Retro Assignment ID
70 --
71 -- Post Failure:
72 --   The procedure will not create a retro assignment and raises an error.
73 --
74 -- Access Status:
75 --   Internal Development Use Only.
76 --
77 -- {End Of Comments}
78 --
79 procedure create_super_retro_asg
80   (p_assignment_id                 in     number
81   ,p_reprocess_date                in     date
82   ,p_start_date                    in     date     default null
83   ,p_approval_status               in     varchar2 default null
84   ,p_owner_type                    in     varchar2 default g_user
85   ,p_retro_assignment_id              out nocopy   number
86   );
87 
88 --
89 -- ----------------------------------------------------------------------------
90 -- |---------------------------< update_retro_asg >---------------------------|
91 -- ----------------------------------------------------------------------------
92 -- {Start Of Comments}
93 --
94 -- Description:
95 -- This procedure updates a retro assignment.
96 --
97 -- Prerequisites:
98 --   None.
99 --
100 -- In Parameters:
101 --   Name                           Reqd Type     Description
102 --   p_retro_assignment_id          Yes  Number   Retro Assignment ID.
103 --   p_reprocess_date               No   Date     Reprocess Date.
104 --   p_start_date                   No   Date     Start Date.
105 --   p_approval_status              No   Varchar2 Approval Status.
106 --   p_owner_type                   No   Varchar2 Owner type.
107 --
108 -- Post Success:
109 --   The procedure will set the following out parameters:
110 --   Name                           Type     Description
111 --
112 -- Post Failure:
113 --   The procedure will not update a retro assignment and raises an error.
114 --
115 -- Access Status:
116 --   Internal Development Use Only.
117 --
118 -- {End Of Comments}
119 --
120 procedure update_retro_asg
121   (p_retro_assignment_id           in     number
122   ,p_reprocess_date                in     date     default hr_api.g_date
123   ,p_start_date                    in     date     default hr_api.g_date
124   ,p_approval_status               in     varchar2 default hr_api.g_varchar2
125   ,p_owner_type                    in     varchar2 default g_user
126   );
127 
128 --
129 -- ----------------------------------------------------------------------------
130 -- |---------------------------< delete_retro_asg >---------------------------|
131 -- ----------------------------------------------------------------------------
132 -- {Start Of Comments}
133 --
134 -- Description:
135 -- This procedure deletes a retro assignment. If the retro assignment is
136 -- superseding another retro assignment, this procedure will reverse it to
137 -- the previous version.
138 --
139 -- Prerequisites:
140 --   None.
141 --
142 -- In Parameters:
143 --   Name                           Reqd Type     Description
144 --   p_retro_assignment_id          Yes  Number   Retro Assignment ID.
145 --   p_owner_type                   No   Varchar2 Owner type.
146 --
147 -- Post Success:
148 --   The procedure will set the following out parameters:
149 --   Name                           Type     Description
150 --   p_replaced_retro_asg_id        Number   Retro assignment replaced by
151 --                                           the deleted retro assignment.
152 --
153 -- Post Failure:
154 --   The procedure will not delete a retro assignment and raises an error.
155 --
156 -- Access Status:
157 --   Internal Development Use Only.
158 --
159 -- {End Of Comments}
160 --
161 procedure delete_retro_asg
162   (p_retro_assignment_id           in     number
163   ,p_owner_type                    in     varchar2 default g_user
164   ,p_replaced_retro_asg_id            out nocopy   number
165   );
166 
167 --
168 -- ----------------------------------------------------------------------------
169 -- |-----------------------< delete_retro_asg_cascade >-----------------------|
170 -- ----------------------------------------------------------------------------
171 -- {Start Of Comments}
172 --
173 -- Description:
174 -- This procedure deletes a retro assignment. If the retro assignment is
175 -- superseding another retro assignment, all of the previous versions are
176 -- deleted as well.
177 --
178 -- Prerequisites:
179 --   None.
180 --
181 -- In Parameters:
182 --   Name                           Reqd Type     Description
183 --   p_retro_assignment_id          Yes  Number   Retro Assignment ID.
184 --   p_owner_type                   No   Varchar2 Owner type.
185 --
186 -- Post Success:
187 --   The procedure will set the following out parameters:
188 --   Name                           Type     Description
189 --
190 -- Post Failure:
191 --   The procedure will not delete a retro assignment and raises an error.
192 --
193 -- Access Status:
194 --   Internal Development Use Only.
195 --
196 -- {End Of Comments}
197 --
198 procedure delete_retro_asg_cascade
199   (p_retro_assignment_id           in     number
200   ,p_owner_type                    in     varchar2 default g_user
201   );
202 
203 --
204 -- ----------------------------------------------------------------------------
205 -- |-------------------------< maintain_retro_entry >-------------------------|
206 -- ----------------------------------------------------------------------------
207 -- {Start Of Comments}
208 --
209 -- Description:
210 -- This procedure creates or updates an retro entry for the specified retro
211 -- assignment.
212 --
213 --
214 -- Prerequisites:
215 --   None.
216 --
217 -- In Parameters:
218 --   Name                           Reqd Type     Description
219 --   p_retro_assignment_id          Yes  Number   Retro Assignment ID.
220 --   p_element_entry_id             Yes  Number   Element Entry ID.
221 --   p_reprocess_date               Yes  Date     Reprocess Date.
222 --   p_effective_date               No   Date     Effective Date.
223 --   p_retro_component_id           No   Number   Retro Component ID.
224 --   p_owner_type                   No   Varchar2 Owner type.
225 --   p_system_reprocess_date        No   Date     System reprocess date.
226 --   p_entry_param_name             No   Varchar2 Entry parameter name to
227 --                                                indicate which entry is
228 --                                                being processed.
229 --
230 -- Post Success:
231 --   The procedure will set the following out parameters:
232 --   Name                           Type     Description
233 --
234 -- Post Failure:
235 --   The procedure will not create or update a retro entry and raises an
236 --   error.
237 --
238 -- Access Status:
239 --   Internal Development Use Only.
240 --
241 -- {End Of Comments}
242 --
243 procedure maintain_retro_entry
244   (p_retro_assignment_id           in     number
245   ,p_element_entry_id              in     number
246   ,p_reprocess_date                in     date
247   ,p_effective_date                in     date     default null
248   ,p_retro_component_id            in     number   default null
249   ,p_owner_type                    in     varchar2 default g_user
250   ,p_system_reprocess_date         in     date     default hr_api.g_eot
251   ,p_entry_param_name              in     varchar2 default null
252   );
253 
254 --
255 -- ----------------------------------------------------------------------------
256 -- |--------------------------< delete_retro_entry >--------------------------|
257 -- ----------------------------------------------------------------------------
258 -- {Start Of Comments}
259 --
260 -- Description:
261 -- This procedure deletes a retro entry.
262 --
263 --
264 -- Prerequisites:
265 --   None.
266 --
267 -- In Parameters:
268 --   Name                           Reqd Type     Description
269 --   p_retro_assignment_id          Yes  Number   Retro Assignment ID.
270 --   p_element_entry_id             Yes  Number   Element Entry ID.
271 --   p_owner_type                   No   Varchar2 Owner type.
272 --
273 -- Post Success:
274 --   The procedure will set the following out parameters:
275 --   Name                           Type     Description
276 --
277 -- Post Failure:
278 --   The procedure will not delete a retro entry and raises an error.
279 --
280 -- Access Status:
281 --   Internal Development Use Only.
282 --
283 -- {End Of Comments}
284 --
285 procedure delete_retro_entry
286   (p_retro_assignment_id           in     number
287   ,p_element_entry_id              in     number
288   ,p_owner_type                    in     varchar2 default g_user
289   );
290 --
291 -- ----------------------------------------------------------------------------
292 -- |------------------------< update_reprocess_date >-------------------------|
293 -- ----------------------------------------------------------------------------
294 -- {Start Of Comments}
295 --
296 -- Description:
297 -- This procedure is used to update the reprocess date of the system created
298 -- retro assignments by creating new retro assignment with the new reprocess
299 -- date and superseding the system created retro assignment with the newly
300 -- created retro assignment.
301 --
302 -- Prerequisites:
303 --   Please make sure that this procedure is used where the user login
304 --   information is established so that the WHO columns are populated properly.
305 --   If this procedure is called from a standalone script, it is advisable to
306 --   make the following call once before calling this procedure.
307 --
308 --     fnd_global.apps_initialize
309 --       (user_id      => <User ID>
310 --       ,resp_id      => <Responsibility ID>
311 --       ,resp_appl_id => <Responsibility Application ID>
312 --       );
313 --
314 -- In Parameters:
315 --   Name                           Reqd Type     Description
316 --   p_assignment_id                Yes  Number   Assignment ID
317 --   p_reprocess_date               Yes  Date     Reprocess Date of the retro
318 --                                                assignment.
319 --                                                The date must be equal to or
320 --                                                earlier than the earliest
321 --                                                retro entry reprocess date.
322 --   p_owner_type                   No   Varchar2 Owner Type
323 --
324 -- Post Success:
325 --   The procedure will set the following out parameters:
326 --   Name                           Type     Description
327 --   p_new_retro_asg_id             Number   Newly created Retro Assignment ID
328 --
329 -- Post Failure:
330 --   The procedure will not create or update a retro assignment and raises an
331 --   error.
332 --
333 -- {End Of Comments}
334 procedure update_reprocess_date(
335 p_assignment_id in number
336 ,p_reprocess_date in date
337 ,p_owner_type in varchar2 default g_user
338 ,p_retro_asg_id out nocopy number);
339 --
340 end pay_retro_status_internal;