1 Package pqh_fr_validations_api as
2 /* $Header: pqvldapi.pkh 120.1 2005/10/02 02:28:42 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete services validation.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Service Validation for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< insert_validation >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API validates and creates a services validation record in the database.
17 *
18 * Services validation is a process of validating a civil servant's
19 * contributions to non-public sector pension funds. The process involves
20 * recording the details of previous services of the civil servant, wherein he
21 * was contributing to a non-public sector pension fund and then recording
22 * various events that happen during the validation process and finally
23 * defining the validation amount that is to be collected from the employer and
24 * the employee.
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 * Employee whose services validation is being processed must exist with in the
31 * current business group.
32 *
33 * <p><b>Post Success</b><br>
34 * A new services validation record is created in the database.
35 *
36 * <p><b>Post Failure</b><br>
37 * A services validation record is not created in the database and an error is
38 * raised
39 * @param p_effective_date Specifies the reference date for validating lookup
40 * values, applicable within the active date range. This date does not
41 * determine when the changes take effect.
42 * @param p_pension_fund_type_code Identifies the pension fund type to which
43 * the civil servant was contributing prior to joining the current
44 * organization. Valid values are identified by lookup type
45 * 'FR_PQH_PENSION_FUND_TYPE'
46 * @param p_pension_fund_id Pension fund name that the employee had with the
47 * previous employer
48 * @param p_business_group_id Business group identifier to which the employee
49 * is associated. References HR_ALL_ORGANIZATION_UNITS.
50 * @param p_person_id Identifies the person for whom services validation is
51 * processed.
52 * @param p_previously_validated_flag {@rep:casecolumn
53 * PQH_FR_VALIDATIONS.PREVIOUSLY_VALIDATED_FLAG}
54 * @param p_request_date {@rep:casecolumn PQH_FR_VALIDATIONS.REQUEST_DATE}
55 * @param p_completion_date {@rep:casecolumn
56 * PQH_FR_VALIDATIONS.COMPLETION_DATE}
57 * @param p_previous_employer_id {@rep:casecolumn
58 * PQH_FR_VALIDATIONS.PREVIOUS_EMPLOYER_ID}
59 * @param p_status Identifies the status of the services validation process,
60 * for example, pre-process, accepted etc. Valid values are identified by
61 * lookup type 'FR_PQH_PROCESS_STATUS'
62 * @param p_employer_amount Amount of money contributed by the employer towards
63 * the pension fund of the employee
64 * @param p_employer_currency_code Currency in terms of which money was
65 * contributed by the employer towards the pension fund of the employee
66 * @param p_employee_amount Amount of money contributed by the employee towards
67 * his pension fund
68 * @param p_employee_currency_code Currency in terms of which money was
69 * contributed by the employee towards his pension fund
70 * @param p_deduction_per_period {@rep:casecolumn
71 * PQH_FR_VALIDATIONS.DEDUCTION_PER_PERIOD}
72 * @param p_deduction_currency_code Currency in terms of which the employee pay
73 * is deducted per pay period
74 * @param p_percent_of_salary Percent of the salary that is deducted from the
75 * employee pay per period to make contribution towards his pension fund
76 * @param p_validation_id The process returns the unique validation identifier
77 * generated for the new service validation record
78 * @param p_object_version_number The process returns the version number of the
79 * created service validation record
80 * @rep:displayname Create Validation
81 * @rep:category BUSINESS_ENTITY PQH_FR_SERVICES_VALIDATION
82 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
83 * @rep:scope public
84 * @rep:lifecycle active
85 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
86 */
87 --
88 -- {End Of Comments}
89 --
90 procedure Insert_Validation
91 (p_effective_date in date
92 ,p_pension_fund_type_code in varchar2
93 ,p_pension_fund_id in number
94 ,p_business_group_id in number
95 ,p_person_id in number
96 ,p_previously_validated_flag in varchar2
97 ,p_request_date in date default null
98 ,p_completion_date in date default null
99 ,p_previous_employer_id in number default null
100 ,p_status in varchar2 default null
101 ,p_employer_amount in number default null
102 ,p_employer_currency_code in varchar2 default null
103 ,p_employee_amount in number default null
104 ,p_employee_currency_code in varchar2 default null
105 ,p_deduction_per_period in number default null
106 ,p_deduction_currency_code in varchar2 default null
107 ,p_percent_of_salary in number default null
108 ,p_validation_id out nocopy number
109 ,p_object_version_number out nocopy number
110 );
111 --
112 -- ----------------------------------------------------------------------------
113 -- |----------------------------< update_validation >-------------------------|
114 -- ----------------------------------------------------------------------------
115 --
116 -- {Start Of Comments}
117 /*#
118 * This API validates the record when an existing services validation record is
119 * changed and updates the record in the database.
120 *
121 * It validates the business group identifier to which employee is associated
122 * before updating the record .The record is updated in PQH_FR_VALIDATIONS
123 * table
124 *
125 * <p><b>Licensing</b><br>
126 * This API is licensed for use with Human Resources.
127 *
128 * <p><b>Prerequisites</b><br>
129 * Employee whose services validation is being updated should belong to an
130 * existing business group and the record should exist with the specified
131 * object version number.
132 *
133 * <p><b>Post Success</b><br>
134 * The services validation is updated in the database with the current changes.
135 *
136 * <p><b>Post Failure</b><br>
137 * The services validation is not updated in the database and an error is
138 * raised
139 * @param p_effective_date Reference date for validating lookup values are
140 * applicable during the start to end active date range. This date does not
141 * determine when the changes take effect
142 * @param p_validation_id {@rep:casecolumn PQH_FR_VALIDATIONS.VALIDATION_ID}
143 * @param p_object_version_number Passes the current version number of the
144 * services validation record to be updated. When the API completes, the
145 * process returns the new version number of the updated services validation
146 * record
147 * @param p_pension_fund_type_code Identifies the pension fund type to which
148 * the civil servant was contributing prior to joining the current
149 * organization. Valid values are identified by lookup type
150 * 'FR_PQH_PENSION_FUND_TYPE'
151 * @param p_pension_fund_id Pension fund identifier name that employee had with
152 * the previous employer
153 * @param p_business_group_id Business group identifier to which the employee
154 * is associated with the current employer
155 * @param p_person_id Identifies the person for whom the services validation
156 * record is created
157 * @param p_previously_validated_flag {@rep:casecolumn
158 * PQH_FR_VALIDATIONS.PREVIOUSLY_VALIDATED_FLAG}
159 * @param p_request_date {@rep:casecolumn PQH_FR_VALIDATIONS.REQUEST_DATE}
160 * @param p_completion_date {@rep:casecolumn
161 * PQH_FR_VALIDATIONS.COMPLETION_DATE}
162 * @param p_previous_employer_id {@rep:casecolumn
163 * PQH_FR_VALIDATIONS.PREVIOUS_EMPLOYER_ID}
164 * @param p_status Identifies the status of the services validation process,
165 * for example, pre-process, accepted etc. Valid values are identified by
166 * lookup type 'FR_PQH_PROCESS_STATUS'
167 * @param p_employer_amount Amount of money contributed by the employer towards
168 * the pension fund of the employee
169 * @param p_employer_currency_code Currency in terms of which money was
170 * contributed by the employer towards the pension fund of the employee
171 * @param p_employee_amount Amount of money contributed by the employee towards
172 * his pension fund
173 * @param p_employee_currency_code Currency in terms of which money was
174 * contributed by the employee towards his pension fund
175 * @param p_deduction_per_period {@rep:casecolumn
179 * @param p_percent_of_salary Percent of the salary that is deducted from the
176 * PQH_FR_VALIDATIONS.DEDUCTION_PER_PERIOD}
177 * @param p_deduction_currency_code Currency in terms of which the employee pay
178 * is deducted per pay period
180 * employee pay per period to make contribution towards his pension fund
181 * @rep:displayname Update Validation
182 * @rep:category BUSINESS_ENTITY PQH_FR_SERVICES_VALIDATION
183 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
184 * @rep:scope public
185 * @rep:lifecycle active
186 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
187 */
188 --
189 -- {End Of Comments}
190 --
191 procedure Update_Validation
192 (p_effective_date in date
193 ,p_validation_id in number
194 ,p_object_version_number in out nocopy number
195 ,p_pension_fund_type_code in varchar2 default hr_api.g_varchar2
196 ,p_pension_fund_id in number default hr_api.g_number
197 ,p_business_group_id in number default hr_api.g_number
198 ,p_person_id in number default hr_api.g_number
199 ,p_previously_validated_flag in varchar2 default hr_api.g_varchar2
200 ,p_request_date in date default hr_api.g_date
201 ,p_completion_date in date default hr_api.g_date
202 ,p_previous_employer_id in number default hr_api.g_number
203 ,p_status in varchar2 default hr_api.g_varchar2
204 ,p_employer_amount in number default hr_api.g_number
205 ,p_employer_currency_code in varchar2 default hr_api.g_varchar2
206 ,p_employee_amount in number default hr_api.g_number
207 ,p_employee_currency_code in varchar2 default hr_api.g_varchar2
208 ,p_deduction_per_period in number default hr_api.g_number
209 ,p_deduction_currency_code in varchar2 default hr_api.g_varchar2
210 ,p_percent_of_salary in number default hr_api.g_number
211 );
212 --
213 -- ----------------------------------------------------------------------------
214 -- |----------------------------< delete_validation >-------------------------|
215 -- ----------------------------------------------------------------------------
216 --
217 -- {Start Of Comments}
218 /*#
219 * This API deletes a services validation record from the database.
220 *
221 * There must not be any service periods or validation events recorded for the
222 * services validation.
223 *
224 * <p><b>Licensing</b><br>
225 * This API is licensed for use with Human Resources.
226 *
227 * <p><b>Prerequisites</b><br>
228 * All the service period and validation event records corresponding to this
229 * services validation must have been deleted first.
230 *
231 * <p><b>Post Success</b><br>
235 * Services validation record is not deleted from the database and an error is
232 * Services validation record is deleted from the database.
233 *
234 * <p><b>Post Failure</b><br>
236 * raised
237 * @param p_validation_id {@rep:casecolumn PQH_FR_VALIDATIONS.VALIDATION_ID}
238 * @param p_object_version_number Current version number of the services
239 * validation record to be deleted
240 * @rep:displayname Delete Validation
241 * @rep:category BUSINESS_ENTITY PQH_FR_SERVICES_VALIDATION
242 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
243 * @rep:scope public
244 * @rep:lifecycle active
245 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
246 */
247 --
248 -- {End Of Comments}
249 --
250 Procedure Delete_Validation
251 (p_validation_id in number
252 ,p_object_version_number in number);
253 --
254 end PQH_FR_VALIDATIONS_API;
[Home] [Help]