DBA Data[Home] [Help]

PACKAGE: APPS.HR_KW_CONTRACT_API

Source


1 package hr_kw_contract_api as
2 /* $Header: pectckwi.pkh 120.1 2005/10/02 02:39:53 aroussel $ */
3 /*#
4  * This package contains contract APIs for Kuwait.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Contract for Kuwait
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_kw_contract >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new Kuwaiti contract.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with Human Resources.
21  *
22  * <p><b>Prerequisites</b><br>
23  * The person record must exist in the same business group as that of the
24  * contract being created.
25  *
26  * <p><b>Post Success</b><br>
27  * The API creates a new contract.
28  *
29  * <p><b>Post Failure</b><br>
30  * The API does not create the contract and raises an error.
31  *
32  * @param p_validate If true, then validation alone will be performed and the
33  * database will remain unchanged. If false and all validation checks pass,
34  * then the database will be modified.
35  * @param p_contract_id Identifies the contract record.
36  * @param p_effective_start_date If p_validate is false, then set to the
37  * earliest effective start date for the created contract. If p_validate is
38  * true, then set to null.
39  * @param p_effective_end_date If p_validate is false, then set to the
40  * effective end date for the created contract. If p_validate is true, then set
41  * to null.
42  * @param p_object_version_number If p_validate is false, then set to the
43  * version number of the created contract. If p_validate is true, then the
44  * value will be null.
45  * @param p_person_id If p_validate is false, then this uniquely identifies the
46  * person created. If p_validate is true, then set to null.
47  * @param p_reference Reference code for the contract.
48  * @param p_type Contract type.
49  * @param p_status Contract status.
50  * @param p_status_reason Contract status reason.
51  * @param p_doc_status Contract user status.
52  * @param p_doc_status_change_date Date the user status changed.
53  * @param p_description Contract description.
54  * @param p_duration Contract duration.
55  * @param p_duration_units Units for contract duration.
56  * @param p_contractual_job_title Contractual job title.
57  * @param p_parties Parties to the contract.
58  * @param p_start_reason Reason for starting the contract.
59  * @param p_end_reason Reason for ending the contract.
60  * @param p_number_of_extensions Number of contract extensions.
61  * @param p_extension_reason Reason for extending the contract.
62  * @param p_extension_period Extension period.
63  * @param p_extension_period_units Units for extension period.
64  * @param p_employment_status Employment status.
65  * @param p_expiry_date Expiry date.
66  * @param p_attribute_category This context value determines which flexfield
67  * structure to use with the descriptive flexfield segments.
68  * @param p_attribute1 Descriptive flexfield segment.
69  * @param p_attribute2 Descriptive flexfield segment.
70  * @param p_attribute3 Descriptive flexfield segment.
71  * @param p_attribute4 Descriptive flexfield segment.
72  * @param p_attribute5 Descriptive flexfield segment.
73  * @param p_attribute6 Descriptive flexfield segment.
74  * @param p_attribute7 Descriptive flexfield segment.
75  * @param p_attribute8 Descriptive flexfield segment.
76  * @param p_attribute9 Descriptive flexfield segment.
77  * @param p_attribute10 Descriptive flexfield segment.
78  * @param p_attribute11 Descriptive flexfield segment.
79  * @param p_attribute12 Descriptive flexfield segment.
80  * @param p_attribute13 Descriptive flexfield segment.
81  * @param p_attribute14 Descriptive flexfield segment.
82  * @param p_attribute15 Descriptive flexfield segment.
83  * @param p_attribute16 Descriptive flexfield segment.
84  * @param p_attribute17 Descriptive flexfield segment.
85  * @param p_attribute18 Descriptive flexfield segment.
86  * @param p_attribute19 Descriptive flexfield segment.
87  * @param p_attribute20 Descriptive flexfield segment.
88  * @param p_effective_date Determines when the DateTrack operation comes into
89  * force.
90  * @rep:displayname Create Contract for Kuwait
91  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
92  * @rep:lifecycle active
93  * @rep:scope public
94  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
95 */
96 --
97 -- {End Of Comments}
98 --
99 procedure create_kw_contract
100  (p_validate                        in boolean    default false
101   ,p_contract_id                    out nocopy number
102   ,p_effective_start_date           out nocopy date
103   ,p_effective_end_date             out nocopy date
104   ,p_object_version_number          out nocopy number
105   ,p_person_id                      in  number
106   ,p_reference                      in  varchar2
107   ,p_type                           in  varchar2
108   ,p_status                         in  varchar2
109   ,p_status_reason                  in  varchar2  default null
110   ,p_doc_status                     in  varchar2  default null
111   ,p_doc_status_change_date         in  date      default null
112   ,p_description                    in  varchar2  default null
113   ,p_duration                       in  number    default null
114   ,p_duration_units                 in  varchar2  default null
115   ,p_contractual_job_title          in  varchar2  default null
116   ,p_parties                        in  varchar2  default null
117   ,p_start_reason                   in  varchar2  default null
118   ,p_end_reason                     in  varchar2  default null
119   ,p_number_of_extensions           in  number    default null
120   ,p_extension_reason               in  varchar2  default null
121   ,p_extension_period               in  number    default null
122   ,p_extension_period_units         in  varchar2  default null
123   ,p_employment_status              in  varchar2  default null
124   ,p_expiry_date                    in  varchar2  default null
125   ,p_attribute_category             in  varchar2  default null
126   ,p_attribute1                     in  varchar2  default null
127   ,p_attribute2                     in  varchar2  default null
128   ,p_attribute3                     in  varchar2  default null
129   ,p_attribute4                     in  varchar2  default null
130   ,p_attribute5                     in  varchar2  default null
131   ,p_attribute6                     in  varchar2  default null
132   ,p_attribute7                     in  varchar2  default null
133   ,p_attribute8                     in  varchar2  default null
134   ,p_attribute9                     in  varchar2  default null
135   ,p_attribute10                    in  varchar2  default null
136   ,p_attribute11                    in  varchar2  default null
137   ,p_attribute12                    in  varchar2  default null
141   ,p_attribute16                    in  varchar2  default null
138   ,p_attribute13                    in  varchar2  default null
139   ,p_attribute14                    in  varchar2  default null
140   ,p_attribute15                    in  varchar2  default null
142   ,p_attribute17                    in  varchar2  default null
143   ,p_attribute18                    in  varchar2  default null
144   ,p_attribute19                    in  varchar2  default null
145   ,p_attribute20                    in  varchar2  default null
146   ,p_effective_date                 in  date
147  );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |----------------------------< update_kw_contract >------------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155  * This API updates an existing Kuwaiti contract.
156  *
157  *
158  * <p><b>Licensing</b><br>
159  * This API is licensed for use with Human Resources.
160  *
161  * <p><b>Prerequisites</b><br>
162  * The contract must exist.
163  *
164  * <p><b>Post Success</b><br>
165  * The API successfully updates the contract.
166  *
167  * <p><b>Post Failure</b><br>
168  * The API does not update the contract and raises an error.
169  *
170  * @param p_validate If true, then validation alone will be performed and the
171  * database will remain unchanged. If false and all validation checks pass,
172  * then the database will be modified.
173  * @param p_contract_id Identifies the contract record.
174  * @param p_effective_start_date If p_validate is false, then set to the
175  * effective start date on the updated contract row which now exists as of the
176  * effective date. If p_validate is true, then set to null.
177  * @param p_effective_end_date If p_validate is false, then set to the
178  * effective end date on the updated contract row which now exists as of the
179  * effective date. If p_validate is true, then set to null.
180  * @param p_object_version_number Pass in the current version number of the
181  * contract to be updated. When the API completes if p_validate is false, will
182  * be set to the new version number of the updated contract. If p_validate is
183  * true will be set to the same value which was passed in.
184  * @param p_person_id Identifies the person record to modify.
185  * @param p_reference Reference code for the contract.
186  * @param p_type Contract type.
187  * @param p_status Contract status.
188  * @param p_status_reason Contract status reason.
189  * @param p_doc_status Contract user reason.
190  * @param p_doc_status_change_date Date the user status changed.
191  * @param p_description Contract description.
192  * @param p_duration Contract duration.
193  * @param p_duration_units Units for contract duration.
194  * @param p_contractual_job_title Contractual job title.
195  * @param p_parties Parties to the contract.
196  * @param p_start_reason Reason for starting the contract.
197  * @param p_end_reason Reason for ending the contract.
198  * @param p_number_of_extensions Number of contract extensions.
199  * @param p_extension_reason Reason for extending the contract.
200  * @param p_extension_period Extension period.
201  * @param p_extension_period_units Units for extension period.
202  * @param p_employment_status Employment status.
203  * @param p_expiry_date Expiry date.
204  * @param p_attribute_category This context value determines which flexfield
205  * structure to use with the descriptive flexfield segments.
206  * @param p_attribute1 Descriptive flexfield segment.
207  * @param p_attribute2 Descriptive flexfield segment.
208  * @param p_attribute3 Descriptive flexfield segment.
209  * @param p_attribute4 Descriptive flexfield segment.
210  * @param p_attribute5 Descriptive flexfield segment.
211  * @param p_attribute6 Descriptive flexfield segment.
212  * @param p_attribute7 Descriptive flexfield segment.
213  * @param p_attribute8 Descriptive flexfield segment.
214  * @param p_attribute9 Descriptive flexfield segment.
215  * @param p_attribute10 Descriptive flexfield segment.
216  * @param p_attribute11 Descriptive flexfield segment.
217  * @param p_attribute12 Descriptive flexfield segment.
218  * @param p_attribute13 Descriptive flexfield segment.
219  * @param p_attribute14 Descriptive flexfield segment.
220  * @param p_attribute15 Descriptive flexfield segment.
221  * @param p_attribute16 Descriptive flexfield segment.
222  * @param p_attribute17 Descriptive flexfield segment.
223  * @param p_attribute18 Descriptive flexfield segment.
224  * @param p_attribute19 Descriptive flexfield segment.
225  * @param p_attribute20 Descriptive flexfield segment.
226  * @param p_effective_date Determines when the DateTrack operation comes into
227  * force.
228  * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
229  * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
230  * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
231  * depend on the dates of previous record changes and the effective date of
232  * this change.
233  * @rep:displayname Update Contract for Kuwait
234  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
235  * @rep:lifecycle active
236  * @rep:scope public
237  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
238 */
239 --
240 -- {End Of Comments}
241 --
242 procedure update_kw_contract
243   (p_validate                       in boolean    default false
244   ,p_contract_id                    in  number
245   ,p_effective_start_date           out nocopy date
246   ,p_effective_end_date             out nocopy date
247   ,p_object_version_number          in out nocopy number
248   ,p_person_id                      in  number
249   ,p_reference                      in  varchar2
250   ,p_type                           in  varchar2
251   ,p_status                         in  varchar2
252   ,p_status_reason                  in  varchar2  default hr_api.g_varchar2
253   ,p_doc_status                     in  varchar2  default hr_api.g_varchar2
254   ,p_doc_status_change_date         in  date      default hr_api.g_date
255   ,p_description                    in  varchar2  default hr_api.g_varchar2
256   ,p_duration                       in  number    default hr_api.g_number
257   ,p_duration_units                 in  varchar2  default hr_api.g_varchar2
258   ,p_contractual_job_title          in  varchar2  default hr_api.g_varchar2
259   ,p_parties                        in  varchar2  default hr_api.g_varchar2
260   ,p_start_reason                   in  varchar2  default hr_api.g_varchar2
261   ,p_end_reason                     in  varchar2  default hr_api.g_varchar2
262   ,p_number_of_extensions           in  number    default hr_api.g_number
263   ,p_extension_reason               in  varchar2  default hr_api.g_varchar2
264   ,p_extension_period               in  number    default hr_api.g_number
265   ,p_extension_period_units         in  varchar2  default hr_api.g_varchar2
266   ,p_employment_status              in  varchar2  default hr_api.g_varchar2
267   ,p_expiry_date                    in  varchar2  default hr_api.g_varchar2
268   ,p_attribute_category             in  varchar2  default hr_api.g_varchar2
269   ,p_attribute1                     in  varchar2  default hr_api.g_varchar2
270   ,p_attribute2                     in  varchar2  default hr_api.g_varchar2
271   ,p_attribute3                     in  varchar2  default hr_api.g_varchar2
272   ,p_attribute4                     in  varchar2  default hr_api.g_varchar2
273   ,p_attribute5                     in  varchar2  default hr_api.g_varchar2
274   ,p_attribute6                     in  varchar2  default hr_api.g_varchar2
275   ,p_attribute7                     in  varchar2  default hr_api.g_varchar2
276   ,p_attribute8                     in  varchar2  default hr_api.g_varchar2
277   ,p_attribute9                     in  varchar2  default hr_api.g_varchar2
278   ,p_attribute10                    in  varchar2  default hr_api.g_varchar2
279   ,p_attribute11                    in  varchar2  default hr_api.g_varchar2
280   ,p_attribute12                    in  varchar2  default hr_api.g_varchar2
281   ,p_attribute13                    in  varchar2  default hr_api.g_varchar2
282   ,p_attribute14                    in  varchar2  default hr_api.g_varchar2
283   ,p_attribute15                    in  varchar2  default hr_api.g_varchar2
284   ,p_attribute16                    in  varchar2  default hr_api.g_varchar2
285   ,p_attribute17                    in  varchar2  default hr_api.g_varchar2
286   ,p_attribute18                    in  varchar2  default hr_api.g_varchar2
287   ,p_attribute19                    in  varchar2  default hr_api.g_varchar2
288   ,p_attribute20                    in  varchar2  default hr_api.g_varchar2
289   ,p_effective_date                 in  date
290   ,p_datetrack_mode                 in  varchar2
291   );
292 --
293 end hr_kw_contract_api;