1 Package hr_salary_survey_mapping_api as
2 /* $Header: pessmapi.pkh 120.1 2005/10/02 02:24:45 aroussel $ */
3 /*#
4 * This package contains APIs to create and manage mappings of salary survey
5 * lines to current jobs and positions.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Salary Survey Mapping
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------------< create_mapping >--------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a new Salary Survey mapping.
18 *
19 * This API creates a new map between a salary survey line and an existing job
20 * or position in the organizaton.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * Position or Job must exist in the current organization. Also the salary
27 * survey line must represent a valid salary survey line setup for the
28 * organization.
29 *
30 * <p><b>Post Success</b><br>
31 * Salary survey mapping is created.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create a salary survey mapping and raises an error.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values,
39 * applicable within the active date range. This date does not determine when
40 * the changes take effect.
41 * @param p_business_group_id {@rep:casecolumn
42 * PER_SALARY_SURVEY_MAPPINGS.BUSINESS_GROUP_ID}
43 * @param p_parent_id Identifies the parent job or position in the parent
44 * table. Serves as a foreign key to either PER_JOBS or HR_ALL_POSITIONS_F
45 * @param p_parent_table_name {@rep:casecolumn
46 * PER_SALARY_SURVEY_MAPPINGS.PARENT_TABLE_NAME}
47 * @param p_salary_survey_line_id Identifies the parent survey line to which
48 * this mapping belongs. Serves as a foreign key to PER_SALARY_SURVEY_LINES.
49 * @param p_location_id Identifies the location. Serves as a foreign key to
50 * HR_LOCATIONS.
51 * @param p_grade_id Identifies the grade. Serves as a foreign key to
52 * PER_GRADES.
53 * @param p_company_organization_id Identifies the company organization. Serves
54 * as a foreign key to HR_ALL_ORGANIZATION_UNITS.
55 * @param p_company_age_code Code to indicate the age band in the company.
56 * Valid values identified by lookup type 'COMPANY_AGE'
57 * @param p_attribute_category This context value determines which flexfield
58 * structure to use with the descriptive flexfield segments.
59 * @param p_attribute1 Descriptive flexfield segment.
60 * @param p_attribute2 Descriptive flexfield segment.
61 * @param p_attribute3 Descriptive flexfield segment.
62 * @param p_attribute4 Descriptive flexfield segment.
63 * @param p_attribute5 Descriptive flexfield segment.
64 * @param p_attribute6 Descriptive flexfield segment.
65 * @param p_attribute7 Descriptive flexfield segment.
66 * @param p_attribute8 Descriptive flexfield segment.
67 * @param p_attribute9 Descriptive flexfield segment.
68 * @param p_attribute10 Descriptive flexfield segment.
69 * @param p_attribute11 Descriptive flexfield segment.
70 * @param p_attribute12 Descriptive flexfield segment.
71 * @param p_attribute13 Descriptive flexfield segment.
72 * @param p_attribute14 Descriptive flexfield segment.
73 * @param p_attribute15 Descriptive flexfield segment.
74 * @param p_attribute16 Descriptive flexfield segment.
75 * @param p_attribute17 Descriptive flexfield segment.
76 * @param p_attribute18 Descriptive flexfield segment.
77 * @param p_attribute19 Descriptive flexfield segment.
78 * @param p_attribute20 Descriptive flexfield segment.
79 * @param p_salary_survey_mapping_id If p_validate is false, uniquely
80 * identifies the newly created salary survey mapping. If p_validate is true,
81 * set to null.
82 * @param p_object_version_number If p_validate is false, then set to the
83 * version number of the created salary survey mapping. If p_validate is true,
84 * then the value will be null.
85 * @rep:displayname Create Salary Survey Mapping
86 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
87 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
88 * @rep:scope public
89 * @rep:lifecycle active
90 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
91 */
92 --
93 -- {End Of Comments}
94 --
95 procedure create_mapping
96 (p_validate in boolean default false
97 ,p_effective_date in date
98 ,p_business_group_id in number
99 ,p_parent_id in number
100 ,p_parent_table_name in varchar2
101 ,p_salary_survey_line_id in number
102 ,p_location_id in number default null
103 ,p_grade_id in number default null
104 ,p_company_organization_id in number default null
105 ,p_company_age_code in varchar2 default null
106 ,p_attribute_category in varchar2 default null
107 ,p_attribute1 in varchar2 default null
108 ,p_attribute2 in varchar2 default null
109 ,p_attribute3 in varchar2 default null
110 ,p_attribute4 in varchar2 default null
111 ,p_attribute5 in varchar2 default null
112 ,p_attribute6 in varchar2 default null
113 ,p_attribute7 in varchar2 default null
114 ,p_attribute8 in varchar2 default null
115 ,p_attribute9 in varchar2 default null
116 ,p_attribute10 in varchar2 default null
117 ,p_attribute11 in varchar2 default null
118 ,p_attribute12 in varchar2 default null
119 ,p_attribute13 in varchar2 default null
120 ,p_attribute14 in varchar2 default null
121 ,p_attribute15 in varchar2 default null
122 ,p_attribute16 in varchar2 default null
123 ,p_attribute17 in varchar2 default null
124 ,p_attribute18 in varchar2 default null
125 ,p_attribute19 in varchar2 default null
126 ,p_attribute20 in varchar2 default null
127 ,p_salary_survey_mapping_id out nocopy number
128 ,p_object_version_number out nocopy number
129 );
130 --
131 -- ----------------------------------------------------------------------------
132 -- |------------------------------< update_mapping >--------------------------|
133 -- ----------------------------------------------------------------------------
134 --
135 -- {Start Of Comments}
136 /*#
137 * API to update a existing mappings.
138 *
139 * A Salary Survey mapping links a salary survey line with a work structure
140 * object in your organization. This API allows you to update the object to
141 * which the survey line is linked, and other details related to the mapped
142 * object.
143 *
144 * <p><b>Licensing</b><br>
145 * This API is licensed for use with Human Resources.
146 *
147 * <p><b>Prerequisites</b><br>
148 * Survey mapping identified by the p_salary_survey_mapping_id must exist.
149 *
150 * <p><b>Post Success</b><br>
151 * Survey line mapped to the specified object.
152 *
153 * <p><b>Post Failure</b><br>
154 * The API does not update a salary survey mapping and raises an error.
155 * @param p_validate If true, then validation alone will be performed and the
156 * database will remain unchanged. If false and all validation checks pass,
157 * then the database will be modified.
158 * @param p_effective_date Reference date for validating lookup values,
159 * applicable within the active date range. This date does not determine when
160 * the changes take effect.
161 * @param p_location_id Identifies the location. Serves as a foreign key to
162 * HR_LOCATIONS.
163 * @param p_grade_id Identifies of the grade. Serves as a foreign key to
164 * PER_GRADES.
165 * @param p_company_organization_id Identifies the company oragnization. Serves
166 * as a foreign key to HR_ALL_ORGANIZATION_UNITS.
167 * @param p_company_age_code Code to indicate the age band in the company.
168 * Valid values identified by lookup type 'COMPANY_AGE'
169 * @param p_attribute_category This context value determines which flexfield
170 * structure to use with the descriptive flexfield segments.
171 * @param p_attribute1 Descriptive flexfield segment.
172 * @param p_attribute2 Descriptive flexfield segment.
173 * @param p_attribute3 Descriptive flexfield segment.
174 * @param p_attribute4 Descriptive flexfield segment.
175 * @param p_attribute5 Descriptive flexfield segment.
176 * @param p_attribute6 Descriptive flexfield segment.
177 * @param p_attribute7 Descriptive flexfield segment.
178 * @param p_attribute8 Descriptive flexfield segment.
179 * @param p_attribute9 Descriptive flexfield segment.
180 * @param p_attribute10 Descriptive flexfield segment.
181 * @param p_attribute11 Descriptive flexfield segment.
182 * @param p_attribute12 Descriptive flexfield segment.
183 * @param p_attribute13 Descriptive flexfield segment.
184 * @param p_attribute14 Descriptive flexfield segment.
185 * @param p_attribute15 Descriptive flexfield segment.
186 * @param p_attribute16 Descriptive flexfield segment.
187 * @param p_attribute17 Descriptive flexfield segment.
188 * @param p_attribute18 Descriptive flexfield segment.
189 * @param p_attribute19 Descriptive flexfield segment.
190 * @param p_attribute20 Descriptive flexfield segment.
191 * @param p_salary_survey_mapping_id Identifies the salary survey mapping on
192 * which the update has to be done.
193 * @param p_object_version_number Pass in the current version number of the
194 * salary survey mapping to be updated. When the API completes if p_validate is
195 * false, will be set to the new version number of the updated salary survey
196 * mapping. If p_validate is true will be set to the same value which was
197 * passed in.
198 * @rep:displayname Update Salary Survey Mapping
199 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
200 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
201 * @rep:scope public
202 * @rep:lifecycle active
203 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
204 */
205 --
206 -- {End Of Comments}
207 --
208 procedure update_mapping
209 (p_validate in boolean default false
210 ,p_effective_date in date
211 ,p_location_id in number
212 ,p_grade_id in number
213 ,p_company_organization_id in number
214 ,p_company_age_code in varchar2
215 ,p_attribute_category in varchar2
216 ,p_attribute1 in varchar2
217 ,p_attribute2 in varchar2
218 ,p_attribute3 in varchar2
219 ,p_attribute4 in varchar2
220 ,p_attribute5 in varchar2
221 ,p_attribute6 in varchar2
222 ,p_attribute7 in varchar2
223 ,p_attribute8 in varchar2
224 ,p_attribute9 in varchar2
225 ,p_attribute10 in varchar2
226 ,p_attribute11 in varchar2
227 ,p_attribute12 in varchar2
228 ,p_attribute13 in varchar2
229 ,p_attribute14 in varchar2
230 ,p_attribute15 in varchar2
231 ,p_attribute16 in varchar2
232 ,p_attribute17 in varchar2
233 ,p_attribute18 in varchar2
234 ,p_attribute19 in varchar2
235 ,p_attribute20 in varchar2
236 ,p_salary_survey_mapping_id in number
237 ,p_object_version_number in out nocopy number
238 );
239 --
240 -- ----------------------------------------------------------------------------
241 -- |------------------------------< delete_mapping >--------------------------|
242 -- ----------------------------------------------------------------------------
243 --
244 -- {Start Of Comments}
245 /*#
246 * API deletes the salary survey mapping identfied by the
247 * p_salary_survey_mapping_id.
248 *
249 * A Salary Survey Mapping links a salary survey line with a work structure
250 * object in your organization. This API allows you to delete the mapping
251 * between a survey line and the work structure object.
252 *
253 * <p><b>Licensing</b><br>
254 * This API is licensed for use with Human Resources.
255 *
256 * <p><b>Prerequisites</b><br>
257 * Survey mapping identified by the p_salary_survey_mapping_id must exist.
258 *
259 * <p><b>Post Success</b><br>
260 * The salary survey mapping row is deleted.
261 *
262 * <p><b>Post Failure</b><br>
263 * The Salary Survey Mapping row is not deleted, and an error is raised
264 * @param p_validate If true, then validation alone will be performed and the
265 * database will remain unchanged. If false and all validation checks pass,
266 * then the database will be modified.
267 * @param p_salary_survey_mapping_id Identifies a salary survey mapping to be
268 * deleted.
269 * @param p_object_version_number Current version number of the salary survey
270 * mapping to be deleted.
271 * @rep:displayname Delete Salary Survey Mapping
272 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
273 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
274 * @rep:scope public
275 * @rep:lifecycle active
276 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
277 */
278 --
279 -- {End Of Comments}
280 --
281 procedure delete_mapping
282 (p_validate in boolean default false
283 ,p_salary_survey_mapping_id in number
284 ,p_object_version_number in number
285 );
286 --
287 -- ----------------------------------------------------------------------------
288 -- |-------------------------------< mass_update >----------------------------|
289 -- ----------------------------------------------------------------------------
290 --
291 -- {Start Of Comments}
292 /*#
293 * This API does bulk creation of salary survey mappings.
294 *
295 * The API fetches all the salary survey mappings for a given entity
296 * (identified by position_id/job_id), then creates additional mappings for all
297 * those survey lines that have characteristics similar to the new object.
298 *
299 * <p><b>Licensing</b><br>
300 * This API is licensed for use with Human Resources.
301 *
302 * <p><b>Prerequisites</b><br>
303 * A parent job or parent position must exist. You pass its identifiers to the
304 * API.
305 *
306 * <p><b>Post Success</b><br>
307 * If p_validate is false, then new mapping rows are created if a given job or
308 * position has mappings, and the lines to which those mappings point have
309 * duplicate lines with different effective dates. If p_validate is true, then
310 * no new rows are created.
311 *
312 * <p><b>Post Failure</b><br>
313 * No new rows are created, and an error is raised.
314 * @param p_validate If true, then validation alone will be performed and the
315 * database will remain unchanged. If false and all validation checks pass,
316 * then the database will be modified.
317 * @param p_effective_date Reference date for validating lookup values,
318 * applicable within the active date range. This date does not determine when
319 * the changes take effect.
320 * @param p_business_group_id The business group for the mapping. Serves as a
321 * foreign key to HR_ALL_ORGANIZATIONS, identifying the business group.
322 * @param p_job_id Identifies the parent job in the parent table.
323 * @param p_position_id Identifies the parent position in the parent table.
324 * @rep:displayname Mass Update
325 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
326 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
327 * @rep:scope public
328 * @rep:lifecycle active
329 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
330 */
331 --
332 -- {End Of Comments}
333 --
334 procedure mass_update
335 (p_validate in boolean default false
336 ,p_effective_date in date
337 ,p_business_group_id in number
338 ,p_job_id in number default null
339 ,p_position_id in number default null
340 );
341 --
342 end hr_salary_survey_mapping_api;
[Home] [Help]