1 Package PQH_RT_MATRIX_NODE_VALUES_API as
2 /* $Header: pqrmvapi.pkh 120.6 2006/03/14 11:28:14 srajakum noship $ */
3 /*#
4 * This package contains rate matrix node value APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Rate matrix node value
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_rt_matrix_node_value >-----------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 /*#
15 * This API creates a new rate matrix node value.
16 *
17 * More than one rate matrix node value can be associated with the same rate
18 * matrix node.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources and HR Foundation.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The rate matrix node for which the node value is created must already
25 * exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The rate matrix node value is created.
29 *
30 * <p><b>Post Failure</b><br>
31 * The rate matrix node value is not created and error is raised.
32 *
33 * @param p_validate If true, then validation alone will be performed and
34 * the database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Reference date for validating lookup values are
37 * effective during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_node_value_id If p_validate is false, then this uniquely
40 * identifies the rate matrix node value created. If p_validate is true, then
41 * set to null.
42 * @param p_rate_matrix_node_id Identifies the rate matrix node to which
43 * the node value is associated.
44 * @param p_short_code Unique short code.
45 * @param p_char_value1 Contains character value. If the criteria takes a
46 * range of values, it stores the start of the range. Otherwise it stores
47 * the criteria value.
48 * @param p_char_value2 Contains character value. If the criteria takes a
49 * range of values, it stores the end value of the range. Otherwise, it contains
50 * null.
51 * @param p_char_value3 Contains character value. A value will be stored in
52 * this field only if the criteria associated with the rate matrix node has two
53 * subcriteria. If the criteria takes a range of values this column stores the
54 * start value of the range. Otherwise, it contains null.
55 * @param p_char_value4 Contains character value. A value will be stored in
56 * this field only if the criteria associated with the rate matrix node has two
57 * subcriteria. If the criteria takes a range of values this column stores the
58 * end value of the range. Otherwise, it contains null.
59 * @param p_number_value1 Contains number value. If the criteria takes a
60 * range of values, it stores the start of the range. Otherwise it stores
61 * the criteria value.
62 * @param p_number_value2 Contains number value. If the criteria takes a
63 * range of values, it stores the end value of the range. Otherwise, it contains
64 * null.
65 * @param p_number_value3 Contains number value. A value will be stored in
66 * this field only if the criteria associated with the rate matrix node has two
67 * subcriteria. If the criteria takes a range of values this column stores the
68 * start value of the range, otherwise it contains null.
69 * @param p_number_value4 Contains number value. A value will be stored in
70 * this field only if the criteria associated with the rate matrix node has two
71 * subcriteria. If the criteria takes a range of values this column stores the
72 * end value of the range, otherwise it contains null.
73 * @param p_date_value1 Contains date value. If the criteria takes a
74 * range of values, it stores the start of the range. Otherwise it stores
75 * the criteria value.
76 * @param p_date_value2 Contains date value. If the criteria takes a
77 * range of values, it stores the end value of the range. Otherwise, it contains
78 * null.
79 * @param p_date_value3 Contains date value. A value will be stored in
80 * this field only if the criteria associated with the rate matrix node has two
81 * subcriteria. If the criteria takes a range of values this column stores the
82 * start value of the range, otherwise it contains null.
83 * @param p_date_value4 Contains date value. A value will be stored in
84 * this field only if the criteria associated with the rate matrix node has two
85 * subcriteria. If the criteria takes a range of values this column stores the
86 * end value of the range, otherwise it contains null.
87 * @param p_business_group_id Business group of the current rate matrix
88 * node value.
89 * @param p_legislation_code Legislation code of the current rate matrix
90 * node value.
91 * @param p_object_version_number If p_validate is false, then set to
92 * the version number of the created rate matrix node value. If p_validate
93 * is true, then the value will be null.
94 * @rep:displayname Create rate matrix node value
95 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
96 * @rep:lifecycle active
97 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
98 * @rep:scope public
99 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
100 */
101 --
102 -- {End Of Comments}
103 --
104 procedure create_rt_matrix_node_value
105 (p_validate in boolean default false
106 ,p_effective_date in date
107 ,p_NODE_VALUE_ID out nocopy number
108 ,p_RATE_MATRIX_NODE_ID in number
109 ,p_SHORT_CODE in varchar2
110 ,p_CHAR_VALUE1 in varchar2 default null
111 ,p_CHAR_VALUE2 in varchar2 default null
112 ,p_CHAR_VALUE3 in varchar2 default null
113 ,p_CHAR_VALUE4 in varchar2 default null
114 ,p_NUMBER_VALUE1 in number default null
115 ,p_NUMBER_VALUE2 in number default null
116 ,p_NUMBER_VALUE3 in number default null
117 ,p_NUMBER_VALUE4 in number default null
118 ,p_DATE_VALUE1 in date default null
119 ,p_DATE_VALUE2 in date default null
120 ,p_DATE_VALUE3 in date default null
121 ,p_DATE_VALUE4 in date default null
122 ,p_BUSINESS_GROUP_ID in number default null
123 ,p_LEGISLATION_CODE in varchar2 default null
124 ,p_object_version_number out nocopy number
125 );
126 --
127 -- ----------------------------------------------------------------------------
128 -- |-----------------------< update_rt_matrix_node_value >---------------------|
129 -- ----------------------------------------------------------------------------
130 -- {Start Of Comments}
131 --
132 /*#
133 * This API updates a rate matrix node value.
134 *
135 * More than one rate matrix node value can be associated with the same rate
136 * matrix node.
137 *
138 * <p><b>Licensing</b><br>
139 * This API is licensed for use with Human Resources and HR Foundation.
140 *
141 * <p><b>Prerequisites</b><br>
142 * The rate matrix node for which the node value is created must already
143 * exist.
144 *
145 * <p><b>Post Success</b><br>
146 * The rate matrix node value details are successfully updated.
147 *
148 * <p><b>Post Failure</b><br>
149 * The rate matrix node value details will not be updated and error is raised.
150 *
151 * @param p_validate If true, then validation alone will be performed and
152 * the database will remain unchanged. If false and all validation checks pass,
153 * then the database will be modified.
154 * @param p_effective_date Reference date for validating lookup
155 * values are effective during the start to end active date range. This date does not
156 * determine when the changes take effect.
157 * @param p_node_value_id Identifies the rate matrix node value
158 * record to be modified.
159 * @param p_rate_matrix_node_id Identifies the rate matrix node to which
160 * the node value is associated.
161 * @param p_short_code Unique short code.
162 * @param p_char_value1 Contains character value. If the criteria takes a
163 * range of values, it stores the start of the range. Otherwise it stores
164 * the criteria value.
165 * @param p_char_value2 Contains character value. If the criteria takes a
166 * range of values, it stores the end value of the range. Otherwise, it contains
167 * null.
168 * @param p_char_value3 Contains character value. A value will be stored in
169 * this field only if the criteria associated with the rate matrix node has two
170 * subcriteria. If the criteria takes a range of values this column stores the
171 * start value of the range. Otherwise, it contains null.
172 * @param p_char_value4 Contains character value. A value will be stored in
173 * this field only if the criteria associated with the rate matrix node has two
174 * subcriteria. If the criteria takes a range of values this column stores the
175 * end value of the range. Otherwise, it contains null.
176 * @param p_number_value1 Contains number value. If the criteria takes a
177 * range of values, it stores the start of the range. Otherwise it stores
178 * the criteria value.
179 * @param p_number_value2 Contains number value. If the criteria takes a
180 * range of values, it stores the end value of the range. Otherwise, it contains
181 * null.
182 * @param p_number_value3 Contains number value. A value will be stored in
183 * this field only if the criteria associated with the rate matrix node has two
184 * subcriteria. If the criteria takes a range of values this column stores the
185 * start value of the range, otherwise it contains null.
186 * @param p_number_value4 Contains number value. A value will be stored in
187 * this field only if the criteria associated with the rate matrix node has two
188 * subcriteria. If the criteria takes a range of values this column stores the
189 * end value of the range, otherwise it contains null.
190 * @param p_date_value1 Contains date value. If the criteria takes a
191 * range of values, it stores the start of the range. Otherwise it stores
192 * the criteria value.
193 * @param p_date_value2 Contains date value. If the criteria takes a
194 * range of values, it stores the end value of the range. Otherwise, it contains
195 * null.
196 * @param p_date_value3 Contains date value. A value will be stored in
197 * this field only if the criteria associated with the rate matrix node has two
198 * subcriteria. If the criteria takes a range of values this column stores the
199 * start value of the range, otherwise it contains null.
200 * @param p_date_value4 Contains date value. A value will be stored in
201 * this field only if the criteria associated with the rate matrix node has two
202 * subcriteria. If the criteria takes a range of values this column stores the
203 * end value of the range, otherwise it contains null.
204 * @param p_business_group_id Business group of the current rate matrix
205 * node value.
206 * @param p_legislation_code Legislation code of the current rate matrix
207 * node value.
208 * @param p_object_version_number Pass in the current version number of the
209 * rate matrix node value to be updated. When the API completes if p_validate is
210 * false, will be set to the new version number of the updated rate matrix node
211 * value. If p_validate is true will be set to the same value which was passed in.
212 * @rep:displayname Update rate matrix node value
213 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
214 * @rep:lifecycle active
215 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
216 * @rep:scope public
217 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
218 */
219 --
220 -- {End Of Comments}
221 --
222 procedure update_rt_matrix_node_value
223 (p_validate in boolean default false
224 ,p_effective_date in date
225 ,p_NODE_VALUE_ID in number
226 ,p_RATE_MATRIX_NODE_ID in number
227 ,p_SHORT_CODE in varchar2
228 ,p_CHAR_VALUE1 in varchar2 default hr_api.g_varchar2
229 ,p_CHAR_VALUE2 in varchar2 default hr_api.g_varchar2
230 ,p_CHAR_VALUE3 in varchar2 default hr_api.g_varchar2
231 ,p_CHAR_VALUE4 in varchar2 default hr_api.g_varchar2
232 ,p_NUMBER_VALUE1 in number default hr_api.g_number
233 ,p_NUMBER_VALUE2 in number default hr_api.g_number
234 ,p_NUMBER_VALUE3 in number default hr_api.g_number
235 ,p_NUMBER_VALUE4 in number default hr_api.g_number
236 ,p_DATE_VALUE1 in date default hr_api.g_date
237 ,p_DATE_VALUE2 in date default hr_api.g_date
238 ,p_DATE_VALUE3 in date default hr_api.g_date
239 ,p_DATE_VALUE4 in date default hr_api.g_date
240 ,p_BUSINESS_GROUP_ID in number default hr_api.g_number
241 ,p_LEGISLATION_CODE in varchar2 default hr_api.g_varchar2
242 ,p_object_version_number in out nocopy number
243 );
244 --
245 -- ----------------------------------------------------------------------------
246 -- |-----------------------< delete_rt_matrix_node_value >---------------------|
247 -- ----------------------------------------------------------------------------
248 -- {Start Of Comments}
249 --
250 /*#
251 * This API deletes a rate matrix node value.
252 *
253 * Removing a rate matrix node value does not remove the eligibility profile
254 * associated with a rate matrix node which determines if a person is
255 * eligible for the rate associated with the node.
256 *
257 * <p><b>Licensing</b><br>
258 * This API is licensed for use with Human Resources and HR Foundation.
259 *
260 * <p><b>Prerequisites</b><br>
261 * The criteria value attached to the eligibility profile associated with
262 * the rate matrix node must be deleted to maintain consistency.
263 *
264 * <p><b>Post Success</b><br>
265 * The rate matrix node value is deleted.
266 *
267 * <p><b>Post Failure</b><br>
268 * The rate matrix node value is not deleted and error is raised.
269 *
270 * @param p_validate If true, then validation alone will be performed and
271 * the database will remain unchanged. If false and all validation checks pass,
272 * then the database will be modified.
273 * @param p_effective_date Reference date for validating lookup values
274 * are applicable during the start to end active date range. This date does not
275 * determine when the changes take effect.
276 * @param p_node_value_id Identifies the rate matrix node value
277 * to be deleted.
278 * @param p_object_version_number Current version number of the rate
279 * matrix node value to be deleted.
280 * @rep:displayname Delete rate matrix node value
281 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
282 * @rep:lifecycle active
283 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
284 * @rep:scope public
285 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
286 */
287 --
288 -- {End Of Comments}
289 --
290 procedure delete_rt_matrix_node_value
291 (p_validate in boolean default false
292 ,p_effective_date in date
293 ,p_NODE_VALUE_ID in number
294 ,p_object_version_number in number
295 );
296 --
297 end PQH_RT_MATRIX_NODE_VALUES_API;
[Home] [Help]