1 Package pay_user_row_api AUTHID CURRENT_USER as
5 * @rep:scope public
2 /* $Header: pypurapi.pkh 120.8 2008/04/08 11:33:43 salogana noship $ */
3 /*#
4 * This package contains user row APIs.
6 * @rep:product per
7 * @rep:displayname User Row
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_user_row >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API inserts a user row record.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A valid user table identified by p_user_table_id must exist. The
24 * p_business_group_id and p_legislation_code for this row must be consistent
25 * with the parent row identified by p_user_table_id.
26 *
27 * <p><b>Post Success</b><br>
28 * The user row will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The user row will not be created and an error will be raised.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Determines when the DateTrack operation comes into
36 * force.
37 * @param p_user_table_id Primary Key for User Table.
38 * @param p_row_low_range_or_name Lower value for range match of user key, or
39 * actual value for exact match.
40 * @param p_display_sequence Used for ordering the User Rows. If p_validate is
41 * false, this will be set to the display sequence of the user row created. If
42 * p_validate is true this will be set to the value passed in.
43 * @param p_business_group_id The user row's business group.
44 * @param p_legislation_code The user row's legislation.
45 * @param p_disable_range_overlap_check Applicable only to the product GHR. If
46 * false and GHR is installed, then rows that have overlapping values of
47 * row_low_range_or_name and row_high_range are not allowed. Defaults to false.
48 * @param p_disable_units_check If false, then the value of
49 * row_low_range_or_name will be checked against the units in the user table.
50 * Defaults to false.
51 * @param p_row_high_range Upper value for the range match of the user row.
52 * @param p_user_row_id If p_validate is false, this uniquely identifies the
53 * user row created. If p_validate is true this parameter will be null.
54 * @param p_object_version_number If p_validate is false, then set to the
55 * version number of the created user row. If p_validate is true, then the
56 * value will be null.
57 * @param p_effective_start_date If p_validate is false, then set to the
58 * earliest effective start date for the created user row. If p_validate is
59 * true, then set to null.
60 * @param p_effective_end_date If p_validate is false, then set to the earliest
61 * effective start date for the created user row. If p_validate is true, then
62 * set to null.
63 * @rep:displayname Create User Row
64 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
65 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
66 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
67 * @rep:scope public
68 * @rep:lifecycle active
69 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
70 */
71 --
72 -- {End Of Comments}
73 --
74 procedure create_user_row
75 (p_validate in boolean default false
76 ,p_effective_date in date
77 ,p_user_table_id in number
78 ,p_row_low_range_or_name in varchar2
79 ,p_display_sequence in out nocopy NUMBER
80 ,p_business_group_id in number default null
81 ,p_legislation_code in varchar2 default null
82 ,p_disable_range_overlap_check in boolean default false
83 ,p_disable_units_check in boolean default false
84 ,p_row_high_range in varchar2 default null
85 ,p_user_row_id out nocopy number
86 ,p_object_version_number out nocopy number
87 ,p_effective_start_date out nocopy date
88 ,p_effective_end_date out nocopy date
89 );
90 --
91 -- ---------------------------------------------------------------------------
92 -- |-----------------------------< create_user_row >-------------------------|
93 -- ---------------------------------------------------------------------------
94 --
95 -- {Start Of Comments}
96 /*#
97 * This API inserts a user row record.
98 *
99 *
100 * <p><b>Licensing</b><br>
101 * This API is licensed for use with Human Resources.
102 *
103 * <p><b>Prerequisites</b><br>
104 * A valid user table identified by p_user_table_id must exist. The
105 * p_business_group_id and p_legislation_code for this row must be consistent
106 * with the parent row identified by p_user_table_id.
107 *
108 * <p><b>Post Success</b><br>
109 * The user row will be successfully inserted into the database.
110 *
111 * <p><b>Post Failure</b><br>
112 * The user row will not be created and an error will be raised.
113 * @param p_validate If true, then validation alone will be performed and the
114 * database will remain unchanged. If false and all validation checks pass,
115 * then the database will be modified.
116 * @param p_effective_date Determines when the DateTrack operation comes into
117 * force.
118 * @param p_user_table_id Primary Key for User Table.
119 * @param p_row_low_range_or_name Lower value for range match of user key, or
120 * actual value for exact match.
121 * @param p_base_row_low_range_or_name Max value for range match of user key, or
122 * actual value for user row key.
123 * @param p_display_sequence Used for ordering the User Rows. If p_validate is
124 * false, this will be set to the display sequence of the user row created. If
125 * p_validate is true this will be set to the value passed in.
126 * @param p_business_group_id The user row's business group.
127 * @param p_legislation_code The user row's legislation.
128 * @param p_disable_range_overlap_check Applicable only to the product GHR. If
129 * false and GHR is installed, then rows that have overlapping values of
130 * row_low_range_or_name and row_high_range are not allowed. Defaults to false.
131 * @param p_disable_units_check If false, then the value of
132 * row_low_range_or_name will be checked against the units in the user table.
133 * Defaults to false.
134 * @param p_row_high_range Upper value for the range match of the user row.
135 * @param p_user_row_id If p_validate is false, this uniquely identifies the
136 * user row created. If p_validate is true this parameter will be null.
137 * @param p_object_version_number If p_validate is false, then set to the
138 * version number of the created user row. If p_validate is true, then the
139 * value will be null.
140 * @param p_effective_start_date If p_validate is false, then set to the
141 * earliest effective start date for the created user row. If p_validate is
142 * true, then set to null.
143 * @param p_effective_end_date If p_validate is false, then set to the earliest
144 * effective start date for the created user row. If p_validate is true, then
145 * set to null.
146 * @rep:displayname Create User Row
147 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
148 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
149 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
150 * @rep:scope public
151 * @rep:primaryinstance
152 * @rep:lifecycle active
153 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
154 */
155 --
156 -- {End Of Comments}
157 --
158 procedure create_user_row
159 (p_validate in boolean default false
160 ,p_effective_date in date
161 ,p_user_table_id in number
162 ,p_row_low_range_or_name in varchar2
163 ,p_display_sequence in out nocopy NUMBER
164 ,p_business_group_id in number default null
165 ,p_legislation_code in varchar2 default null
166 ,p_disable_range_overlap_check in boolean default false
167 ,p_disable_units_check in boolean default false
168 ,p_row_high_range in varchar2 default null
169 ,p_user_row_id out nocopy number
170 ,p_object_version_number out nocopy number
171 ,p_effective_start_date out nocopy date
172 ,p_effective_end_date out nocopy date
173 /* Added for bug fix 6735596 */
174 ,p_base_row_low_range_or_name in varchar2
175 );
176 --
177 -- ----------------------------------------------------------------------------
178 -- |-----------------------------< update_user_row >--------------------------|
179 -- ----------------------------------------------------------------------------
180 --
181 -- {Start Of Comments}
182 /*#
183 * This API updates a user row record.
184 *
185 *
186 * <p><b>Licensing</b><br>
187 * This API is licensed for use with Human Resources.
188 *
189 * <p><b>Prerequisites</b><br>
190 * A valid user row identified by p_user_row_id and p_object_version_number
191 * must exist.
192 *
193 * <p><b>Post Success</b><br>
194 * The user row will be successfully updated into the database.
195 *
196 * <p><b>Post Failure</b><br>
197 * The user row will not be updated and an error will be raised.
198 * @param p_validate If true, then validation alone will be performed and the
199 * database will remain unchanged. If false and all validation checks pass,
200 * then the database will be modified.
201 * @param p_effective_date Determines when the DateTrack operation comes into
202 * force.
203 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
204 * updating the record. You must set to either UPDATE, CORRECTION,
205 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
206 * particular record depend on the dates of previous record changes and the
207 * effective date of this change.
208 * @param p_user_row_id Unique identifier of the user row.
209 * @param p_display_sequence Used for ordering the User Rows. If p_validate is
210 * false, this will be set to the display sequence of the user row updated. If
211 * p_validate is true this will be set to the value passed in.
212 * @param p_object_version_number Pass in the current version number of the
213 * user row to be updated. When the API completes if p_validate is false, will
214 * be set to the new version number of the updated user row. If p_validate is
215 * true will be set to the same value which was passed in.
216 * @param p_row_low_range_or_name Lower value for range match of user key, or
217 * actual value for exact match.
218 * @param p_base_row_low_range_or_name Base lower value for range match of
219 * user key, or actual value for exact match.
220 * @param p_disable_range_overlap_check Applicable only to the product GHR. If
221 * false and GHR is installed, then rows that have overlapping values of
222 * row_low_range_or_name and row_high_range are not allowed. Defaults to false.
223 * @param p_disable_units_check If false, then the value of
224 * row_low_range_or_name will be checked against the units in the user table.
225 * Defaults to false.
226 * @param p_row_high_range Upper value for the range match of the user row.
227 * @param p_effective_start_date If p_validate is false, then set to the
228 * effective start date on the updated User Row which now exists as of the
229 * effective date. If p_validate is true, then set to null.
230 * @param p_effective_end_date If p_validate is false, then set to the
231 * effective end date on the updated User Row which now exists as of the
232 * effective date. If p_validate is true, then set to null.
233 * @rep:displayname Update User Row
234 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
235 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
236 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
237 * @rep:scope public
238 * @rep:lifecycle active
239 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
240 */
241 --
242 -- {End Of Comments}
243 --
244 procedure update_user_row
245 (p_validate in boolean default false
246 ,p_effective_date in date
247 ,p_datetrack_update_mode in varchar2
248 ,p_user_row_id in number
249 ,p_display_sequence in out nocopy number
250 ,p_object_version_number in out nocopy number
251 ,p_row_low_range_or_name in varchar2 default hr_api.g_varchar2
252 ,p_base_row_low_range_or_name in varchar2 default hr_api.g_varchar2
253 ,p_disable_range_overlap_check in boolean default false
254 ,p_disable_units_check in boolean default false
255 ,p_row_high_range in varchar2 default hr_api.g_varchar2
256 ,p_effective_start_date out nocopy date
257 ,p_effective_end_date out nocopy date
258 );
259 --
260 -- ----------------------------------------------------------------------------
261 -- |-----------------------------< delete_user_row >--------------------------|
262 -- ----------------------------------------------------------------------------
263 --
264 -- {Start Of Comments}
265 /*#
266 * This API deletes a user row record.
267 *
268 *
269 * <p><b>Licensing</b><br>
270 * This API is licensed for use with Human Resources.
271 *
272 * <p><b>Prerequisites</b><br>
273 * A valid user row identified by p_user_row_id and p_object_version_number
274 * must exist.
275 *
276 * <p><b>Post Success</b><br>
277 * The user row will be successfully deleted from the database.
278 *
279 * <p><b>Post Failure</b><br>
280 * The user row will not be deleted and an error will be raised.
281 * @param p_validate If true, then validation alone will be performed and the
282 * database will remain unchanged. If false and all validation checks pass,
283 * then the database will be modified.
284 * @param p_effective_date Determines when the DateTrack operation comes into
285 * force.
286 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
287 * updating the record. You must set to either UPDATE, CORRECTION,
288 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
289 * particular record depend on the dates of previous record changes and the
290 * effective date of this change.
291 * @param p_user_row_id Unique identifier of the user row.
292 * @param p_object_version_number Pass in the current version number of the
293 * user row to be deleted. When the API completes if p_validate is false, will
294 * be set to the new version number of the deleted user row. If p_validate is
295 * true will be set to the same value which was passed in.
296 * @param p_disable_range_overlap_check Applicable only to the product GHR. If
297 * false and GHR is installed, then rows that have overlapping values of
298 * row_low_range_or_name and row_high_range are not allowed. Defaults to false.
299 * @param p_effective_start_date If p_validate is false, then set to the
300 * effective start date for the deleted User Row which now exists as of the
301 * effective date. If p_validate is true or all row instances have been deleted
302 * then set to null.
303 * @param p_effective_end_date If p_validate is false, then set to the
304 * effective end date for the deleted User Row which now exists as of the
305 * effective date. If p_validate is true or all row instances have been deleted
306 * then set to null.
307 * @rep:displayname Delete User Row
308 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
309 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
310 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
311 * @rep:scope public
312 * @rep:lifecycle active
313 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
314 */
315 --
316 -- {End Of Comments}
317 --
318 procedure delete_user_row
319 (p_validate in boolean default false
320 ,p_effective_date in date
321 ,p_datetrack_update_mode in varchar2
322 ,p_user_row_id in number
323 ,p_object_version_number in out nocopy number
324 ,p_disable_range_overlap_check in boolean default false
325 ,p_effective_start_date out nocopy date
326 ,p_effective_end_date out nocopy date
327 );
328
329 --
330 end pay_user_row_api;
[Home] [Help]