DBA Data[Home] [Help]

PACKAGE: APPS.HR_BE_CONTRACT_API

Source


1 Package hr_be_contract_api as
2 /* $Header: hrctcbei.pkh 120.1 2005/10/02 02:01:43 aroussel $ */
3 /*#
4  * This package contains contract APIs for Belgium.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Employment Contract for Belgium
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_be_contract >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new Belgian contract for the person.
17  *
18  * See the create_contract API for further documentation as this API is
19  * essentially an alternative.
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 exists in the same Business Group as that of the contract
26  * being created.
27  *
28  * <p><b>Post Success</b><br>
29  * The contract is successfully inserted into the database.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not create the contract 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_contract_id If p_validate is false then this uniquely identifies
37  * the contract created. If p_validate is true, then the the value will be
38  * null.
39  * @param p_effective_start_date If p_validate is false, then set to the
40  * earliest effective start date for the created contract. If p_validate is
41  * true, then set to null.
42  * @param p_effective_end_date If p_validate is false, then set to the
43  * effective end date for the created contract. If p_validate is true, then set
44  * to null.
45  * @param p_object_version_number If p_validate is false, then set to the
46  * version number of the created contract. If p_validate is true, then set to
47  * null.
48  * @param p_person_id Identifies the person for whom you create the contract
49  * record.
50  * @param p_reference Reference code for the contract
51  * @param p_type The type of the contract. Valid values are defined by the
52  * CONTRACT_TYPE lookup type.
53  * @param p_status The status of the contract. Valid values are defined by the
54  * CONTRACT_STATUS lookup type.
55  * @param p_status_reason The reason why the contract has its current status.
56  * Valid values are defined by the CONTRACT_STATUS_REASON lookup type.
57  * @param p_description Contract description
58  * @param p_duration The length of time during which the contract is active.
59  * @param p_duration_units Units for contract duration, e.g., Weeks, Months,
60  * Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
61  * @param p_contractual_job_title Contractual job title
62  * @param p_parties Parties to the contract
63  * @param p_start_reason Reason for starting the contract. Valid values are
64  * defined by the CONTRACT_START_REASON lookup type.
65  * @param p_end_reason Reason for ending the contract. Valid values are defined
66  * by the CONTRACT_END_REASON lookup type.
67  * @param p_number_of_extensions How many times the contract has been extended.
68  * @param p_extension_reason Reason for extending the contract
69  * @param p_extension_period How long the contract has been extended.
70  * @param p_extension_period_units Units for extension period, e.g., Weeks,
71  * Months, Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
72  * @param p_contract_category The contract category. Valid values exist in the
73  * 'BE_CONTRACT_CATEGORY' lookup type.
74  * @param p_first_date_worked The date first worked
75  * @param p_last_date_worked The last date worked
76  * @param p_payment_start_date The payment start date
77  * @param p_payment_end_date The payment end date
78  * @param p_notice_period The notice period
79  * @param p_notice_period_units The units of the notice period. Valid values
80  * exist in the 'BE_NOTICE_PERIOD_UNITS' lookup type.
81  * @param p_replacing_employee The employee being replaced by this contract
82  * @param p_attribute_category This context value determines which flexfield
83  * structure to use with the descriptive flexfield segments.
84  * @param p_attribute1 Descriptive flexfield segment.
85  * @param p_attribute2 Descriptive flexfield segment.
86  * @param p_attribute3 Descriptive flexfield segment.
87  * @param p_attribute4 Descriptive flexfield segment.
88  * @param p_attribute5 Descriptive flexfield segment.
89  * @param p_attribute6 Descriptive flexfield segment.
90  * @param p_attribute7 Descriptive flexfield segment.
91  * @param p_attribute8 Descriptive flexfield segment.
92  * @param p_attribute9 Descriptive flexfield segment.
93  * @param p_attribute10 Descriptive flexfield segment.
94  * @param p_attribute11 Descriptive flexfield segment.
95  * @param p_attribute12 Descriptive flexfield segment.
96  * @param p_attribute13 Descriptive flexfield segment.
97  * @param p_attribute14 Descriptive flexfield segment.
98  * @param p_attribute15 Descriptive flexfield segment.
99  * @param p_attribute16 Descriptive flexfield segment.
100  * @param p_attribute17 Descriptive flexfield segment.
101  * @param p_attribute18 Descriptive flexfield segment.
102  * @param p_attribute19 Descriptive flexfield segment.
103  * @param p_attribute20 Descriptive flexfield segment.
104  * @param p_effective_date Determines when the DateTrack operation comes into
105  * force.
106  * @rep:displayname Create Employment Contract for Belgium
107  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
108  * @rep:scope public
109  * @rep:lifecycle active
110  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
111 */
112 --
113 -- {End Of Comments}
114 --
115 procedure create_be_contract
116 (p_validate                       in  boolean   default false
117 ,p_contract_id                    out nocopy number
118 ,p_effective_start_date           out nocopy date
119 ,p_effective_end_date             out nocopy date
120 ,p_object_version_number          out nocopy number
121 ,p_person_id                      in  number
122 ,p_reference                      in  varchar2
123 ,p_type                           in  varchar2
124 ,p_status                         in  varchar2
125 ,p_status_reason                  in  varchar2  default null
126 ,p_description                    in  varchar2  default null
127 ,p_duration                       in  number    default null
128 ,p_duration_units                 in  varchar2  default null
129 ,p_contractual_job_title          in  varchar2  default null
130 ,p_parties                        in  varchar2  default null
131 ,p_start_reason                   in  varchar2  default null
132 ,p_end_reason                     in  varchar2  default null
133 ,p_number_of_extensions           in  number    default null
134 ,p_extension_reason               in  varchar2  default null
135 ,p_extension_period               in  number    default null
136 ,p_extension_period_units         in  varchar2  default null
137 ,p_contract_category	          in  varchar2  default null
138 ,p_first_date_worked              in  varchar2  default null
139 ,p_last_date_worked               in  varchar2  default null
140 ,p_payment_start_date		  in  varchar2  default null
141 ,p_payment_end_date               in  varchar2  default null
142 ,p_notice_period                  in  varchar2  default null
143 ,p_notice_period_units            in  varchar2  default null
144 ,p_replacing_employee             in  varchar2  default null
145 ,p_attribute_category             in  varchar2  default null
146 ,p_attribute1                     in  varchar2  default null
147 ,p_attribute2                     in  varchar2  default null
148 ,p_attribute3                     in  varchar2  default null
149 ,p_attribute4                     in  varchar2  default null
150 ,p_attribute5                     in  varchar2  default null
151 ,p_attribute6                     in  varchar2  default null
152 ,p_attribute7                     in  varchar2  default null
153 ,p_attribute8                     in  varchar2  default null
154 ,p_attribute9                     in  varchar2  default null
155 ,p_attribute10                    in  varchar2  default null
156 ,p_attribute11                    in  varchar2  default null
157 ,p_attribute12                    in  varchar2  default null
158 ,p_attribute13                    in  varchar2  default null
159 ,p_attribute14                    in  varchar2  default null
160 ,p_attribute15                    in  varchar2  default null
161 ,p_attribute16                    in  varchar2  default null
162 ,p_attribute17                    in  varchar2  default null
163 ,p_attribute18                    in  varchar2  default null
164 ,p_attribute19                    in  varchar2  default null
165 ,p_attribute20                    in  varchar2  default null
166 ,p_effective_date                 in  date);
167 --
168 -- ----------------------------------------------------------------------------
169 -- |----------------------------< update_be_contract >------------------------|
170 -- ----------------------------------------------------------------------------
171 --
172 -- {Start Of Comments}
173 /*#
174  * This API updates an existing Belgian contract for the person.
175  *
176  *
177  * <p><b>Licensing</b><br>
178  * This API is licensed for use with Human Resources.
179  *
180  * <p><b>Prerequisites</b><br>
181  * The contract must exist.
182  *
183  * <p><b>Post Success</b><br>
184  * The contract is successfully updated in the database.
185  *
186  * <p><b>Post Failure</b><br>
187  * The API does not update the contract and raises an error.
188  * @param p_validate hr_contract_api.update_contract
189  * @param p_contract_id hr_contract_api.update_contract
190  * @param p_effective_start_date hr_contract_api.update_contract
191  * @param p_effective_end_date hr_contract_api.update_contract
192  * @param p_object_version_number hr_contract_api.update_contract
193  * @param p_person_id hr_contract_api.update_contract
194  * @param p_reference hr_contract_api.update_contract
195  * @param p_type hr_contract_api.update_contract
196  * @param p_status hr_contract_api.update_contract
197  * @param p_status_reason hr_contract_api.update_contract
198  * @param p_description hr_contract_api.update_contract
199  * @param p_duration hr_contract_api.update_contract
200  * @param p_duration_units hr_contract_api.update_contract
201  * @param p_contractual_job_title hr_contract_api.update_contract
202  * @param p_parties hr_contract_api.update_contract
203  * @param p_start_reason hr_contract_api.update_contract
204  * @param p_end_reason hr_contract_api.update_contract
205  * @param p_number_of_extensions hr_contract_api.update_contract
206  * @param p_extension_reason hr_contract_api.update_contract
207  * @param p_extension_period hr_contract_api.update_contract
208  * @param p_extension_period_units hr_contract_api.update_contract
209  * @param p_contract_category The contract category. Valid values exist in the
210  * 'BE_CONTRACT_CATEGORY' lookup type.
211  * @param p_first_date_worked The date first worked
212  * @param p_last_date_worked The last date worked
213  * @param p_payment_start_date The payment start date
214  * @param p_payment_end_date The payment end date
215  * @param p_notice_period The notice period
216  * @param p_notice_period_units The units of the notice period. Valid values
217  * exist in the 'BE_NOTICE_PERIOD_UNITS' lookup type.
218  * @param p_replacing_employee The employee being replaced by this contract
219  * @param p_attribute_category hr_contract_api.update_contract
220  * @param p_attribute1 hr_contract_api.update_contract
221  * @param p_attribute2 hr_contract_api.update_contract
222  * @param p_attribute3 hr_contract_api.update_contract
223  * @param p_attribute4 hr_contract_api.update_contract
224  * @param p_attribute5 hr_contract_api.update_contract
225  * @param p_attribute6 hr_contract_api.update_contract
226  * @param p_attribute7 hr_contract_api.update_contract
227  * @param p_attribute8 hr_contract_api.update_contract
228  * @param p_attribute9 hr_contract_api.update_contract
229  * @param p_attribute10 hr_contract_api.update_contract
230  * @param p_attribute11 hr_contract_api.update_contract
231  * @param p_attribute12 hr_contract_api.update_contract
232  * @param p_attribute13 hr_contract_api.update_contract
233  * @param p_attribute14 hr_contract_api.update_contract
234  * @param p_attribute15 hr_contract_api.update_contract
235  * @param p_attribute16 hr_contract_api.update_contract
236  * @param p_attribute17 hr_contract_api.update_contract
237  * @param p_attribute18 hr_contract_api.update_contract
238  * @param p_attribute19 hr_contract_api.update_contract
239  * @param p_attribute20 hr_contract_api.update_contract
240  * @param p_effective_date hr_contract_api.update_contract
241  * @param p_datetrack_mode hr_contract_api.update_contract
242  * @rep:displayname Update Employment Contract for Belgium
243  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
244  * @rep:scope public
245  * @rep:lifecycle active
246  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
247 */
248 --
249 -- {End Of Comments}
250 --
251 procedure update_be_contract
252 (p_validate                       in  boolean   default false
253 ,p_contract_id                    in  number
254 ,p_effective_start_date           out nocopy date
255 ,p_effective_end_date             out nocopy date
256 ,p_object_version_number          in out nocopy number
257 ,p_person_id                      in  number
258 ,p_reference                      in  varchar2
259 ,p_type                           in  varchar2
260 ,p_status                         in  varchar2
261 ,p_status_reason                  in  varchar2  default hr_api.g_varchar2
262 ,p_description                    in  varchar2  default hr_api.g_varchar2
263 ,p_duration                       in  number    default hr_api.g_number
264 ,p_duration_units                 in  varchar2  default hr_api.g_varchar2
265 ,p_contractual_job_title          in  varchar2  default hr_api.g_varchar2
266 ,p_parties                        in  varchar2  default hr_api.g_varchar2
267 ,p_start_reason                   in  varchar2  default hr_api.g_varchar2
268 ,p_end_reason                     in  varchar2  default hr_api.g_varchar2
269 ,p_number_of_extensions           in  number    default hr_api.g_number
270 ,p_extension_reason               in  varchar2  default hr_api.g_varchar2
271 ,p_extension_period               in  number    default hr_api.g_number
272 ,p_extension_period_units         in  varchar2  default hr_api.g_varchar2
273 ,p_contract_category	          in  varchar2  default hr_api.g_varchar2
274 ,p_first_date_worked              in  varchar2  default hr_api.g_varchar2
275 ,p_last_date_worked               in  varchar2  default hr_api.g_varchar2
276 ,p_payment_start_date		  in  varchar2  default hr_api.g_varchar2
277 ,p_payment_end_date               in  varchar2  default hr_api.g_varchar2
278 ,p_notice_period                  in  varchar2  default hr_api.g_varchar2
279 ,p_notice_period_units            in  varchar2  default hr_api.g_varchar2
280 ,p_replacing_employee             in  varchar2  default hr_api.g_varchar2
281 ,p_attribute_category             in  varchar2  default hr_api.g_varchar2
282 ,p_attribute1                     in  varchar2  default hr_api.g_varchar2
283 ,p_attribute2                     in  varchar2  default hr_api.g_varchar2
284 ,p_attribute3                     in  varchar2  default hr_api.g_varchar2
285 ,p_attribute4                     in  varchar2  default hr_api.g_varchar2
286 ,p_attribute5                     in  varchar2  default hr_api.g_varchar2
287 ,p_attribute6                     in  varchar2  default hr_api.g_varchar2
288 ,p_attribute7                     in  varchar2  default hr_api.g_varchar2
289 ,p_attribute8                     in  varchar2  default hr_api.g_varchar2
290 ,p_attribute9                     in  varchar2  default hr_api.g_varchar2
291 ,p_attribute10                    in  varchar2  default hr_api.g_varchar2
292 ,p_attribute11                    in  varchar2  default hr_api.g_varchar2
293 ,p_attribute12                    in  varchar2  default hr_api.g_varchar2
294 ,p_attribute13                    in  varchar2  default hr_api.g_varchar2
295 ,p_attribute14                    in  varchar2  default hr_api.g_varchar2
296 ,p_attribute15                    in  varchar2  default hr_api.g_varchar2
297 ,p_attribute16                    in  varchar2  default hr_api.g_varchar2
298 ,p_attribute17                    in  varchar2  default hr_api.g_varchar2
299 ,p_attribute18                    in  varchar2  default hr_api.g_varchar2
300 ,p_attribute19                    in  varchar2  default hr_api.g_varchar2
301 ,p_attribute20                    in  varchar2  default hr_api.g_varchar2
302 ,p_effective_date                 in  date
303 ,p_datetrack_mode                 in  varchar2);
304 --
305 end hr_be_contract_api;