1 package hr_sa_contract_api as
2 /* $Header: pectcsai.pkh 120.1 2005/10/02 02:14:15 aroussel $ */
3 /*#
4 * This package contains contract APIs for Saudi Arabia.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employment Contract for Saudi Arabia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_sa_contract >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a contract for an employee in a Saudi Arabia business
17 * group.
18 *
19 * The API calls the generic API create_contract, with parameters set as
20 * appropriate for the Saudi person. As this API is effectively an alternative
21 * to the API create_contract, see that API for further explanation.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * See API create_contract
28 *
29 * <p><b>Post Success</b><br>
30 * The API successfully creates the contract record in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create the contract record 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_employment_status Employment Status. Valid values exist in the
77 * 'SA_EMPLOYMENT_STATUS' lookup type.
78 * @param p_expiry_date Expiry Date
79 * @param p_attribute_category This context value determines which flexfield
80 * structure to use with the descriptive flexfield segments.
81 * @param p_attribute1 Descriptive flexfield segment.
82 * @param p_attribute2 Descriptive flexfield segment.
83 * @param p_attribute3 Descriptive flexfield segment.
84 * @param p_attribute4 Descriptive flexfield segment.
85 * @param p_attribute5 Descriptive flexfield segment.
86 * @param p_attribute6 Descriptive flexfield segment.
87 * @param p_attribute7 Descriptive flexfield segment.
88 * @param p_attribute8 Descriptive flexfield segment.
89 * @param p_attribute9 Descriptive flexfield segment.
90 * @param p_attribute10 Descriptive flexfield segment.
91 * @param p_attribute11 Descriptive flexfield segment.
92 * @param p_attribute12 Descriptive flexfield segment.
93 * @param p_attribute13 Descriptive flexfield segment.
94 * @param p_attribute14 Descriptive flexfield segment.
95 * @param p_attribute15 Descriptive flexfield segment.
96 * @param p_attribute16 Descriptive flexfield segment.
97 * @param p_attribute17 Descriptive flexfield segment.
98 * @param p_attribute18 Descriptive flexfield segment.
99 * @param p_attribute19 Descriptive flexfield segment.
100 * @param p_attribute20 Descriptive flexfield segment.
101 * @param p_effective_date Determines when the DateTrack operation comes into
102 * force.
103 * @rep:displayname Create Employment Contract for Saudi Arabia
104 * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
105 * @rep:scope public
106 * @rep:lifecycle active
107 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
108 */
109 --
110 -- {End Of Comments}
111 --
112 procedure create_sa_contract
113 (p_validate in boolean default false
114 ,p_contract_id out nocopy number
115 ,p_effective_start_date out nocopy date
116 ,p_effective_end_date out nocopy date
117 ,p_object_version_number out nocopy number
118 ,p_person_id in number
119 ,p_reference in varchar2
120 ,p_type in varchar2
121 ,p_status in varchar2
122 ,p_status_reason in varchar2 default null
123 ,p_doc_status in varchar2 default null
124 ,p_doc_status_change_date in date default null
125 ,p_description in varchar2 default null
126 ,p_duration in number default null
127 ,p_duration_units in varchar2 default null
128 ,p_contractual_job_title in varchar2
129 ,p_parties in varchar2 default null
130 ,p_start_reason in varchar2 default null
131 ,p_end_reason in varchar2 default null
132 ,p_number_of_extensions in number default null
133 ,p_extension_reason in varchar2 default null
134 ,p_extension_period in number default null
135 ,p_extension_period_units in varchar2 default null
136 ,p_employment_status in varchar2 default null
137 ,p_expiry_date in varchar2 default null
138 ,p_attribute_category in varchar2 default null
139 ,p_attribute1 in varchar2 default null
140 ,p_attribute2 in varchar2 default null
141 ,p_attribute3 in varchar2 default null
142 ,p_attribute4 in varchar2 default null
143 ,p_attribute5 in varchar2 default null
144 ,p_attribute6 in varchar2 default null
145 ,p_attribute7 in varchar2 default null
146 ,p_attribute8 in varchar2 default null
147 ,p_attribute9 in varchar2 default null
148 ,p_attribute10 in varchar2 default null
149 ,p_attribute11 in varchar2 default null
150 ,p_attribute12 in varchar2 default null
151 ,p_attribute13 in varchar2 default null
152 ,p_attribute14 in varchar2 default null
153 ,p_attribute15 in varchar2 default null
154 ,p_attribute16 in varchar2 default null
155 ,p_attribute17 in varchar2 default null
156 ,p_attribute18 in varchar2 default null
157 ,p_attribute19 in varchar2 default null
158 ,p_attribute20 in varchar2 default null
159 ,p_effective_date in date
160 );
161 --
162 -- ----------------------------------------------------------------------------
163 -- |----------------------------< update_sa_contract >------------------------|
164 -- ----------------------------------------------------------------------------
165 --
166 -- {Start Of Comments}
167 /*#
168 * This API updates existing contract information of an employee in a Saudi
169 * Arabia business group.
170 *
171 * The API calls the generic API update_contract, with parameters set as
172 * appropriate for the Saudi person. As this API is effectively an alternative
173 * to the API update_contract, see that API for further explanation.
174 *
175 * <p><b>Licensing</b><br>
176 * This API is licensed for use with Human Resources.
177 *
178 * <p><b>Prerequisites</b><br>
179 * See API update_contract
180 *
181 * <p><b>Post Success</b><br>
182 * The contract record is successfully updated in the database.
183 *
184 * <p><b>Post Failure</b><br>
185 * The API does not update the contract record and raises an error.
186 * @param p_validate If true, then validation alone will be performed and the
187 * database will remain unchanged. If false and all validation checks pass,
188 * then the database will be modified.
189 * @param p_contract_id Identifies the contract record to be modified.
190 * @param p_effective_start_date If p_validate is false, then set to the
191 * effective start date in the updated contract row as of the effective date.
192 * If p_validate is true, then set to null.
193 * @param p_effective_end_date If p_validate is false, then set to the
194 * effective end date in the updated contract row as of the effective date. If
195 * p_validate is true, then set to null.
196 * @param p_object_version_number Passes the current version number of the
197 * contract to be updated. If p_validate is false on completion, set to the new
198 * version number of the updated contract. If p_validate is true set to the
199 * input value.
200 * @param p_person_id Identifies the employee for whom the contract was created
201 * @param p_reference Reference code for the contract
202 * @param p_type The type of the contract. Valid values are defined by the
203 * CONTRACT_TYPE lookup type.
204 * @param p_status The status of the contract. Valid values are defined by the
205 * CONTRACT_STATUS lookup type.
206 * @param p_status_reason The reason why the contract has its current status.
207 * Valid values are defined by the CONTRACT_STATUS_REASON lookup type.
208 * @param p_doc_status The status of the physical document associated with the
209 * contract. Valid values are defined by the DOCUMENT_STATUS lookup type.
210 * @param p_doc_status_change_date Date the document status changed.
211 * @param p_description Contract description
212 * @param p_duration The length of time during which the contract is active.
213 * @param p_duration_units Units for contract duration, e.g., Weeks, Months,
214 * Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
215 * @param p_contractual_job_title Contractual job title
216 * @param p_parties Parties to the contract
217 * @param p_start_reason Reason for starting the contract. Valid values are
218 * defined by the CONTRACT_START_REASON lookup type.
219 * @param p_end_reason Reason for ending the contract. Valid values are defined
220 * by the CONTRACT_END_REASON lookup type.
221 * @param p_number_of_extensions How many times the contract has been extended.
222 * @param p_extension_reason Reason for extending the contract
223 * @param p_extension_period How long the contract has been extended.
224 * @param p_extension_period_units Units for extension period, e.g., Weeks,
225 * Months, Years. Valid values are defined by the QUALIFYING_UNITS lookup type.
226 * @param p_employment_status Employment Status. Valid values exist in the
227 * 'SA_EMPLOYMENT_STATUS' lookup type.
228 * @param p_expiry_date Expiry Date
229 * @param p_attribute_category This context value determines which flexfield
230 * structure to use with the descriptive flexfield segments.
231 * @param p_attribute1 Descriptive flexfield segment.
232 * @param p_attribute2 Descriptive flexfield segment.
233 * @param p_attribute3 Descriptive flexfield segment.
234 * @param p_attribute4 Descriptive flexfield segment.
235 * @param p_attribute5 Descriptive flexfield segment.
236 * @param p_attribute6 Descriptive flexfield segment.
237 * @param p_attribute7 Descriptive flexfield segment.
238 * @param p_attribute8 Descriptive flexfield segment.
239 * @param p_attribute9 Descriptive flexfield segment.
240 * @param p_attribute10 Descriptive flexfield segment.
241 * @param p_attribute11 Descriptive flexfield segment.
242 * @param p_attribute12 Descriptive flexfield segment.
243 * @param p_attribute13 Descriptive flexfield segment.
244 * @param p_attribute14 Descriptive flexfield segment.
245 * @param p_attribute15 Descriptive flexfield segment.
246 * @param p_attribute16 Descriptive flexfield segment.
247 * @param p_attribute17 Descriptive flexfield segment.
248 * @param p_attribute18 Descriptive flexfield segment.
249 * @param p_attribute19 Descriptive flexfield segment.
250 * @param p_attribute20 Descriptive flexfield segment.
251 * @param p_effective_date Determines when the DateTrack operation comes into
252 * force.
253 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
254 * the record. You must set to UPDATE, CORRECTION, UPDATE_OVERRIDE or
255 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
256 * depend on the dates of previous record changes and the effective date of
257 * this change.
258 * @rep:displayname Update Employment Contract for Saudi Arabia
259 * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
260 * @rep:scope public
261 * @rep:lifecycle active
262 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
263 */
264 --
265 -- {End Of Comments}
266 --
267 procedure update_sa_contract
268 (p_validate in boolean default false
269 ,p_contract_id in number
270 ,p_effective_start_date out nocopy date
271 ,p_effective_end_date out nocopy date
272 ,p_object_version_number in out nocopy number
273 ,p_person_id in number
274 ,p_reference in varchar2
275 ,p_type in varchar2
276 ,p_status in varchar2
277 ,p_status_reason in varchar2 default hr_api.g_varchar2
278 ,p_doc_status in varchar2 default hr_api.g_varchar2
279 ,p_doc_status_change_date in date default hr_api.g_date
280 ,p_description in varchar2 default hr_api.g_varchar2
281 ,p_duration in number default hr_api.g_number
282 ,p_duration_units in varchar2 default hr_api.g_varchar2
283 ,p_contractual_job_title in varchar2 default hr_api.g_varchar2
284 ,p_parties in varchar2 default hr_api.g_varchar2
285 ,p_start_reason in varchar2 default hr_api.g_varchar2
286 ,p_end_reason in varchar2 default hr_api.g_varchar2
287 ,p_number_of_extensions in number default hr_api.g_number
288 ,p_extension_reason in varchar2 default hr_api.g_varchar2
289 ,p_extension_period in number default hr_api.g_number
290 ,p_extension_period_units in varchar2 default hr_api.g_varchar2
291 ,p_employment_status in varchar2 default hr_api.g_varchar2
292 ,p_expiry_date in varchar2 default hr_api.g_varchar2
293 ,p_attribute_category in varchar2 default hr_api.g_varchar2
294 ,p_attribute1 in varchar2 default hr_api.g_varchar2
295 ,p_attribute2 in varchar2 default hr_api.g_varchar2
296 ,p_attribute3 in varchar2 default hr_api.g_varchar2
297 ,p_attribute4 in varchar2 default hr_api.g_varchar2
298 ,p_attribute5 in varchar2 default hr_api.g_varchar2
299 ,p_attribute6 in varchar2 default hr_api.g_varchar2
300 ,p_attribute7 in varchar2 default hr_api.g_varchar2
301 ,p_attribute8 in varchar2 default hr_api.g_varchar2
302 ,p_attribute9 in varchar2 default hr_api.g_varchar2
303 ,p_attribute10 in varchar2 default hr_api.g_varchar2
304 ,p_attribute11 in varchar2 default hr_api.g_varchar2
305 ,p_attribute12 in varchar2 default hr_api.g_varchar2
306 ,p_attribute13 in varchar2 default hr_api.g_varchar2
307 ,p_attribute14 in varchar2 default hr_api.g_varchar2
308 ,p_attribute15 in varchar2 default hr_api.g_varchar2
309 ,p_attribute16 in varchar2 default hr_api.g_varchar2
310 ,p_attribute17 in varchar2 default hr_api.g_varchar2
311 ,p_attribute18 in varchar2 default hr_api.g_varchar2
312 ,p_attribute19 in varchar2 default hr_api.g_varchar2
313 ,p_attribute20 in varchar2 default hr_api.g_varchar2
314 ,p_effective_date in date
315 ,p_datetrack_mode in varchar2
316 );
317 --
318 end hr_sa_contract_api;
[Home] [Help]