DBA Data[Home] [Help]

PACKAGE: APPS.HR_PERIODS_OF_SERVICE_API

Source


1 Package hr_periods_of_service_api as
2 /* $Header: pepdsapi.pkh 120.7 2007/04/19 06:04:29 pdkundu noship $ */
3 /*#
4  * This package contains Period of Service APIs.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Periods of Service
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< update_pds_details >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API updates period of service information for an employee.
17  *
18  * Typically, this API is used to update the flexfields associated with periods
19  * of service.
20  *
21  * <p><b>Licensing</b><br>
22  * This API is licensed for use with Human Resources.
23  *
24  * <p><b>Prerequisites</b><br>
25  * The employee must exist in the relevant business group on the effective
26  * date.
27  *
28  * <p><b>Post Success</b><br>
29  * The period of service record is updated successfully.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not update the period of service record and raises an error.
33  * @param p_validate If true, then validation alone will be performed and the
34  * database will remain unchanged. If false and all validation checks pass,
35  * then the database will be modified.
36  * @param p_effective_date Determines when the DateTrack operation comes into
37  * force.
38  * @param p_period_of_service_id Period of service that is being terminated.
39  * @param p_termination_accepted_person Person who accepted this termination.
40  * @param p_accepted_termination_date Date when the termination of employment
41  * was accepted
42  * @param p_object_version_number Pass in the current version number of the
43  * period of service to be updated. When the API completes if p_validate is
44  * false, will be set to the new version number of the updated period of
45  * service. If p_validate is true will be set to the same value which was
46  * passed in.
47  * @param p_comments Comment text.
48  * @param p_leaving_reason Termination Reason. Valid values are defined by the
49  * LEAV_REAS lookup type.
50  * @param p_notified_termination_date Date when the termination was notified.
51  * @param p_projected_termination_date Projected termination date.
52  * @param p_actual_termination_date Actual termination date.
53  * @param p_last_standard_process_date Last standard process date.
54  * @param p_final_process_date Final process date.
55  * @param p_attribute_category This context value determines which flexfield
56  * structure to use with the descriptive flexfield segments.
57  * @param p_attribute1 Descriptive flexfield segment.
58  * @param p_attribute2 Descriptive flexfield segment.
59  * @param p_attribute3 Descriptive flexfield segment.
60  * @param p_attribute4 Descriptive flexfield segment.
61  * @param p_attribute5 Descriptive flexfield segment.
62  * @param p_attribute6 Descriptive flexfield segment.
63  * @param p_attribute7 Descriptive flexfield segment.
64  * @param p_attribute8 Descriptive flexfield segment.
65  * @param p_attribute9 Descriptive flexfield segment.
66  * @param p_attribute10 Descriptive flexfield segment.
67  * @param p_attribute11 Descriptive flexfield segment.
68  * @param p_attribute12 Descriptive flexfield segment.
69  * @param p_attribute13 Descriptive flexfield segment.
70  * @param p_attribute14 Descriptive flexfield segment.
71  * @param p_attribute15 Descriptive flexfield segment.
72  * @param p_attribute16 Descriptive flexfield segment.
73  * @param p_attribute17 Descriptive flexfield segment.
74  * @param p_attribute18 Descriptive flexfield segment.
75  * @param p_attribute19 Descriptive flexfield segment.
76  * @param p_attribute20 Descriptive flexfield segment.
77  * @param p_pds_information_category This context value determines which
78  * flexfield structure to use with the developer descriptive flexfield
79  * segments.
80  * @param p_pds_information1 Developer Descriptive flexfield segment.
81  * @param p_pds_information2 Developer Descriptive flexfield segment.
82  * @param p_pds_information3 Developer Descriptive flexfield segment.
83  * @param p_pds_information4 Developer Descriptive flexfield segment.
84  * @param p_pds_information5 Developer Descriptive flexfield segment.
85  * @param p_pds_information6 Developer Descriptive flexfield segment.
86  * @param p_pds_information7 Developer Descriptive flexfield segment.
87  * @param p_pds_information8 Developer Descriptive flexfield segment.
88  * @param p_pds_information9 Developer Descriptive flexfield segment.
89  * @param p_pds_information10 Developer Descriptive flexfield segment.
90  * @param p_pds_information11 Developer Descriptive flexfield segment.
91  * @param p_pds_information12 Developer Descriptive flexfield segment.
92  * @param p_pds_information13 Developer Descriptive flexfield segment.
93  * @param p_pds_information14 Developer Descriptive flexfield segment.
94  * @param p_pds_information15 Developer Descriptive flexfield segment.
95  * @param p_pds_information16 Developer Descriptive flexfield segment.
96  * @param p_pds_information17 Developer Descriptive flexfield segment.
97  * @param p_pds_information18 Developer Descriptive flexfield segment.
98  * @param p_pds_information19 Developer Descriptive flexfield segment.
99  * @param p_pds_information20 Developer Descriptive flexfield segment.
100  * @param p_pds_information21 Developer Descriptive flexfield segment.
101  * @param p_pds_information22 Developer Descriptive flexfield segment.
102  * @param p_pds_information23 Developer Descriptive flexfield segment.
103  * @param p_pds_information24 Developer Descriptive flexfield segment.
104  * @param p_pds_information25 Developer Descriptive flexfield segment.
105  * @param p_pds_information26 Developer Descriptive flexfield segment.
106  * @param p_pds_information27 Developer Descriptive flexfield segment.
107  * @param p_pds_information28 Developer Descriptive flexfield segment.
108  * @param p_pds_information29 Developer Descriptive flexfield segment.
109  * @param p_pds_information30 Developer Descriptive flexfield segment.
110  * @param p_org_now_no_manager_warning Warning flag to indicate the
111  * organization not having a manager scenario.
112  * @param p_asg_future_changes_warning Warning flag to indicate that
113  * futrure changes exist.
114  * @param p_entries_changed_warning Warning flag to indicate that
115  * entries have changed as a result of the action.
116  * @rep:displayname Update Period of Service
117  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
118  * @rep:category MISC_EXTENSIONS HR_DATAPUMP
119  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
120  * @rep:scope public
121  * @rep:lifecycle active
122  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
123 */
124 --
125 -- {End Of Comments}
126 --
127 procedure update_pds_details
128   (p_validate                      in     boolean  default false
129   ,p_effective_date                in     date
130   ,p_period_of_service_id          in     number
131   ,p_termination_accepted_person   in     number   default hr_api.g_number
132   ,p_accepted_termination_date     in     date     default hr_api.g_date
133   ,p_object_version_number         in out nocopy number
134   ,p_comments                      in     varchar2 default hr_api.g_varchar2
135   ,p_leaving_reason                in     varchar2 default hr_api.g_varchar2
136   ,p_notified_termination_date     in     date     default hr_api.g_date
137   ,p_projected_termination_date    in     date     default hr_api.g_date
138   ,p_actual_termination_date       in     date     default hr_api.g_date
139   ,p_last_standard_process_date    in     date     default hr_api.g_date
140   ,p_final_process_date            in     date     default hr_api.g_date
141   ,p_attribute_category            in varchar2     default hr_api.g_varchar2
142   ,p_attribute1                    in varchar2     default hr_api.g_varchar2
143   ,p_attribute2                    in varchar2     default hr_api.g_varchar2
144   ,p_attribute3                    in varchar2     default hr_api.g_varchar2
145   ,p_attribute4                    in varchar2     default hr_api.g_varchar2
146   ,p_attribute5                    in varchar2     default hr_api.g_varchar2
147   ,p_attribute6                    in varchar2     default hr_api.g_varchar2
148   ,p_attribute7                    in varchar2     default hr_api.g_varchar2
149   ,p_attribute8                    in varchar2     default hr_api.g_varchar2
150   ,p_attribute9                    in varchar2     default hr_api.g_varchar2
151   ,p_attribute10                   in varchar2     default hr_api.g_varchar2
152   ,p_attribute11                   in varchar2     default hr_api.g_varchar2
153   ,p_attribute12                   in varchar2     default hr_api.g_varchar2
154   ,p_attribute13                   in varchar2     default hr_api.g_varchar2
155   ,p_attribute14                   in varchar2     default hr_api.g_varchar2
156   ,p_attribute15                   in varchar2     default hr_api.g_varchar2
157   ,p_attribute16                   in varchar2     default hr_api.g_varchar2
158   ,p_attribute17                   in varchar2     default hr_api.g_varchar2
159   ,p_attribute18                   in varchar2     default hr_api.g_varchar2
160   ,p_attribute19                   in varchar2     default hr_api.g_varchar2
161   ,p_attribute20                   in varchar2     default hr_api.g_varchar2
162   ,p_pds_information_category      in varchar2     default hr_api.g_varchar2
163   ,p_pds_information1              in varchar2     default hr_api.g_varchar2
164   ,p_pds_information2              in varchar2     default hr_api.g_varchar2
165   ,p_pds_information3              in varchar2     default hr_api.g_varchar2
166   ,p_pds_information4              in varchar2     default hr_api.g_varchar2
167   ,p_pds_information5              in varchar2     default hr_api.g_varchar2
168   ,p_pds_information6              in varchar2     default hr_api.g_varchar2
169   ,p_pds_information7              in varchar2     default hr_api.g_varchar2
170   ,p_pds_information8              in varchar2     default hr_api.g_varchar2
171   ,p_pds_information9              in varchar2     default hr_api.g_varchar2
172   ,p_pds_information10             in varchar2     default hr_api.g_varchar2
173   ,p_pds_information11             in varchar2     default hr_api.g_varchar2
174   ,p_pds_information12             in varchar2     default hr_api.g_varchar2
175   ,p_pds_information13             in varchar2     default hr_api.g_varchar2
176   ,p_pds_information14             in varchar2     default hr_api.g_varchar2
177   ,p_pds_information15             in varchar2     default hr_api.g_varchar2
178   ,p_pds_information16             in varchar2     default hr_api.g_varchar2
179   ,p_pds_information17             in varchar2     default hr_api.g_varchar2
180   ,p_pds_information18             in varchar2     default hr_api.g_varchar2
181   ,p_pds_information19             in varchar2     default hr_api.g_varchar2
182   ,p_pds_information20             in varchar2     default hr_api.g_varchar2
183   ,p_pds_information21             in varchar2     default hr_api.g_varchar2
184   ,p_pds_information22             in varchar2     default hr_api.g_varchar2
185   ,p_pds_information23             in varchar2     default hr_api.g_varchar2
186   ,p_pds_information24             in varchar2     default hr_api.g_varchar2
187   ,p_pds_information25             in varchar2     default hr_api.g_varchar2
188   ,p_pds_information26             in varchar2     default hr_api.g_varchar2
189   ,p_pds_information27             in varchar2     default hr_api.g_varchar2
190   ,p_pds_information28             in varchar2     default hr_api.g_varchar2
191   ,p_pds_information29             in varchar2     default hr_api.g_varchar2
192   ,p_pds_information30             in varchar2     default hr_api.g_varchar2
193 --
194 -- 115.9 (START)
195 --
196   ,p_org_now_no_manager_warning    OUT NOCOPY      BOOLEAN
197   ,p_asg_future_changes_warning    OUT NOCOPY      BOOLEAN
198   ,p_entries_changed_warning       OUT NOCOPY      VARCHAR2
199 --
200 -- 115.9 (END)
201 --
202    );
203 --
204 -- ----------------------------------------------------------------------------
205 -- |---------------------< update_pds_details (overloaded) >------------------|
206 -- ----------------------------------------------------------------------------
207 --
208 -- {Start Of Comments}
209 --
210 -- Description:   This procedure has been overloaded. Please use the new
211 --                version for all future work.
212 --
213 -- {End Of Comments}
214 --
215 procedure update_pds_details
216   (p_validate                      in     boolean  default false
217   ,p_effective_date                in     date
218   ,p_period_of_service_id          in     number
219   ,p_termination_accepted_person   in     number   default hr_api.g_number
220   ,p_accepted_termination_date     in     date     default hr_api.g_date
221   ,p_object_version_number         in out nocopy number
222   ,p_comments                      in     varchar2 default hr_api.g_varchar2
223   ,p_leaving_reason                in     varchar2 default hr_api.g_varchar2
224   ,p_notified_termination_date     in     date     default hr_api.g_date
225   ,p_projected_termination_date    in     date     default hr_api.g_date
226   ,p_actual_termination_date       in     date     default hr_api.g_date
227   ,p_last_standard_process_date    in     date     default hr_api.g_date
228   ,p_final_process_date            in     date     default hr_api.g_date
229   ,p_attribute_category            in varchar2     default hr_api.g_varchar2
230   ,p_attribute1                    in varchar2     default hr_api.g_varchar2
231   ,p_attribute2                    in varchar2     default hr_api.g_varchar2
232   ,p_attribute3                    in varchar2     default hr_api.g_varchar2
233   ,p_attribute4                    in varchar2     default hr_api.g_varchar2
234   ,p_attribute5                    in varchar2     default hr_api.g_varchar2
235   ,p_attribute6                    in varchar2     default hr_api.g_varchar2
236   ,p_attribute7                    in varchar2     default hr_api.g_varchar2
237   ,p_attribute8                    in varchar2     default hr_api.g_varchar2
238   ,p_attribute9                    in varchar2     default hr_api.g_varchar2
239   ,p_attribute10                   in varchar2     default hr_api.g_varchar2
240   ,p_attribute11                   in varchar2     default hr_api.g_varchar2
241   ,p_attribute12                   in varchar2     default hr_api.g_varchar2
242   ,p_attribute13                   in varchar2     default hr_api.g_varchar2
243   ,p_attribute14                   in varchar2     default hr_api.g_varchar2
244   ,p_attribute15                   in varchar2     default hr_api.g_varchar2
245   ,p_attribute16                   in varchar2     default hr_api.g_varchar2
246   ,p_attribute17                   in varchar2     default hr_api.g_varchar2
247   ,p_attribute18                   in varchar2     default hr_api.g_varchar2
248   ,p_attribute19                   in varchar2     default hr_api.g_varchar2
249   ,p_attribute20                   in varchar2     default hr_api.g_varchar2
250   ,p_pds_information_category      in varchar2     default hr_api.g_varchar2
251   ,p_pds_information1              in varchar2     default hr_api.g_varchar2
252   ,p_pds_information2              in varchar2     default hr_api.g_varchar2
253   ,p_pds_information3              in varchar2     default hr_api.g_varchar2
254   ,p_pds_information4              in varchar2     default hr_api.g_varchar2
255   ,p_pds_information5              in varchar2     default hr_api.g_varchar2
256   ,p_pds_information6              in varchar2     default hr_api.g_varchar2
257   ,p_pds_information7              in varchar2     default hr_api.g_varchar2
258   ,p_pds_information8              in varchar2     default hr_api.g_varchar2
259   ,p_pds_information9              in varchar2     default hr_api.g_varchar2
260   ,p_pds_information10             in varchar2     default hr_api.g_varchar2
261   ,p_pds_information11             in varchar2     default hr_api.g_varchar2
262   ,p_pds_information12             in varchar2     default hr_api.g_varchar2
263   ,p_pds_information13             in varchar2     default hr_api.g_varchar2
264   ,p_pds_information14             in varchar2     default hr_api.g_varchar2
265   ,p_pds_information15             in varchar2     default hr_api.g_varchar2
266   ,p_pds_information16             in varchar2     default hr_api.g_varchar2
267   ,p_pds_information17             in varchar2     default hr_api.g_varchar2
268   ,p_pds_information18             in varchar2     default hr_api.g_varchar2
269   ,p_pds_information19             in varchar2     default hr_api.g_varchar2
270   ,p_pds_information20             in varchar2     default hr_api.g_varchar2
271   ,p_pds_information21             in varchar2     default hr_api.g_varchar2
272   ,p_pds_information22             in varchar2     default hr_api.g_varchar2
273   ,p_pds_information23             in varchar2     default hr_api.g_varchar2
274   ,p_pds_information24             in varchar2     default hr_api.g_varchar2
275   ,p_pds_information25             in varchar2     default hr_api.g_varchar2
276   ,p_pds_information26             in varchar2     default hr_api.g_varchar2
277   ,p_pds_information27             in varchar2     default hr_api.g_varchar2
278   ,p_pds_information28             in varchar2     default hr_api.g_varchar2
279   ,p_pds_information29             in varchar2     default hr_api.g_varchar2
280   ,p_pds_information30             in varchar2     default hr_api.g_varchar2
281    );
282 --
283 -- 115.7 (START)
284 --
285 -- ----------------------------------------------------------------------------
286 -- |--------------------------< MOVE_TERM_ASSIGNMENTS >-----------------------|
287 -- ----------------------------------------------------------------------------
288 -- {Start Of Comments}
289 --
290 -- Description:   This procedure keeps assignment children and the TERM_ASSIGN
291 --                record in sync with any allowable change in FPD. It also
292 --                validates that the change does not adversely impact any of
293 --                the child records.
294 --
295 -- Prerequisites: None
296 --
297 --
298 -- In Parameters:
299 --   Name                       Reqd Type     Description
300 --   P_PERIOD_OF_SERVICE_ID     Yes  NUMBER   PDS Identifier
301 --   P_OLD_FINAL_PROCESS_DATE   Yes  DATE     Old FPD
302 --   P_NEW_FINAL_PROCESS_DATE   Yes  DATE     New FPD
303 --
304 -- Out Parameters:
305 --   Name                          Type     Description
306 --   P_ORG_NOW_NO_MANAGER_WARNING  BOOLEAN  Org now no manager flag
307 --   P_ASG_FUTURE_CHANGES_WARNING  BOOLEAN  Future Assignment changes flag
308 --   P_ENTRIES_CHANGED_WARNING     VARCHAR2 Element entries changed flag
309 --
310 -- Post Success:
311 --   The TERM_ASSIGN assignment record and its children will be in sync with
312 --   the Final Process Date on the Period Of Service associated with that
313 --   assignment.
314 --
315 --   Name                           Type     Description
316 --   -                              -        -
317 -- Post Failure:
318 --   An exception will be raised depending on the nature of failure.
319 --
320 -- Access Status:
321 --   Internal Development Use Only.
322 --
323 -- {End Of Comments}
324 --
325 procedure move_term_assignments
326   (p_period_of_service_id   in number
327   ,p_old_final_process_date in date
328   ,p_new_final_process_date in date
329 --
330 -- 115.9 (START)
331 --
332   ,p_org_now_no_manager_warning OUT NOCOPY BOOLEAN
333   ,p_asg_future_changes_warning OUT NOCOPY BOOLEAN
334   ,p_entries_changed_warning    OUT NOCOPY VARCHAR2
335 --
336 -- 115.9 (END)
337 --
338   );
339 --
340 -- 115.7 (END)
341 --
342 end hr_periods_of_service_api;