4 * This package contains APIs to validate, create, update and delete statutory
1 Package pqh_fr_stat_situations_api AUTHID CURRENT_USER as
2 /* $Header: pqstsapi.pkh 120.2 2005/10/28 17:50 deenath noship $ */
3 /*#
5 * situations.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Statutory Situation for France
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_statutory_situation >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API validates and creates a statutory situation record in the database.
18 *
19 * Statutory situation denotes the status of employment for civil servants in
20 * French Public Sector. There are many entitlements that depend on the
21 * statutory situation of a civil servant. It validates the situation name and
22 * combination of type of public sector, situation type, sub type, location,
23 * reason, source and business group id for uniqueness. The record is created
24 * in PQH_FR_STAT_SITUATIONS table.
25 *
26 * <p><b>Licensing</b><br>
27 * This API is licensed for use with Human Resources.
28 *
29 * <p><b>Prerequisites</b><br>
30 * The statutory situation can be created only for an existing business group
31 * with a type of public sector.
32 *
33 * <p><b>Post Success</b><br>
34 * A new statutory situation record is created in the database.
35 *
36 * <p><b>Post Failure</b><br>
37 * A statutory situation record is not created in the database and an error is
38 * raised
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_effective_date Specifies the reference date for validating lookup
43 * values, applicable within the active date range. This date does not
44 * determine when the changes take effect.
45 * @param p_business_group_id Identifies the business group for which the
46 * statutory situation is created. A foreign key to HR_ALL_ORGANIZATION_UNITS.
47 * @param p_situation_name A unique name for the situation
48 * @param p_type_of_ps Identifies the type of public sector for which the
49 * statutory situation is created. Valid values are defined by
50 * 'FR_PQH_ORG_CATEGORY' lookup type
51 * @param p_situation_type Identifies the situation type. Valid values are
52 * defined by 'FR_PQH_STAT_SIT_TYPE' lookup type
53 * @param p_sub_type Identifies the situation sub type and the values are based
54 * on the situation type above. Valid values are defined by
55 * 'FR_PQH_STAT_SIT_SUB_TYPE' lookup type
56 * @param p_source Indicates whether the civil servant to be placed on this
57 * statutory situation belongs to your organization or an external organization
58 * .Valid values are defined by 'FR_PQH_STAT_SIT_SOURCE' lookup type
59 * @param p_location Indicates whether the civil servant is placed within or
60 * outside your organization. Valid values are defined by
61 * 'FR_PQH_STAT_SIT_PLCMENT' lookup type
62 * @param p_reason Identifies the reason for placing the civil servant on the
63 * statutory situation. Valid values are defined by 'FR_PQH_STAT_SIT_REASON'
64 * lookup type
65 * @param p_date_from Identifies the date from which the statutory situation is
66 * active in the organization
67 * @param p_date_to Identifies the date till which the statutory situation is
68 * active in the organization
69 * @param p_request_type Indicates the type of request to be made while
70 * processing the statutory situation. Valid values are defined by
71 * 'FR_PQH_STAT_SIT_RQST_TYPE' lookup type
72 * @param p_employee_agreement_needed A flag indicating whether the employee's
73 * agreement is required or not before placing him on the statutory situation
74 * @param p_manager_agreement_needed A flag indicating whether the line
75 * manager's agreement is required or not before placing an employee on the
76 * statutory situation
77 * @param p_print_arrette A flag indicating whether a printed decree is
81 * @param p_remuneration_paid A flag indicating whether the employee should per
78 * required or not when a employee is placed on the statutory situation
79 * @param p_reserve_position A flag indicating whether the position should be
80 * reserved or not for the employee for the duration of the statutory situation
82 * paid any remuneration or not if he is placed on the statutory situation
83 * @param p_pay_share The percentage of the actual pay that can be paid to the
84 * employee when he is placed on the statutory situation. Valid values are
85 * between 0 and 100. This can be specified only when the remuneration_paid
86 * flag is set to Y.
87 * @param p_pay_periods The number of pay periods for which the employee will
88 * be paid after being placed on this statutory situation. Its value should
89 * always be greater than 0. This can be specified only when the
90 * remuneration_paid flag is set to Y.
91 * @param p_frequency The unit of time period in terms of which various
92 * duration limits for the statutory situation are defined Valid values are
93 * defined by 'PROC_PERIOD_TYPE' lookup type
94 * @param p_first_period_max_duration The maximum duration for which an
95 * employee can be placed on the statutory situation for the first time. Its
96 * value must be greater than 0. This can be specified only when the Frequency
97 * for the duration limits is specified.
98 * @param p_min_duration_per_request The minimum duration for which an employee
99 * can be placed on the statutory situation for each request. Its value must be
100 * greater than 0. This can be specified only when the Frequency for the
101 * duration limits is specified.
102 * @param p_max_duration_per_request The maximum duration for which an employee
103 * can be placed on the statutory situation per request. Its value must be
104 * greater than 0. This can be specified only when the Frequency for the
105 * duration limits is specified.
106 * @param p_max_duration_whole_career The maximum duration for which an
107 * employee can be placed on the statutory situation in his whole career. Its
108 * value must be greater than 0 and also must be greater than the maximum
109 * duration for the first period. This can be specified only when the Frequency
110 * for the duration limits is specified.
111 * @param p_renewable_allowed A flag indicating whether the statutory situation
112 * can be renewed or not for an employee. This can be specified only when the
113 * Frequency for the duration limits is specified.
114 * @param p_max_no_of_renewals The maximum number times the statutory situation
115 * can be renewed for an employee. Its value must be greater than 0. This can
116 * specified only when the statutory situation is renewable.
117 * @param p_max_duration_per_renewal The maximum duration for which the
118 * statutory situation can be renewed to an employee. Its value should always
119 * be greater than 0. This can specified only when the statutory situation is
120 * renewable.
121 * @param p_max_tot_continuous_duration The maximum total of continuous
122 * duration including renewals for which an employee can be placed on this
123 * statutory situation Its value should always be greater than 0. This can be
124 * specified only when Frequency value for duration limits is specified.
125 * @param p_statutory_situation_id The process returns the unique statutory
126 * situation identifier generated for the new statutory situation record
127 * @param p_object_version_number If p_validate is false, the process returns
128 * the version number of the created statutory situation. If p_validate is
129 * true, it returns null
130 * @param p_extend_probation_period A flag indicating whether the statutory
131 * situation can be extended during Probation of an employee or not.
132 * @param p_allow_progressions A flag indicating whether Progressions are
133 * allowed for the employee or not during the statutory situation.
134 * @param p_is_default A flag indicating whether the statutory situation
135 * is the default statutory situation or not.
136 * @param p_remunerate_assign_status_id If employee is going on a situation
137 * and is going to be paid Remuneration while on the situation then this
138 * identifier is used to indicate the Suspend With Pay Assignment Status.
139 * @rep:displayname Create Statutory Situation
140 * @rep:category BUSINESS_ENTITY PQH_FR_STATUTORY_SITUATION
141 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
142 * @rep:scope public
143 * @rep:lifecycle active
144 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
145 */
146 --
147 -- {End Of Comments}
148 --
149 procedure create_statutory_situation
150 (p_validate in boolean default false
151 ,p_effective_date in date default sysdate
152 ,p_business_group_id in number
153 ,p_situation_name in varchar2
154 ,p_type_of_ps in varchar2
155 ,p_situation_type in varchar2
156 ,p_sub_type in varchar2 default null
157 ,p_source in varchar2 default null
158 ,p_location in varchar2 default null
159 ,p_reason in varchar2 default null
160 ,p_is_default in varchar2 default null
161 ,p_date_from in date default null
162 ,p_date_to in date default null
163 ,p_request_type in varchar2 default null
164 ,p_employee_agreement_needed in varchar2 default null
165 ,p_manager_agreement_needed in varchar2 default null
166 ,p_print_arrette in varchar2 default null
167 ,p_reserve_position in varchar2 default null
168 ,p_allow_progressions in varchar2 default null
169 ,p_extend_probation_period in varchar2 default null
170 ,p_remuneration_paid in varchar2 default null
174 ,p_first_period_max_duration in number default null
171 ,p_pay_share in number default null
172 ,p_pay_periods in number default null
173 ,p_frequency in varchar2 default null
175 ,p_min_duration_per_request in number default null
176 ,p_max_duration_per_request in number default null
177 ,p_max_duration_whole_career in number default null
178 ,p_renewable_allowed in varchar2 default null
179 ,p_max_no_of_renewals in number default null
180 ,p_max_duration_per_renewal in number default null
181 ,p_max_tot_continuous_duration in number default null
182 ,p_remunerate_assign_status_id in number default null
183 ,p_statutory_situation_id out nocopy number
184 ,p_object_version_number out nocopy number
185 );
186 --
187 -- ----------------------------------------------------------------------------
188 -- |------------------------< update_statutory_situation >--------------------|
189 -- ----------------------------------------------------------------------------
190 --
191 -- {Start Of Comments}
192 /*#
193 * This API validates the record when an existing statutory situation is
194 * changed and updates the record in the database.
195 *
196 * It validates the Situation name for uniqueness. The record is updated in
197 * PQH_FR_STAT_SITUATIONS table
198 *
199 * <p><b>Licensing</b><br>
200 * This API is licensed for use with Human Resources.
201 *
202 * <p><b>Prerequisites</b><br>
203 * The statutory situation record must exist with the specified object version
204 * number.
205 *
206 * <p><b>Post Success</b><br>
207 * The existing record is updated in the database.
208 *
209 * <p><b>Post Failure</b><br>
210 * The existing record is not updated in the database and an error is raised
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_effective_date Specifies the reference date for validating lookup
215 * values, applicable within the active date range. This date does not
216 * determine when the changes take effect.
217 * @param p_statutory_situation_id {@rep:casecolumn
218 * PQH_FR_STAT_SITUATIONS.STATUTORY_SITUATION_ID}
219 * @param p_object_version_number Passes the current version number of the
220 * statutory situation record to be updated. When the API completes if
221 * p_validate is false, the process returns the new version number of the
222 * updated statutory situation record. If p_validate is true, it returns the
223 * same value which was passed in
224 * @param p_business_group_id Identifies the business group for which the
225 * statutory situation is created. A foreign key to HR_ALL_ORGANIZATION_UNITS.
226 * @param p_situation_name A unique name for the situation
227 * @param p_type_of_ps Identifies the type of public sector for which the
228 * statutory situation is created. This cannot be updated.
229 * @param p_situation_type Identifies the situation type. This cannot be
230 * updated.
231 * @param p_sub_type Identifies the situation sub type and the values are based
232 * on the situation type above. This cannot be updated.
233 * @param p_source Indicates whether the civil servant to be placed on this
234 * statutory situation belongs to your organization or an external organization
235 * .This cannot be updated.
236 * @param p_location Indicates whether the civil servant is placed within or
237 * outside your organization. This cannot be updated.
238 * @param p_reason Identifies the reason for placing the civil servant on the
239 * statutory situation. This cannot be updated.
240 * @param p_date_from Identifies the date from which the statutory situation is
241 * active in the organization
242 * @param p_date_to Identifies the date till which the statutory situation is
243 * active in the organization
244 * @param p_request_type Indicates the type of request to be made while
245 * processing the statutory situation. Valid values are defined by
246 * 'FR_PQH_STAT_SIT_RQST_TYPE' lookup type
247 * @param p_employee_agreement_needed A flag indicating whether the employee's
248 * agreement is required or not before placing him on the statutory situation
249 * @param p_manager_agreement_needed A flag indicating whether the line
250 * manager's agreement is required or not before placing an employee on the
251 * statutory situation
252 * @param p_print_arrette A flag indicating whether a printed decree is
253 * required or not when a employee is placed on the statutory situation
254 * @param p_reserve_position A flag indicating whether the position should be
255 * reserved or not for the employee for the duration of the statutory situation
256 * @param p_remuneration_paid A flag indicating whether the employee should per
257 * paid any remuneration or not if he is placed on the statutory situation
258 * @param p_pay_share The percentage of the actual pay that can be paid to the
259 * employee when he is placed on the statutory situation. Valid values are
260 * between 0 and 100. This can be specified only when the remuneration_paid
261 * flag is set to Y.
262 * @param p_pay_periods The number of pay periods for which the employee will
263 * be paid after being placed on this statutory situation. Its value should
264 * always be greater than 0. This can be specified only when the
265 * remuneration_paid flag is set to Y.
266 * @param p_frequency The unit of time period in terms of which various
267 * duration limits for the statutory situation are defined Valid values are
268 * defined by 'PROC_PERIOD_TYPE' lookup type
269 * @param p_first_period_max_duration The maximum duration for which an
270 * employee can be placed on the statutory situation for the first time. Its
271 * value must be greater than 0. This can be specified only when the Frequency
272 * for the duration limits is specified.
273 * @param p_min_duration_per_request The minimum duration for which an employee
274 * can be placed on the statutory situation for each request. Its value must be
275 * greater than 0. This can be specified only when the Frequency for the
276 * duration limits is specified.
277 * @param p_max_duration_per_request The maximum duration for which an employee
278 * can be placed on the statutory situation per request. Its value must be
279 * greater than 0. This can be specified only when the Frequency for the
280 * duration limits is specified.
281 * @param p_max_duration_whole_career The maximum duration for which an
282 * employee can be placed on the statutory situation in his whole career. Its
283 * value must be greater than 0 and also must be greater than the maximum
284 * duration for the first period. This can be specified only when the Frequency
285 * for the duration limits is specified.
286 * @param p_renewable_allowed A flag indicating whether the statutory situation
287 * can be renewed or not for an employee. This can be specified only when the
288 * Frequency for the duration limits is specified.
289 * @param p_max_no_of_renewals The maximum number times the statutory situation
290 * can be renewed for an employee. Its value must be greater than 0. This can
291 * specified only when the statutory situation is renewable.
292 * @param p_max_duration_per_renewal The maximum duration for which the
293 * statutory situation can be renewed to an employee. Its value should always
294 * be greater than 0. This can specified only when the statutory situation is
295 * renewable.
296 * @param p_max_tot_continuous_duration The maximum total of continuous
297 * duration including renewals for which an employee can be placed on this
298 * statutory situation Its value should always be greater than 0. This can be
299 * specified only when Frequency value for duration limits is specified.
300 * @param p_is_default A flag indicating whether the statutory situation
301 * is the default statutory situation or not.
302 * @param p_extend_probation_period A flag indicating whether the statutory
303 * situation can be extended during Probation of an employee or not.
304 * @param p_allow_progressions A flag indicating whether Progressions are
305 * allowed for the employee or not during the statutory situation.
306 * @param p_remunerate_assign_status_id If employee is going on a situation
307 * and is going to be paid Remuneration while on the situation then this
308 * identifier is used to indicate the Suspend With Pay Assignment Status.
309 * @rep:displayname Update Statutory Situation
310 * @rep:category BUSINESS_ENTITY PQH_FR_STATUTORY_SITUATION
311 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
312 * @rep:scope public
313 * @rep:lifecycle active
314 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
315 */
316 --
317 -- {End Of Comments}
318 --
319 procedure update_statutory_situation
320 (p_validate in boolean default false
321 ,p_effective_date in date default sysdate
322 ,p_statutory_situation_id in number
323 ,p_object_version_number in out nocopy number
324 ,p_business_group_id in number default hr_api.g_number
325 ,p_situation_name in varchar2 default hr_api.g_varchar2
326 ,p_type_of_ps in varchar2 default hr_api.g_varchar2
327 ,p_situation_type in varchar2 default hr_api.g_varchar2
328 ,p_sub_type in varchar2 default hr_api.g_varchar2
329 ,p_source in varchar2 default hr_api.g_varchar2
330 ,p_location in varchar2 default hr_api.g_varchar2
331 ,p_reason in varchar2 default hr_api.g_varchar2
332 ,p_is_default in varchar2 default hr_api.g_varchar2
333 ,p_date_from in date default hr_api.g_date
334 ,p_date_to in date default hr_api.g_date
335 ,p_request_type in varchar2 default hr_api.g_varchar2
336 ,p_employee_agreement_needed in varchar2 default hr_api.g_varchar2
337 ,p_manager_agreement_needed in varchar2 default hr_api.g_varchar2
338 ,p_print_arrette in varchar2 default hr_api.g_varchar2
339 ,p_reserve_position in varchar2 default hr_api.g_varchar2
340 ,p_allow_progressions in varchar2 default hr_api.g_varchar2
341 ,p_extend_probation_period in varchar2 default hr_api.g_varchar2
342 ,p_remuneration_paid in varchar2 default hr_api.g_varchar2
343 ,p_pay_share in number default hr_api.g_number
344 ,p_pay_periods in number default hr_api.g_number
345 ,p_frequency in varchar2 default hr_api.g_varchar2
346 ,p_first_period_max_duration in number default hr_api.g_number
347 ,p_min_duration_per_request in number default hr_api.g_number
348 ,p_max_duration_per_request in number default hr_api.g_number
349 ,p_max_duration_whole_career in number default hr_api.g_number
350 ,p_renewable_allowed in varchar2 default hr_api.g_varchar2
351 ,p_max_no_of_renewals in number default hr_api.g_number
352 ,p_max_duration_per_renewal in number default hr_api.g_number
353 ,p_max_tot_continuous_duration in number default hr_api.g_number
354 ,p_remunerate_assign_status_id in number default hr_api.g_number
355
356 );
357 --
358 -- ----------------------------------------------------------------------------
359 -- |------------------------< delete_statutory_situation >--------------------|
360 -- ----------------------------------------------------------------------------
361 --
362 -- {Start Of Comments}
363 /*#
364 * This API deletes a statutory situation record from the database.
365 *
366 * The record is deleted from PQH_FR_STAT_SITUATIONS table
367 *
368 * <p><b>Licensing</b><br>
369 * This API is licensed for use with Human Resources.
370 *
371 * <p><b>Prerequisites</b><br>
372 * There should not be any civil servants placed on this statutory situation.
373 * All the eligibility rule records corresponding to the statutory situation
374 * should have been deleted. The record to be deleted should exist with the
375 * specified object version number.
376 *
377 * <p><b>Post Success</b><br>
378 * The statutory situation is deleted from the database.
379 *
380 * <p><b>Post Failure</b><br>
381 * The statutory situation is not deleted from the database and an error is
382 * raised
383 * @param p_validate If true, then validation alone will be performed and the
384 * database will remain unchanged. If false and all validation checks pass,
385 * then the database will be modified.
386 * @param p_statutory_situation_id {@rep:casecolumn
387 * PQH_FR_STAT_SITUATIONS.STATUTORY_SITUATION_ID}
388 * @param p_object_version_number Current version number of the statutory
389 * situation record to be deleted
390 * @rep:displayname Delete Statutory Situation
391 * @rep:category BUSINESS_ENTITY PQH_FR_STATUTORY_SITUATION
392 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
393 * @rep:scope public
394 * @rep:lifecycle active
395 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
396 */
397 --
398 -- {End Of Comments}
399 --
400 procedure delete_statutory_situation
401 (p_validate in boolean default false
402 ,p_statutory_situation_id in number
403 ,p_object_version_number in number
404 );
405 --
406
407 end pqh_fr_stat_situations_api;
[Home] [Help]