1 Package PAY_INPUT_VALUE_API AUTHID CURRENT_USER as
2 /* $Header: pyivlapi.pkh 120.1 2005/10/02 02:31:57 aroussel $ */
3 /*#
4 * This package contains input value APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Input Value
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_input_value >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API is used to create an input value for an element type.
17 *
18 * The role of this process is to insert a fully validated row into the
19 * pay_input_values_f table of HR schema.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The element type specified by the in parameter p_element_type_id must
26 * already exist. The lookup type specified by the in parameter p_lookup_type
27 * must already exist. The formula specified by the in parameter p_formula_id
28 * must already exist. The value set specified by the in parameter
32 * The input value will have been successfully inserted into the database.
29 * p_value_set_id must already exist.
30 *
31 * <p><b>Post Success</b><br>
33 *
34 * <p><b>Post Failure</b><br>
35 * The input value will not be created and an error will be raised.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_effective_date Determines when the DateTrack operation comes into
40 * force.
41 * @param p_element_type_id {@rep:casecolumn
42 * PAY_ELEMENT_TYPES_F.ELEMENT_TYPE_ID}
43 * @param p_name {@rep:casecolumn PAY_INPUT_VALUES_F.NAME}
44 * @param p_uom {@rep:casecolumn PAY_INPUT_VALUES_F.UOM}
45 * @param p_lookup_type {@rep:casecolumn PAY_INPUT_VALUES_F.LOOKUP_TYPE}
46 * @param p_formula_id {@rep:casecolumn PAY_INPUT_VALUES_F.FORMULA_ID}
47 * @param p_value_set_id Identifier for the Value Set used for the validation
48 * @param p_display_sequence {@rep:casecolumn
49 * PAY_INPUT_VALUES_F.DISPLAY_SEQUENCE}
50 * @param p_generate_db_items_flag {@rep:casecolumn
51 * PAY_INPUT_VALUES_F.GENERATE_DB_ITEMS_FLAG}
52 * @param p_hot_default_flag {@rep:casecolumn
53 * PAY_INPUT_VALUES_F.HOT_DEFAULT_FLAG}
54 * @param p_mandatory_flag {@rep:casecolumn PAY_INPUT_VALUES_F.MANDATORY_FLAG}
55 * @param p_default_value {@rep:casecolumn PAY_INPUT_VALUES_F.DEFAULT_VALUE}
56 * @param p_max_value {@rep:casecolumn PAY_INPUT_VALUES_F.MAX_VALUE}
57 * @param p_min_value {@rep:casecolumn PAY_INPUT_VALUES_F.MIN_VALUE}
58 * @param p_warning_or_error {@rep:casecolumn
59 * PAY_INPUT_VALUES_F.WARNING_OR_ERROR}
60 * @param p_input_value_id If p_validate is false, then this uniquely
61 * identifies the input value created. If p_validate is true, then set to null.
62 * @param p_object_version_number If p_validate is false, then set to the
63 * version number of the created input value. If p_validate is true, then the
64 * value will be null.
65 * @param p_effective_start_date If p_validate is false, then set to the
66 * earliest effective start date for the created input value. If p_validate is
67 * true, then set to null.
68 * @param p_effective_end_date If p_validate is false, then set to the
69 * effective end date for the created input value. If p_validate is true, then
70 * set to null.
71 * @param p_default_val_warning If set to true, then the default value is
72 * outside the allowable range for this input value.
73 * @param p_min_max_warning If set to true, then the min value is greater than
74 * the max value for this input value.
75 * @param p_pay_basis_warning If set to true, then a salary basis is linked to
76 * this input value's element type.
77 * @param p_formula_warning If set to true, then formula validation for this
78 * input value's formula has failed.
79 * @param p_assignment_id_warning If set to true, then this input value's
80 * formula requires an ASSIGNMENT_ID input, which cannot be set at this level.
81 * @param p_formula_message If formula validation fails, then set to a
82 * user-defined error message for the formula, if one exists. Otherwise, set to
83 * null
84 * @rep:displayname Create Input Value for Element Type
85 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
86 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
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_INPUT_VALUE
96 ( P_VALIDATE in boolean Default false
97 ,P_EFFECTIVE_DATE in date
98 ,P_ELEMENT_TYPE_ID in number
99 ,P_NAME in varchar2
100 ,P_UOM in varchar2
101 ,P_LOOKUP_TYPE in varchar2 Default Null
102 ,P_FORMULA_ID in number Default Null
103 ,P_VALUE_SET_ID in number Default Null
104 ,P_DISPLAY_SEQUENCE in number Default Null
105 ,P_GENERATE_DB_ITEMS_FLAG in varchar2 Default 'N'
106 ,P_HOT_DEFAULT_FLAG in varchar2 Default 'N'
107 ,P_MANDATORY_FLAG in varchar2 Default 'N'
108 ,P_DEFAULT_VALUE in varchar2 Default Null
109 ,P_MAX_VALUE in varchar2 Default Null
110 ,P_MIN_VALUE in varchar2 Default Null
111 ,P_WARNING_OR_ERROR in varchar2 Default Null
112 ,P_INPUT_VALUE_ID OUT NOCOPY number
113 ,P_OBJECT_VERSION_NUMBER OUT NOCOPY number
114 ,P_EFFECTIVE_START_DATE OUT NOCOPY date
115 ,P_EFFECTIVE_END_DATE OUT NOCOPY date
116 ,P_DEFAULT_VAL_WARNING OUT NOCOPY boolean
117 ,P_MIN_MAX_WARNING OUT NOCOPY boolean
118 ,P_PAY_BASIS_WARNING OUT NOCOPY boolean
119 ,P_FORMULA_WARNING OUT NOCOPY boolean
120 ,P_ASSIGNMENT_ID_WARNING OUT NOCOPY boolean
121 ,P_FORMULA_MESSAGE OUT NOCOPY varchar2
122 );
123 --
124 -- ----------------------------------------------------------------------------
125 -- |----------------------------< update_input_value >------------------------|
126 -- ----------------------------------------------------------------------------
127 --
128 -- {Start Of Comments}
129 /*#
130 * This API is used to update an input value for an element type.
131 *
132 * The role of this process is to perform a validated, date-effective update of
133 * an existing row in the pay_input_values_f table of the HR schema.
134 *
135 * <p><b>Licensing</b><br>
136 * This API is licensed for use with Human Resources.
137 *
141 * specified by the in parameter p_lookup_type must already exist. The formula
138 * <p><b>Prerequisites</b><br>
139 * The input value as identified by the in parameter p_input_value_id and the
140 * in out parameter p_object_version_number must already exist. The lookup type
142 * specified by the in parameter p_formula_id must already exist. The value set
143 * specified by the in parameter p_value_set_id must already exist.
144 *
145 * <p><b>Post Success</b><br>
146 * The input value will have been successfully updated in the database.
147 *
148 * <p><b>Post Failure</b><br>
149 * The input value will not be updated and an error will be raised.
150 * @param p_validate If true, then validation alone will be performed and the
151 * database will remain unchanged. If false and all validation checks pass,
152 * then the database will be modified.
153 * @param p_effective_date Determines when the DateTrack operation comes into
154 * force.
155 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
156 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
157 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
158 * depend on the dates of previous record changes and the effective date of
159 * this change.
160 * @param p_input_value_id {@rep:casecolumn PAY_INPUT_VALUES_F.INPUT_VALUE_ID}
161 * @param p_object_version_number Pass in the current version number of the
162 * input value to be updated. When the API completes if p_validate is false,
163 * will be set to the new version number of the updated input value. If
164 * p_validate is true will be set to the same value which was passed in.
165 * @param p_name {@rep:casecolumn PAY_INPUT_VALUES_F.NAME}
166 * @param p_uom {@rep:casecolumn PAY_INPUT_VALUES_F.UOM}
167 * @param p_lookup_type Lookup Type used for the valdiation
168 * @param p_formula_id {@rep:casecolumn PAY_INPUT_VALUES_F.FORMULA_ID}
169 * @param p_value_set_id Identifier for the Value Set used for the validation
170 * @param p_display_sequence {@rep:casecolumn
171 * PAY_INPUT_VALUES_F.DISPLAY_SEQUENCE}
172 * @param p_generate_db_items_flag {@rep:casecolumn
173 * PAY_INPUT_VALUES_F.GENERATE_DB_ITEMS_FLAG}
174 * @param p_hot_default_flag {@rep:casecolumn
175 * PAY_INPUT_VALUES_F.HOT_DEFAULT_FLAG}
176 * @param p_mandatory_flag {@rep:casecolumn PAY_INPUT_VALUES_F.MANDATORY_FLAG}
177 * @param p_default_value {@rep:casecolumn PAY_INPUT_VALUES_F.DEFAULT_VALUE}
178 * @param p_max_value {@rep:casecolumn PAY_INPUT_VALUES_F.MAX_VALUE}
179 * @param p_min_value {@rep:casecolumn PAY_INPUT_VALUES_F.MIN_VALUE}
180 * @param p_warning_or_error {@rep:casecolumn
181 * PAY_INPUT_VALUES_F.WARNING_OR_ERROR}
182 * @param p_effective_start_date If p_validate is false, then set to the
183 * effective start date on the updated input value row which now exists as of
184 * the effective date. If p_validate is true, then set to null.
185 * @param p_effective_end_date If p_validate is false, then set to the
186 * effective end date on the updated input value row which now exists as of the
187 * effective date. If p_validate is true, then set to null.
188 * @param p_default_val_warning If set to true, then the default value is
189 * outside the allowable range for this input value.
190 * @param p_min_max_warning If set to true, then the min value is greater than
191 * the max value for this input value.
192 * @param p_link_inp_val_warning If set to true, then either the default value,
193 * lookup type, min value, max value or warning or error value has changed for
194 * this input value.
195 * @param p_pay_basis_warning If set to true, then this input value is used in
196 * a salary basis for the element.
197 * @param p_formula_warning If set to true, then formula validation for this
198 * input value's default value has failed.
199 * @param p_assignment_id_warning If set to true, then this input value's
200 * formula requires an ASSIGNMENT_ID input, which cannot be set at this level.
201 * @param p_formula_message If formula validation fails, then set to a
202 * user-defined error message for the formula, if one exists. Otherwise, set to
203 * null
204 * @rep:displayname Update Input Value for Element Type
205 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
206 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
207 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
208 * @rep:scope public
209 * @rep:lifecycle active
210 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
211 */
212 --
213 -- {End Of Comments}
214 --
215 procedure UPDATE_INPUT_VALUE
216 ( P_VALIDATE IN boolean Default false
217 ,P_EFFECTIVE_DATE IN date
218 ,P_DATETRACK_MODE IN varchar2
219 ,P_INPUT_VALUE_ID IN number
220 ,P_OBJECT_VERSION_NUMBER IN OUT NOCOPY number
221 ,P_NAME IN varchar2 Default hr_api.g_varchar2
222 ,P_UOM IN varchar2 Default hr_api.g_varchar2
223 ,P_LOOKUP_TYPE IN varchar2 Default hr_api.g_varchar2
224 ,P_FORMULA_ID IN number Default hr_api.g_number
225 ,P_VALUE_SET_ID IN number Default hr_api.g_number
226 ,P_DISPLAY_SEQUENCE IN number Default hr_api.g_number
227 ,P_GENERATE_DB_ITEMS_FLAG IN varchar2 Default hr_api.g_varchar2
228 ,P_HOT_DEFAULT_FLAG IN varchar2 Default hr_api.g_varchar2
229 ,P_MANDATORY_FLAG IN varchar2 Default hr_api.g_varchar2
230 ,P_DEFAULT_VALUE IN varchar2 Default hr_api.g_varchar2
231 ,P_MAX_VALUE IN varchar2 Default hr_api.g_varchar2
232 ,P_MIN_VALUE IN varchar2 Default hr_api.g_varchar2
233 ,P_WARNING_OR_ERROR IN varchar2 Default hr_api.g_varchar2
234 ,P_EFFECTIVE_START_DATE OUT NOCOPY date
235 ,P_EFFECTIVE_END_DATE OUT NOCOPY date
236 ,P_DEFAULT_VAL_WARNING OUT NOCOPY boolean
237 ,P_MIN_MAX_WARNING OUT NOCOPY boolean
238 ,P_LINK_INP_VAL_WARNING OUT NOCOPY boolean
239 ,P_PAY_BASIS_WARNING OUT NOCOPY boolean
240 ,P_FORMULA_WARNING OUT NOCOPY boolean
241 ,P_ASSIGNMENT_ID_WARNING OUT NOCOPY boolean
242 ,P_FORMULA_MESSAGE OUT NOCOPY varchar2
243 );
244 --
245 -- ----------------------------------------------------------------------------
246 -- |----------------------------< delete_input_value >------------------------|
247 -- ----------------------------------------------------------------------------
248 --
249 -- {Start Of Comments}
250 /*#
251 * This API is used to delete an input value for an element type.
252 *
253 * The role of this process is to perform a validated, date-effective delete of
254 * an existing row from the pay_input_values_f table of the HR schema.
255 *
256 * <p><b>Licensing</b><br>
257 * This API is licensed for use with Human Resources.
258 *
259 * <p><b>Prerequisites</b><br>
260 * The input value as identified by the in parameter p_input_value_id and the
261 * in out parameter p_object_version_number must already exist.
262 *
263 * <p><b>Post Success</b><br>
264 * The input value will have been successfully removed from the database.
265 *
266 * <p><b>Post Failure</b><br>
267 * The input value will not be deleted and an error will be raised.
268 * @param p_validate If true, then validation alone will be performed and the
269 * database will remain unchanged. If false and all validation checks pass,
270 * then the database will be modified.
271 * @param p_effective_date Determines when the DateTrack operation comes into
272 * force.
273 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
274 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
275 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
276 * on the dates of previous record changes and the effective date of this
277 * change.
278 * @param p_input_value_id {@rep:casecolumn PAY_INPUT_VALUES_F.INPUT_VALUE_ID}
279 * @param p_object_version_number Pass in the current version number of the
280 * input value to be deleted. When the API completes if p_validate is false,
281 * will be set to the new version number of the deleted input value. If
282 * p_validate is true will be set to the same value which was passed in.
283 * @param p_effective_start_date If p_validate is false, then set to the
284 * effective start date for the deleted input value row which now exists as of
285 * the effective date. If p_validate is true or all row instances have been
286 * deleted then set to null.
287 * @param p_effective_end_date If p_validate is false, then set to the
288 * effective end date for the deleted input value row which now exists as of
289 * the effective date. If p_validate is true or all row instances have been
290 * deleted then set to null.
291 * @param p_balance_feeds_warning If set to true, then balance feeds have been
292 * deleted.
293 * @rep:displayname Delete Input Value for Element Type
294 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
295 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
296 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
297 * @rep:scope public
298 * @rep:lifecycle active
299 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
300 */
301 --
302 -- {End Of Comments}
303 --
304 procedure DELETE_INPUT_VALUE
305 ( P_VALIDATE IN boolean default false
306 ,P_EFFECTIVE_DATE IN date
307 ,P_DATETRACK_DELETE_MODE IN varchar2
308 ,P_INPUT_VALUE_ID IN number
309 ,P_OBJECT_VERSION_NUMBER IN OUT NOCOPY number
310 ,P_EFFECTIVE_START_DATE OUT NOCOPY date
311 ,P_EFFECTIVE_END_DATE OUT NOCOPY date
312 ,P_BALANCE_FEEDS_WARNING OUT NOCOPY boolean
313 );
314 --
315 end PAY_INPUT_VALUE_API;
[Home] [Help]