1 Package pay_ie_prsi_api as
2 /* $Header: pysidapi.pkh 120.1 2005/10/02 02:34:20 aroussel $ */
3 /*#
4 * This package contains the PRSI Details API for Ireland.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname PRSI Detail for Ireland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_ie_prsi_details >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates PRSI details for Ireland.
17 *
18 * A PRSI Detail record is created for an assignment.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A PPS Number must exist for the person record.
25 *
26 * <p><b>Post Success</b><br>
27 * A PRSI Details record is created for the assignment.
28 *
29 * <p><b>Post Failure</b><br>
30 * No PRSI Details records are created and an error is raised.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Determines when the DateTrack operation comes into
35 * force.
36 * @param p_assignment_id Identifies the assignment for which you created the
37 * PRSI Details record.
38 * @param p_contribution_class Social Insurance Contribution Class.
39 * IE_PRSI_CONT_CLASS lookup.
40 * @param p_overridden_subclass Subclass manual override value for one pay
41 * period. IE_PRSI_CONT_SUBCLASS lookup.
42 * @param p_soc_ben_flag Social Benefits Flag to indicate if a benefit is being
43 * taken by the employee.
44 * @param p_soc_ben_start_date Date the Social Benefit started.
45 * @param p_overridden_ins_weeks Insurable Weeks manual override for one pay
46 * period.
47 * @param p_non_standard_ins_weeks Non Standard amount for Insurable Weeks for
48 * continous pay periods.
49 * @param p_exemption_start_date PRSI Exemption Start Date.
50 * @param p_exemption_end_date PRSI Exemption End Date.
51 * @param p_cert_issued_by Exemption Certificate Issued by.
52 * @param p_director_flag The employee is a Director.
53 * @param p_community_flag The employee is part of a Special Community
54 * exemption.
55 * @param p_prsi_details_id If p_validate is false, then this uniquely
56 * identifies the prsi details record created. If p_validate is true, then set
57 * to null.
58 * @param p_object_version_number If p_validate is false, then set to the
59 * version number of the created PRSI Details record. If p_validate is true,
60 * then the value will be null.
61 * @param p_effective_start_date If p_validate is false, then set to the
62 * earliest effective start date for the created PRSI Details record. If
63 * p_validate is true, then set to null.
64 * @param p_effective_end_date If p_validate is false, then set to the
65 * effective end date for the created PRSI Details record. If p_validate is
66 * true, then set to null.
67 * @rep:displayname Create PRSI Detail for Ireland
68 * @rep:category BUSINESS_ENTITY HR_SOC_INS_CONTRIBUTIONS
69 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
70 * @rep:scope public
71 * @rep:lifecycle active
72 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
73 */
74 --
75 -- {End Of Comments}
76 --
77 procedure create_ie_prsi_details
78 (p_validate in boolean default false
79 ,p_effective_date in date
80 ,p_assignment_id in number
81 ,p_contribution_class in varchar2
82 ,p_overridden_subclass in varchar2 default Null
83 ,p_soc_ben_flag in varchar2 default Null
84 ,p_soc_ben_start_date in date default Null
85 ,p_overridden_ins_weeks in number default Null
86 ,p_non_standard_ins_weeks in number default Null
87 ,p_exemption_start_date in date default Null
88 ,p_exemption_end_date in date default Null
89 ,p_cert_issued_by in varchar2 default Null
90 ,p_director_flag in varchar2 default Null
91 ,p_community_flag in varchar2 default Null
92 ,p_prsi_details_id out nocopy number
93 ,p_object_version_number out nocopy number
94 ,p_effective_start_date out nocopy date
95 ,p_effective_end_date out nocopy date
96 );
97 --
98 -- ----------------------------------------------------------------------------
99 -- |--------------------------< update_ie_prsi_details >----------------------|
100 -- ----------------------------------------------------------------------------
101 --
102 -- {Start Of Comments}
103 /*#
104 * This API updates PRSI details for Ireland.
105 *
106 * A PRSI Detail record is updated for an assignment.
107 *
108 * <p><b>Licensing</b><br>
109 * This API is licensed for use with Human Resources.
110 *
111 * <p><b>Prerequisites</b><br>
112 * p_prsi_details_id must exist at the time of the update for this assignment.
113 *
114 * <p><b>Post Success</b><br>
115 * A PRSI Details record is updated for the assignment.
116 *
117 * <p><b>Post Failure</b><br>
118 * No PRSI Details records are updated and an error is raised.
119 * @param p_validate If true, then validation alone will be performed and the
120 * database will remain unchanged. If false and all validation checks pass,
121 * then the database will be modified.
122 * @param p_effective_date Determines when the DateTrack operation comes into
123 * force.
124 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
125 * updating the record. You must set to either UPDATE, CORRECTION,
126 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
127 * particular record depend on the dates of previous record changes and the
128 * effective date of this change.
129 * @param p_prsi_details_id Identifies the prsi details record to be modified.
130 * @param p_contribution_class Social Insurance Contribution Class.
131 * IE_PRSI_CONT_CLASS lookup.
132 * @param p_overridden_subclass Subclass manual override value for one pay
133 * period. IE_PRSI_CONT_SUBCLASS lookup.
134 * @param p_soc_ben_flag Social Benefits Flag to indicate if a benefit is being
135 * taken by the employee.
136 * @param p_soc_ben_start_date Date the Socail Benefit started.
137 * @param p_overridden_ins_weeks Insurable Weeks manual override for one pay
138 * period.
139 * @param p_non_standard_ins_weeks Non Standard amount for Insurable Weeks for
140 * continous pay periods.
141 * @param p_exemption_start_date PRSI Exemption Start Date.
142 * @param p_exemption_end_date PRSI Exemption End Date.
143 * @param p_cert_issued_by Exemption Certificate Issued by.
144 * @param p_director_flag The employee is a Director.
145 * @param p_community_flag The employee is part of a Special Community
146 * exemption.
147 * @param p_object_version_number Pass in the current version number of the
148 * PRSI Details record to be updated. When the API completes if p_validate is
149 * false, will be set to the new version number of the updated PRSI Details
150 * record. If p_validate is true will be set to the same value which was passed
151 * in.
152 * @param p_effective_start_date If p_validate is false, then set to the
153 * effective start date on the updated PRSI Details row which now exists as of
154 * the effective date. If p_validate is true, then set to null.
155 * @param p_effective_end_date If p_validate is false, then set to the
156 * effective end date on the updated PRSI Details row which now exists as of
157 * the effective date. If p_validate is true, then set to null.
158 * @rep:displayname Update PRSI detail for Ireland
159 * @rep:category BUSINESS_ENTITY HR_SOC_INS_CONTRIBUTIONS
160 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
161 * @rep:scope public
162 * @rep:lifecycle active
163 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
164 */
165 --
166 -- {End Of Comments}
167 --
168 procedure update_ie_prsi_details
169 (p_validate in boolean default false
170 ,p_effective_date in date
171 ,p_datetrack_update_mode in varchar2
172 ,p_prsi_details_id in number
173 ,p_contribution_class in varchar2 default hr_api.g_varchar2
174 ,p_overridden_subclass in varchar2 default hr_api.g_varchar2
175 ,p_soc_ben_flag in varchar2 default hr_api.g_varchar2
176 ,p_soc_ben_start_date in date default hr_api.g_date
177 ,p_overridden_ins_weeks in number default hr_api.g_number
178 ,p_non_standard_ins_weeks in number default hr_api.g_number
179 ,p_exemption_start_date in date default hr_api.g_date
180 ,p_exemption_end_date in date default hr_api.g_date
181 ,p_cert_issued_by in varchar2 default hr_api.g_varchar2
182 ,p_director_flag in varchar2 default hr_api.g_varchar2
183 ,p_community_flag in varchar2 default hr_api.g_varchar2
184 ,p_object_version_number in out nocopy number
185 ,p_effective_start_date out nocopy date
186 ,p_effective_end_date out nocopy date
187 );
188 --
189 -- ----------------------------------------------------------------------------
190 -- |--------------------------< delete_ie_prsi_details >----------------------|
191 -- ----------------------------------------------------------------------------
192 --
193 -- {Start Of Comments}
194 /*#
195 * This API deletes PRSI details for Ireland.
196 *
197 * A PRSI Detail record is deleted for an assignment.
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 * p_prsi_details_id must exist at the time of the deletion for this
204 * assignment.
205 *
206 * <p><b>Post Success</b><br>
207 * A PRSI Details record is deleted for the assignment.
208 *
209 * <p><b>Post Failure</b><br>
210 * No PRSI Details records are deleted 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 Determines when the DateTrack operation comes into
215 * force.
216 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
217 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
218 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
219 * on the dates of previous record changes and the effective date of this
220 * change.
221 * @param p_prsi_details_id Identifies the prsi details record to be deleted.
222 * @param p_object_version_number Current version number of the PRSI Details
223 * record to be deleted.
224 * @param p_effective_start_date If p_validate is false, then set to the
225 * effective start date for the deleted PRSI Details row which now exists as of
226 * the effective date. If p_validate is true or all row instances have been
227 * deleted then set to null.
228 * @param p_effective_end_date If p_validate is false, then set to the
229 * effective end date for the deleted PRSI Details row which now exists as of
230 * the effective date. If p_validate is true or all row instances have been
231 * deleted then set to null.
232 * @rep:displayname Delete PRSI detail for Ireland
233 * @rep:category BUSINESS_ENTITY HR_SOC_INS_CONTRIBUTIONS
234 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
235 * @rep:scope public
236 * @rep:lifecycle active
237 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
238 */
239 --
240 -- {End Of Comments}
241 --
242 procedure delete_ie_prsi_details
243 (p_validate in boolean default false
244 ,p_effective_date in date
245 ,p_datetrack_delete_mode in varchar2
246 ,p_prsi_details_id in number
247 ,p_object_version_number in out nocopy number
248 ,p_effective_start_date out nocopy date
249 ,p_effective_end_date out nocopy date
250 );
251 --
252 end pay_ie_prsi_api;
[Home] [Help]