1 Package hr_salary_survey_api AUTHID CURRENT_USER as
2 /* $Header: pepssapi.pkh 120.1 2005/10/02 02:22:51 aroussel $ */
3 /*#
4 * This package contains APIs to create and maintain salary survey master
5 * details, namely create_salary_survey, update_salary_survey, and
6 * delete_salary_survey.
7 * @rep:scope public
8 * @rep:product per
9 * @rep:displayname Salary Survey
10 */
11 --
12 -- ----------------------------------------------------------------------------
13 -- |---------------------------< create_salary_survey >-----------------------|
14 -- ----------------------------------------------------------------------------
15 --
16 -- {Start Of Comments}
17 /*#
18 * This API creates a new Salary Survey.
19 *
20 * The API sets up a salary survey header with details such as Survey Name,
21 * Identifier, Survey Company, Survey Type, and so on.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * The list of companies providing the survey data must be set up in the lookup
28 * 'SURVEY_COMPANY'.
29 *
30 * <p><b>Post Success</b><br>
31 * A salary survey header record is created in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The Salary Survey is not created and an error is raised.
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_survey_name {@rep:casecolumn PER_SALARY_SURVEYS.SURVEY_NAME}
42 * @param p_survey_type_code The time basis for recording actual salary values,
39 * @param p_survey_company_code Company code that the survey applies to. Valid
40 * values are defined by 'SURVEY_COMPANY' lookup type.
41 * @param p_identifier {@rep:casecolumn PER_SALARY_SURVEYS.IDENTIFIER}
43 * such as Annual, Monthly, or Hourly. Valid values are identified by the
44 * 'PAY_BASIS' lookup type.
45 * @param p_base_region {@rep:casecolumn PER_SALARY_SURVEYS.BASE_REGION}
46 * @param p_effective_date Reference date for validating lookup values,
47 * applicable within the active date range. This date does not determine when
48 * the changes take effect.
49 * @param p_attribute_category This context value determines which flexfield
50 * structure to use with the descriptive flexfield segments.
51 * @param p_attribute1 Descriptive flexfield segment.
52 * @param p_attribute2 Descriptive flexfield segment.
53 * @param p_attribute3 Descriptive flexfield segment.
54 * @param p_attribute4 Descriptive flexfield segment.
55 * @param p_attribute5 Descriptive flexfield segment.
56 * @param p_attribute6 Descriptive flexfield segment.
57 * @param p_attribute7 Descriptive flexfield segment.
58 * @param p_attribute8 Descriptive flexfield segment.
59 * @param p_attribute9 Descriptive flexfield segment.
60 * @param p_attribute10 Descriptive flexfield segment.
61 * @param p_attribute11 Descriptive flexfield segment.
62 * @param p_attribute12 Descriptive flexfield segment.
63 * @param p_attribute13 Descriptive flexfield segment.
64 * @param p_attribute14 Descriptive flexfield segment.
65 * @param p_attribute15 Descriptive flexfield segment.
66 * @param p_attribute16 Descriptive flexfield segment.
67 * @param p_attribute17 Descriptive flexfield segment.
68 * @param p_attribute18 Descriptive flexfield segment.
69 * @param p_attribute19 Descriptive flexfield segment.
70 * @param p_attribute20 Descriptive flexfield segment.
71 * @param p_salary_survey_id If p_validate is false, uniquely identifies the
72 * survey created. If p_validate is true, set to null.
73 * @param p_object_version_number If p_validate is false, then set to the
74 * version number of the created Salary Survey. If p_validate is true, then the
75 * value will be null.
76 * @rep:displayname Create Salary Survey
77 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
78 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
79 * @rep:scope public
80 * @rep:lifecycle active
81 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
82 */
83 --
84 -- {End Of Comments}
85 --
86 procedure create_salary_survey
87 (p_validate in boolean default false
88 ,p_survey_name in varchar2
89 ,p_survey_company_code in varchar2
90 ,p_identifier in varchar2
91 --ras ,p_currency_code in varchar2
92 ,p_survey_type_code in varchar2
93 ,p_base_region in varchar2 default null
94 ,p_effective_date in date default null
95 ,p_attribute_category in varchar2 default null
96 ,p_attribute1 in varchar2 default null
97 ,p_attribute2 in varchar2 default null
98 ,p_attribute3 in varchar2 default null
99 ,p_attribute4 in varchar2 default null
100 ,p_attribute5 in varchar2 default null
101 ,p_attribute6 in varchar2 default null
102 ,p_attribute7 in varchar2 default null
103 ,p_attribute8 in varchar2 default null
104 ,p_attribute9 in varchar2 default null
105 ,p_attribute10 in varchar2 default null
106 ,p_attribute11 in varchar2 default null
107 ,p_attribute12 in varchar2 default null
108 ,p_attribute13 in varchar2 default null
109 ,p_attribute14 in varchar2 default null
110 ,p_attribute15 in varchar2 default null
111 ,p_attribute16 in varchar2 default null
112 ,p_attribute17 in varchar2 default null
113 ,p_attribute18 in varchar2 default null
114 ,p_attribute19 in varchar2 default null
115 ,p_attribute20 in varchar2 default null
116 ,p_salary_survey_id out nocopy number
117 ,p_object_version_number out nocopy number
118 );
119 --
120 -- ----------------------------------------------------------------------------
121 -- |---------------------------< update_salary_survey >-----------------------|
122 -- ----------------------------------------------------------------------------
123 --
124 -- {Start Of Comments}
125 /*#
126 * This API updates an existing Salary Survey header record.
127 *
128 * After updating the record, the API sets values for all the out parameters.
129 * If any validation check fails the process raises an error.
130 *
131 * <p><b>Licensing</b><br>
132 * This API is licensed for use with Human Resources.
133 *
134 * <p><b>Prerequisites</b><br>
135 * You must pass a salary_survey_id and object_version_number for an existing
136 * survey to the API.
137 *
138 * <p><b>Post Success</b><br>
139 * Salary survey header is updated with the details provided.
140 *
141 * <p><b>Post Failure</b><br>
142 * The Salary Survey will not be updated and an error is raised.
143 * @param p_validate If true, then validation alone will be performed and the
144 * database will remain unchanged. If false and all validation checks pass,
145 * then the database will be modified.
149 * 'PAY_BASIS' lookup type.
146 * @param p_survey_name {@rep:casecolumn PER_SALARY_SURVEYS.SURVEY_NAME}
147 * @param p_survey_type_code The time basis for recording actual salary values,
148 * such as Annual, Monthly, or Hourly. Valid values are identified by the
150 * @param p_base_region {@rep:casecolumn PER_SALARY_SURVEYS.BASE_REGION}
151 * @param p_effective_date Reference date for validating lookup values,
152 * applicable within the active date range. This date does not determine when
153 * the changes take effect.
154 * @param p_attribute_category This context value determines which flexfield
155 * structure to use with the descriptive flexfield segments.
156 * @param p_attribute1 Descriptive flexfield segment.
157 * @param p_attribute2 Descriptive flexfield segment.
158 * @param p_attribute3 Descriptive flexfield segment.
159 * @param p_attribute4 Descriptive flexfield segment.
160 * @param p_attribute5 Descriptive flexfield segment.
161 * @param p_attribute6 Descriptive flexfield segment.
162 * @param p_attribute7 Descriptive flexfield segment.
163 * @param p_attribute8 Descriptive flexfield segment.
164 * @param p_attribute9 Descriptive flexfield segment.
165 * @param p_attribute10 Descriptive flexfield segment.
166 * @param p_attribute11 Descriptive flexfield segment.
167 * @param p_attribute12 Descriptive flexfield segment.
168 * @param p_attribute13 Descriptive flexfield segment.
169 * @param p_attribute14 Descriptive flexfield segment.
170 * @param p_attribute15 Descriptive flexfield segment.
171 * @param p_attribute16 Descriptive flexfield segment.
172 * @param p_attribute17 Descriptive flexfield segment.
173 * @param p_attribute18 Descriptive flexfield segment.
174 * @param p_attribute19 Descriptive flexfield segment.
175 * @param p_attribute20 Descriptive flexfield segment.
176 * @param p_salary_survey_id Identifies the salary survey to be updated.
177 * @param p_object_version_number Pass in the current version number of the
178 * salary survey to be updated. When the API completes if p_validate is false,
179 * will be set to the new version number of the updated salary survey. If
180 * p_validate is true will be set to the same value which was passed in.
181 * @rep:displayname Update Salary Survey
182 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
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_salary_survey
192 (p_validate in boolean default false
193 ,p_survey_name in varchar2 default hr_api.g_varchar2
194 --ras ,p_currency_code in varchar2 default hr_api.g_varchar2
195 ,p_survey_type_code in varchar2 default hr_api.g_varchar2
196 ,p_base_region in varchar2 default hr_api.g_varchar2
197 ,p_effective_date in date default hr_api.g_date
198 ,p_attribute_category in varchar2 default hr_api.g_varchar2
199 ,p_attribute1 in varchar2 default hr_api.g_varchar2
200 ,p_attribute2 in varchar2 default hr_api.g_varchar2
201 ,p_attribute3 in varchar2 default hr_api.g_varchar2
202 ,p_attribute4 in varchar2 default hr_api.g_varchar2
203 ,p_attribute5 in varchar2 default hr_api.g_varchar2
204 ,p_attribute6 in varchar2 default hr_api.g_varchar2
205 ,p_attribute7 in varchar2 default hr_api.g_varchar2
206 ,p_attribute8 in varchar2 default hr_api.g_varchar2
207 ,p_attribute9 in varchar2 default hr_api.g_varchar2
208 ,p_attribute10 in varchar2 default hr_api.g_varchar2
209 ,p_attribute11 in varchar2 default hr_api.g_varchar2
210 ,p_attribute12 in varchar2 default hr_api.g_varchar2
211 ,p_attribute13 in varchar2 default hr_api.g_varchar2
212 ,p_attribute14 in varchar2 default hr_api.g_varchar2
213 ,p_attribute15 in varchar2 default hr_api.g_varchar2
214 ,p_attribute16 in varchar2 default hr_api.g_varchar2
215 ,p_attribute17 in varchar2 default hr_api.g_varchar2
216 ,p_attribute18 in varchar2 default hr_api.g_varchar2
217 ,p_attribute19 in varchar2 default hr_api.g_varchar2
218 ,p_attribute20 in varchar2 default hr_api.g_varchar2
219 ,p_salary_survey_id in number
220 ,p_object_version_number in out nocopy number
221 );
222 --
223 -- ----------------------------------------------------------------------------
224 -- |---------------------------< delete_salary_survey >-----------------------|
225 -- ----------------------------------------------------------------------------
226 --
227 -- {Start Of Comments}
228 /*#
229 * This API deletes a Salary Survey header.
230 *
231 * You can delete Salary Survey details only when there are no existing survey
232 * lines or mappings for the survey.
233 *
234 * <p><b>Licensing</b><br>
235 * This API is licensed for use with Human Resources.
236 *
237 * <p><b>Prerequisites</b><br>
238 * A salary_survey_id and object version number for a survey that exists must
239 * be passed to the API.
240 *
241 * <p><b>Post Success</b><br>
242 * The survey is deleted.
243 *
244 * <p><b>Post Failure</b><br>
245 * The Salary Survey is not deleted and an error is raised.
246 * @param p_validate If true, then validation alone will be performed and the
250 * @param p_object_version_number Current version number of the salary survey
247 * database will remain unchanged. If false and all validation checks pass,
248 * then the database will be modified.
249 * @param p_salary_survey_id Identifies the salary survey to be deleted.
251 * to be deleted.
252 * @rep:displayname Delete Salary Survey
253 * @rep:category BUSINESS_ENTITY PER_SALARY_SURVEY
254 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
255 * @rep:scope public
256 * @rep:lifecycle active
257 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
258 */
259 --
260 -- {End Of Comments}
261 --
262 procedure delete_salary_survey
263 (p_validate in boolean default false
264 ,p_salary_survey_id in number
265 ,p_object_version_number in number
266 );
267 --
268 end hr_salary_survey_api;
[Home] [Help]