DBA Data[Home] [Help]

PACKAGE: APPS.HR_FR_CONTRACT_API

Source


1 Package hr_fr_contract_api as
2 /* $Header: hrctcfri.pkh 120.3 2006/07/06 06:23:27 nmuthusa noship $ */
3 /*#
4  * This package contains contract APIs for France.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Employment Contract for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_fr_contract >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new contract for the person record for France.
17  *
18  * This API is an alternative API to the create_contract generic API. See
19  * create_contract API for further details.
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  * Person record must exist in the same Business Group as that of the contract
26  * being created. Lookup values have been created for user extensible lookup
27  * types of CONTRACT_STATUS and CONTRACT_TYPE.
28  *
29  * <p><b>Post Success</b><br>
30  * The contract is successfully created for the person record in France.
31  *
32  * <p><b>Post Failure</b><br>
33  * The API does not create the contract and raises an error.
34  * @param p_validate If true, then validation alone will be performed and the
35  * database will remain unchanged. If false and all validation checks pass,
36  * then the database will be modified.
37  * @param p_contract_id If p_validate is false then this uniquely identifies
38  * the contract created. If p_validate is true, then the the value will be
39  * null.
40  * @param p_effective_start_date If p_validate is false, then set to the
41  * earliest effective start date for the created contract. If p_validate is
42  * true, then set to null.
43  * @param p_effective_end_date If p_validate is false, then set to the
44  * effective end date for the created contract. If p_validate is true, then set
45  * to null.
46  * @param p_object_version_number If p_validate is false, then set to the
47  * version number of the created contract. If p_validate is true, then set to
48  * null.
49  * @param p_person_id Identifies the person for whom you create the contract
50  * record.
51  * @param p_reference Reference code for the contract
52  * @param p_type The type of the contract. Valid values are defined by the
53  * CONTRACT_TYPE lookup type.
54  * @param p_status The status of the contract. Valid values are defined by the
55  * CONTRACT_STATUS lookup type.
56  * @param p_status_reason The reason why the contract has its current status.
57  * Valid values are defined by the CONTRACT_STATUS_REASON lookup type.
58  * @param p_doc_status The status of the physical document associated with the
59  * contract. Valid values are defined by the DOCUMENT_STATUS lookup type.
60  * @param p_doc_status_change_date Date the document status changed.
61  * @param p_description Contract description
62  * @param p_duration The length of time during which the contract is active.
63  * @param p_duration_units Units for contract duration, e.g., Weeks, Months,
64  * Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
65  * @param p_contractual_job_title Contractual job title
66  * @param p_parties Parties to the contract
67  * @param p_start_reason Reason for starting the contract. Valid values are
68  * defined by the CONTRACT_START_REASON lookup type.
69  * @param p_end_reason Reason for ending the contract. Valid values are defined
70  * by the CONTRACT_END_REASON lookup type.
71  * @param p_number_of_extensions How many times the contract has been extended.
72  * @param p_extension_reason Reason for extending the contract
73  * @param p_extension_period How long the contract has been extended.
74  * @param p_extension_period_units Units for extension period, e.g., Weeks,
75  * Months, Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
76  * @param p_employee_type Employee type. Valid values exist in the
77  * 'FR_LEVEL_OF_WORKER' lookup type.
78  * @param p_contract_category Contract Category. Valid values exist in the
79  * 'FR_CONTRACT_CATEGORY' lookup type.
80  * @param p_proposed_end_date Proposed end date
81  * @param p_end_event End Event
82  * @param p_person_replaced Person replaced
83  * @param p_probation_period Probation period
84  * @param p_probation_period_units Probation period units. Valid values exist
85  * in the 'QUALIFYING_UNITS' lookup type.
86  * @param p_probation_end_date Probation end date
87  * @param p_smic_adjusted_duration_days SMIC adjusted duration days
88  * @param p_fixed_working_time Fixed working time indicator. Valid values exist
89  * in the 'YES_NO' lookup type.
90  * @param p_amount The length of fixed working time.
91  * @param p_units Units for fixed working time, e.g., Hours,Days. Valid values
92  * exist in the 'FR_FIXED_TIME_UNITS' lookup type.
93  * @param p_frequency Frequency for fixed working time, e.g., Weeks,Months,Years.
94  * Valid values exist in the 'FR_FIXED_TIME_FREQUENCY' lookup type.
95  * @param p_attribute_category This context value determines which flexfield
96  * structure to use with the descriptive flexfield segments.
97  * @param p_attribute1 Descriptive flexfield segment.
98  * @param p_attribute2 Descriptive flexfield segment.
99  * @param p_attribute3 Descriptive flexfield segment.
100  * @param p_attribute4 Descriptive flexfield segment.
101  * @param p_attribute5 Descriptive flexfield segment.
102  * @param p_attribute6 Descriptive flexfield segment.
103  * @param p_attribute7 Descriptive flexfield segment.
104  * @param p_attribute8 Descriptive flexfield segment.
105  * @param p_attribute9 Descriptive flexfield segment.
106  * @param p_attribute10 Descriptive flexfield segment.
107  * @param p_attribute11 Descriptive flexfield segment.
108  * @param p_attribute12 Descriptive flexfield segment.
109  * @param p_attribute13 Descriptive flexfield segment.
110  * @param p_attribute14 Descriptive flexfield segment.
111  * @param p_attribute15 Descriptive flexfield segment.
112  * @param p_attribute16 Descriptive flexfield segment.
113  * @param p_attribute17 Descriptive flexfield segment.
114  * @param p_attribute18 Descriptive flexfield segment.
115  * @param p_attribute19 Descriptive flexfield segment.
116  * @param p_attribute20 Descriptive flexfield segment.
117  * @param p_effective_date Determines when the DateTrack operation comes into
118  * force.
119  * @rep:displayname Create Employment Contract for France
120  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
121  * @rep:scope public
122  * @rep:lifecycle active
123  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
124 */
125 --
126 -- {End Of Comments}
127 --
128 procedure create_fr_contract
129   (p_validate                       in  boolean   default false
130   ,p_contract_id                    out nocopy number
131   ,p_effective_start_date           out nocopy date
132   ,p_effective_end_date             out nocopy date
133   ,p_object_version_number          out nocopy number
134   ,p_person_id                      in  number
135   ,p_reference                      in  varchar2
136   ,p_type                           in  varchar2
137   ,p_status                         in  varchar2
138   ,p_status_reason                  in  varchar2  default null
139   ,p_doc_status                     in  varchar2  default null
140   ,p_doc_status_change_date         in  date      default null
141   ,p_description                    in  varchar2  default null
142   ,p_duration                       in  number    default null
143   ,p_duration_units                 in  varchar2  default null
144   ,p_contractual_job_title          in  varchar2  default null
145   ,p_parties                        in  varchar2  default null
146   ,p_start_reason                   in  varchar2  default null
147   ,p_end_reason                     in  varchar2  default null
148   ,p_number_of_extensions           in  number    default null
149   ,p_extension_reason               in  varchar2  default null
150   ,p_extension_period               in  number    default null
151   ,p_extension_period_units         in  varchar2  default null
152   ,p_employee_type	            in  varchar2  default null
153   ,p_contract_category              in  varchar2  default null
154   ,p_proposed_end_date              in  varchar2  default null
155   ,p_end_event		            in  varchar2  default null
156   ,p_person_replaced                in  varchar2  default null
157   ,p_probation_period               in  varchar2  default null
158   ,p_probation_period_units         in  varchar2  default null
159   ,p_probation_end_date             in  varchar2  default null
160   ,p_smic_adjusted_duration_days    in  number    default null
161   ,p_fixed_working_time		    in  varchar2  default null
162   ,p_amount			    in	number    default null
163   ,p_units			    in  varchar2  default null
164   ,p_frequency			    in  varchar2  default null
165   ,p_attribute_category             in  varchar2  default null
166   ,p_attribute1                     in  varchar2  default null
167   ,p_attribute2                     in  varchar2  default null
168   ,p_attribute3                     in  varchar2  default null
169   ,p_attribute4                     in  varchar2  default null
170   ,p_attribute5                     in  varchar2  default null
171   ,p_attribute6                     in  varchar2  default null
172   ,p_attribute7                     in  varchar2  default null
173   ,p_attribute8                     in  varchar2  default null
174   ,p_attribute9                     in  varchar2  default null
175   ,p_attribute10                    in  varchar2  default null
176   ,p_attribute11                    in  varchar2  default null
177   ,p_attribute12                    in  varchar2  default null
178   ,p_attribute13                    in  varchar2  default null
179   ,p_attribute14                    in  varchar2  default null
180   ,p_attribute15                    in  varchar2  default null
181   ,p_attribute16                    in  varchar2  default null
182   ,p_attribute17                    in  varchar2  default null
183   ,p_attribute18                    in  varchar2  default null
184   ,p_attribute19                    in  varchar2  default null
185   ,p_attribute20                    in  varchar2  default null
186   ,p_effective_date                 in  date
187   );
188 --
189 -- ----------------------------------------------------------------------------
190 -- |----------------------------< update_fr_contract >------------------------|
191 -- ----------------------------------------------------------------------------
192 --
193 -- {Start Of Comments}
194 /*#
195  * This API updates a contract for a person in a business group for France.
196  *
197  * This API calls the generic API update_contract. See update_contract for
198  * further details.
199  *
200  * <p><b>Licensing</b><br>
201  * This API is licensed for use with Human Resources.
202  *
203  * <p><b>Prerequisites</b><br>
204  * Contract must exist.
205  *
206  * <p><b>Post Success</b><br>
207  * The contract is successfully updated for the person.
208  *
209  * <p><b>Post Failure</b><br>
210  * The API does not update the contract and raises an error.
211  * @param p_validate If true, then validation alone will be performed and the
212  * database will remain unchanged. If false and all validation checks pass,
213  * then the database will be modified.
214  * @param p_contract_id Identifies the contract record to be modified.
215  * @param p_effective_start_date If p_validate is false, then set to the
216  * effective start date in the updated contract row as of the effective date.
217  * If p_validate is true, then set to null.
218  * @param p_effective_end_date If p_validate is false, then set to the
219  * effective end date in the updated contract row as of the effective date. If
220  * p_validate is true, then set to null.
221  * @param p_object_version_number Passes the current version number of the
222  * contract to be updated. If p_validate is false on completion, set to the new
223  * version number of the updated contract. If p_validate is true set to the
224  * input value.
225  * @param p_person_id Identifies the employee for whom the contract was created
226  * @param p_reference Reference code for the contract
227  * @param p_type The type of the contract. Valid values are defined by the
228  * CONTRACT_TYPE lookup type.
229  * @param p_status The status of the contract. Valid values are defined by the
230  * CONTRACT_STATUS lookup type.
231  * @param p_status_reason The reason why the contract has its current status.
232  * Valid values are defined by the CONTRACT_STATUS_REASON lookup type.
233  * @param p_doc_status The status of the physical document associated with the
234  * contract. Valid values are defined by the DOCUMENT_STATUS lookup type.
235  * @param p_doc_status_change_date Date the document status changed.
236  * @param p_description Contract description
237  * @param p_duration The length of time during which the contract is active.
238  * @param p_duration_units Units for contract duration, e.g., Weeks, Months,
239  * Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
240  * @param p_contractual_job_title Contractual job title
241  * @param p_parties Parties to the contract
242  * @param p_start_reason Reason for starting the contract. Valid values are
243  * defined by the CONTRACT_START_REASON lookup type.
244  * @param p_end_reason Reason for ending the contract. Valid values are defined
245  * by the CONTRACT_END_REASON lookup type.
246  * @param p_number_of_extensions How many times the contract has been extended.
247  * @param p_extension_reason Reason for extending the contract
248  * @param p_extension_period How long the contract has been extended.
249  * @param p_extension_period_units Units for extension period, e.g., Weeks,
250  * Months, Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
251  * @param p_employee_type Employee type. Valid values exist in the
252  * 'FR_LEVEL_OF_WORKER' lookup type.
253  * @param p_contract_category Contract category. Valid values exist in the
254  * 'FR_CONTRACT_CATEGORY' lookup type.
255  * @param p_proposed_end_date Proposed end date
256  * @param p_end_event End Event
257  * @param p_person_replaced Person replaced
258  * @param p_probation_period Probation period
259  * @param p_probation_period_units Probation period units. Valid values exist
260  * in the 'QUALIFYING_UNITS' lookup type.
261  * @param p_probation_end_date Probation end date
262  * @param p_smic_adjusted_duration_days SMIC adjusted duration days
263  * @param p_fixed_working_time Fixed working time indicator. Valid values exist
264  * in the 'YES_NO' lookup type.
265  * @param p_amount The length of fixed working time.
266  * @param p_units Units for fixed working time, e.g., Hours,Days. Valid values
267  * exist in the 'FR_FIXED_TIME_UNITS' lookup type.
268  * @param p_frequency Frequency for fixed working time, e.g., Weeks,Months,Years.
269  * Valid values exist in the 'FR_FIXED_TIME_FREQUENCY' lookup type.
270  * @param p_attribute_category This context value determines which flexfield
271  * structure to use with the descriptive flexfield segments.
272  * @param p_attribute1 Descriptive flexfield segment.
273  * @param p_attribute2 Descriptive flexfield segment.
274  * @param p_attribute3 Descriptive flexfield segment.
275  * @param p_attribute4 Descriptive flexfield segment.
276  * @param p_attribute5 Descriptive flexfield segment.
277  * @param p_attribute6 Descriptive flexfield segment.
278  * @param p_attribute7 Descriptive flexfield segment.
279  * @param p_attribute8 Descriptive flexfield segment.
280  * @param p_attribute9 Descriptive flexfield segment.
281  * @param p_attribute10 Descriptive flexfield segment.
282  * @param p_attribute11 Descriptive flexfield segment.
283  * @param p_attribute12 Descriptive flexfield segment.
284  * @param p_attribute13 Descriptive flexfield segment.
285  * @param p_attribute14 Descriptive flexfield segment.
286  * @param p_attribute15 Descriptive flexfield segment.
287  * @param p_attribute16 Descriptive flexfield segment.
288  * @param p_attribute17 Descriptive flexfield segment.
289  * @param p_attribute18 Descriptive flexfield segment.
290  * @param p_attribute19 Descriptive flexfield segment.
291  * @param p_attribute20 Descriptive flexfield segment.
292  * @param p_effective_date Determines when the DateTrack operation comes into
293  * force.
294  * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
295  * the record. You must set to UPDATE, CORRECTION, UPDATE_OVERRIDE or
296  * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
297  * depend on the dates of previous record changes and the effective date of
298  * this change.
299  * @rep:displayname Update Employment Contract for France
300  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
301  * @rep:scope public
302  * @rep:lifecycle active
303  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
304 */
305 --
306 -- {End Of Comments}
307 --
308 procedure update_fr_contract
309   (p_validate                       in  boolean   default false
310   ,p_contract_id                    in  number
311   ,p_effective_start_date           out nocopy date
312   ,p_effective_end_date             out nocopy date
313   ,p_object_version_number          in out nocopy number
314   ,p_person_id                      in  number
315   ,p_reference                      in  varchar2
316   ,p_type                           in  varchar2
317   ,p_status                         in  varchar2
318   ,p_status_reason                  in  varchar2  default hr_api.g_varchar2
319   ,p_doc_status                     in  varchar2  default hr_api.g_varchar2
320   ,p_doc_status_change_date         in  date      default hr_api.g_date
321   ,p_description                    in  varchar2  default hr_api.g_varchar2
322   ,p_duration                       in  number    default hr_api.g_number
323   ,p_duration_units                 in  varchar2  default hr_api.g_varchar2
324   ,p_contractual_job_title          in  varchar2  default hr_api.g_varchar2
325   ,p_parties                        in  varchar2  default hr_api.g_varchar2
326   ,p_start_reason                   in  varchar2  default hr_api.g_varchar2
327   ,p_end_reason                     in  varchar2  default hr_api.g_varchar2
328   ,p_number_of_extensions           in  number    default hr_api.g_number
329   ,p_extension_reason               in  varchar2  default hr_api.g_varchar2
330   ,p_extension_period               in  number    default hr_api.g_number
331   ,p_extension_period_units         in  varchar2  default hr_api.g_varchar2
332   ,p_employee_type	            in  varchar2  default hr_api.g_varchar2
333   ,p_contract_category              in  varchar2  default hr_api.g_varchar2
334   ,p_proposed_end_date              in  varchar2  default hr_api.g_varchar2
335   ,p_end_event		            in  varchar2  default hr_api.g_varchar2
336   ,p_person_replaced                in  varchar2  default hr_api.g_varchar2
337   ,p_probation_period               in  varchar2  default hr_api.g_varchar2
338   ,p_probation_period_units         in  varchar2  default hr_api.g_varchar2
339   ,p_probation_end_date             in  varchar2  default hr_api.g_varchar2
340   ,p_smic_adjusted_duration_days    in  number    default hr_api.g_number
341   ,p_fixed_working_time		    in  varchar2  default hr_api.g_varchar2
342   ,p_amount			    in	number    default hr_api.g_number
343   ,p_units			    in  varchar2  default hr_api.g_varchar2
344   ,p_frequency			    in  varchar2  default hr_api.g_varchar2
345   ,p_attribute_category             in  varchar2  default hr_api.g_varchar2
346   ,p_attribute1                     in  varchar2  default hr_api.g_varchar2
347   ,p_attribute2                     in  varchar2  default hr_api.g_varchar2
348   ,p_attribute3                     in  varchar2  default hr_api.g_varchar2
349   ,p_attribute4                     in  varchar2  default hr_api.g_varchar2
350   ,p_attribute5                     in  varchar2  default hr_api.g_varchar2
351   ,p_attribute6                     in  varchar2  default hr_api.g_varchar2
352   ,p_attribute7                     in  varchar2  default hr_api.g_varchar2
353   ,p_attribute8                     in  varchar2  default hr_api.g_varchar2
354   ,p_attribute9                     in  varchar2  default hr_api.g_varchar2
355   ,p_attribute10                    in  varchar2  default hr_api.g_varchar2
356   ,p_attribute11                    in  varchar2  default hr_api.g_varchar2
357   ,p_attribute12                    in  varchar2  default hr_api.g_varchar2
358   ,p_attribute13                    in  varchar2  default hr_api.g_varchar2
359   ,p_attribute14                    in  varchar2  default hr_api.g_varchar2
360   ,p_attribute15                    in  varchar2  default hr_api.g_varchar2
361   ,p_attribute16                    in  varchar2  default hr_api.g_varchar2
362   ,p_attribute17                    in  varchar2  default hr_api.g_varchar2
363   ,p_attribute18                    in  varchar2  default hr_api.g_varchar2
364   ,p_attribute19                    in  varchar2  default hr_api.g_varchar2
365   ,p_attribute20                    in  varchar2  default hr_api.g_varchar2
366   ,p_effective_date                 in  date
367   ,p_datetrack_mode                 in  varchar2
368   );
369 --
370 end hr_fr_contract_api;