4 * This package contains the Iterative Rules API.
1 Package pay_iterative_rules_api AUTHID CURRENT_USER as
2 /* $Header: pyitrapi.pkh 120.2 2005/10/24 00:42:53 adkumar noship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Iterative Rule
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_iterative_rule >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an iterative rule record.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Payroll.
24 *
21 *
22 * <p><b>Prerequisites</b><br>
23 * Element Type with an Iterative formula attached.
25 * <p><b>Post Success</b><br>
26 * The iterative rule will be successfully inserted into the database.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create the iterative rule and raises an error.
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date Determines when the DateTrack operation comes into
34 * force.
35 * @param p_element_type_id {@rep:casecolumn
36 * PAY_ITERATIVE_RULES_F.ELEMENT_TYPE_ID}
37 * @param p_result_name Result Name
38 * @param p_iterative_rule_type Iterative rule type
39 * @param p_input_value_id {@rep:casecolumn
40 * PAY_ITERATIVE_RULES_F.INPUT_VALUE_ID}
41 * @param p_severity_level Severity Level.
42 * @param p_business_group_id {@rep:casecolumn
43 * PAY_ITERATIVE_RULES_F.BUSINESS_GROUP_ID}
44 * @param p_legislation_code {@rep:casecolumn
45 * PAY_ITERATIVE_RULES_F.LEGISLATION_CODE}
46 * @param p_iterative_rule_id If p_validate is false, this uniquely identifies
47 * the Iterative Rule created. If p_validate is set to true, this parameter
48 * will be null.
49 * @param p_object_version_number If p_validate is false, then set to the
50 * version number of the created iterative rule. If p_validate is true, then
51 * the value will be null.
52 * @param p_effective_start_date If p_validate is false, then set to the
53 * earliest effective start date for the created iterative rule. If p_validate
54 * is true, then set to null.
55 * @param p_effective_end_date If p_validate is false, then set to the
56 * effective end date for the created iterative rule. If p_validate is true,
57 * then set to null.
58 * @rep:displayname Create Iterative Rule
59 * @rep:category BUSINESS_ENTITY PAY_ITERATIVE_RULE
60 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
61 * @rep:scope public
62 * @rep:lifecycle active
63 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
64 */
65 --
66 -- {End Of Comments}
67 --
68 procedure create_iterative_rule
69 ( p_validate in boolean default false
70 ,p_effective_date in date
71 ,p_element_type_id in number
72 ,p_result_name in varchar2
73 ,p_iterative_rule_type in varchar2
74 ,p_input_value_id in number default null
75 ,p_severity_level in varchar2 default null
76 ,p_business_group_id in number default null
77 ,p_legislation_code in varchar2 default null
78 ,p_iterative_rule_id out nocopy number
79 ,p_object_version_number out nocopy number
80 ,p_effective_start_date out nocopy date
81 ,p_effective_end_date out nocopy date
82 );
83 --
84 -- ----------------------------------------------------------------------------
85 -- |--------------------------< update_iterative_rule >-----------------------|
86 -- ----------------------------------------------------------------------------
87 --
88 -- {Start Of Comments}
89 /*#
90 * This API updates the iterative rule record.
91 *
92 *
93 * <p><b>Licensing</b><br>
94 * This API is licensed for use with Payroll.
95 *
96 * <p><b>Prerequisites</b><br>
97 * Element Type with an Iterative formula attached.
98 *
99 * <p><b>Post Success</b><br>
100 * The iterative rule will be successfully updated in the database.
101 *
102 * <p><b>Post Failure</b><br>
103 * The API does not update the iterative rule and raises an error.
104 * @param p_validate If true, then validation alone will be performed and the
105 * database will remain unchanged. If false and all validation checks pass,
106 * then the database will be modified.
107 * @param p_effective_date Determines when the DateTrack operation comes into
108 * force.
109 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
110 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
111 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
112 * depend on the dates of previous record changes and the effective date of
113 * this change.
114 * @param p_iterative_rule_id Primary Key for the iterative rule.
115 * @param p_object_version_number Pass in the current version number of the
116 * iterative rule to be updated. When the API completes if p_validate is false,
117 * will be set to the new version number of the updated iterative rule. If
118 * p_validate is true will be set to the same value which was passed in.
119 * @param p_element_type_id {@rep:casecolumn
120 * PAY_ITERATIVE_RULES_F.ELEMENT_TYPE_ID}
121 * @param p_result_name Result Name
122 * @param p_iterative_rule_type Iterative rule type
123 * @param p_input_value_id {@rep:casecolumn
124 * PAY_ITERATIVE_RULES_F.INPUT_VALUE_ID}
125 * @param p_severity_level Severity Level.
126 * @param p_business_group_id {@rep:casecolumn
127 * PAY_ITERATIVE_RULES_F.BUSINESS_GROUP_ID}
128 * @param p_legislation_code {@rep:casecolumn
129 * PAY_ITERATIVE_RULES_F.LEGISLATION_CODE}
130 * @param p_effective_start_date If p_validate is false, then set to the
131 * effective start date on the updated iterative rule row which now exists as
132 * of the effective date. If p_validate is true, then set to null.
133 * @param p_effective_end_date If p_validate is false, then set to the
134 * effective end date on the updated iterative rule row which now exists as of
135 * the effective date. If p_validate is true, then set to null.
136 * @rep:displayname Update Iterative Rule
137 * @rep:category BUSINESS_ENTITY PAY_ITERATIVE_RULE
138 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
139 * @rep:scope public
140 * @rep:lifecycle active
141 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
142 */
143 --
144 -- {End Of Comments}
145 --
146 procedure update_iterative_rule
147 ( p_validate in boolean default false
148 ,p_effective_date in date
149 ,p_datetrack_mode in varchar2
150 ,p_iterative_rule_id in number
151 ,p_object_version_number in out nocopy number
152 ,p_element_type_id in number default hr_api.g_number
153 ,p_result_name in varchar2 default hr_api.g_varchar2
154 ,p_iterative_rule_type in varchar2 default hr_api.g_varchar2
155 ,p_input_value_id in number default hr_api.g_number
156 ,p_severity_level in varchar2 default hr_api.g_varchar2
157 ,p_business_group_id in number default hr_api.g_number
158 ,p_legislation_code in varchar2 default hr_api.g_varchar2
159 ,p_effective_start_date out nocopy date
160 ,p_effective_end_date out nocopy date
161 );
162 --
163 -- ----------------------------------------------------------------------------
164 -- |--------------------------< delete_iterative_rule >-----------------------|
165 -- ----------------------------------------------------------------------------
166 --
167 -- {Start Of Comments}
168 /*#
169 * This API deletes an iterative rule record.
170 *
171 *
172 * <p><b>Licensing</b><br>
173 * This API is licensed for use with Payroll.
174 *
175 * <p><b>Prerequisites</b><br>
176 * The iterative rule to be delete should exist.
177 *
178 * <p><b>Post Success</b><br>
179 * The iterative rule will be successfully deleted from the database.
180 *
181 * <p><b>Post Failure</b><br>
182 * The API does not delete the iterative rule and raises an error.
183 * @param p_validate If true, then validation alone will be performed and the
184 * database will remain unchanged. If false and all validation checks pass,
185 * then the database will be modified.
186 * @param p_effective_date Determines when the DateTrack operation comes into
187 * force.
188 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
189 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
190 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
191 * depend on the dates of previous record changes and the effective date of
192 * this change.
193 * @param p_iterative_rule_id Primary Key for the iterative rule.
194 * @param p_object_version_number Pass in the current version number of the
195 * iterative rule to be deleted. When the API completes if p_validate is false,
196 * will be set to the new version number of the deleted iterative rule. If
197 * p_validate is true will be set to the same value which was passed in.
198 * @param p_effective_start_date If p_validate is false, then set to the
199 * effective start date for the deleted iterative rule row which now exists as
200 * of the effective date. If p_validate is true or all row instances have been
201 * deleted then set to null.
202 * @param p_effective_end_date If p_validate is false, then set to the
203 * effective end date for the deleted iterative rule row which now exists as of
204 * the effective date. If p_validate is true or all row instances have been
205 * deleted then set to null.
206 * @rep:displayname Delete Iterative Rule
207 * @rep:category BUSINESS_ENTITY PAY_ITERATIVE_RULE
208 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
209 * @rep:scope public
210 * @rep:lifecycle active
211 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
212 */
213 --
214 -- {End Of Comments}
215 --
216 procedure delete_iterative_rule
217 ( p_validate in boolean default false
218 ,p_effective_date in date
219 ,p_datetrack_mode in varchar2
220 ,p_iterative_rule_id in number
221 ,p_object_version_number in out nocopy number
222 ,p_effective_start_date out nocopy date
223 ,p_effective_end_date out nocopy date
224 );
225 --
226 -- ----------------------------------------------------------------------------
227 -- |------------------------< lck_iterative_rule >------------------------|
228 -- ----------------------------------------------------------------------------
229 -- {Start Of Comments}
230 --
231 -- Description:
232 --
233 -- Prerequisites:
234 --
235 --
236 -- In Parameters:
237 -- Name Reqd Type Description
238 --
239 -- Post Success:
240 --
241 -- Out Parameters:
242 -- Name Type Description
243 --
244 -- Post Failure:
245 --
246 -- Access Status:
247 -- Public.
248 --
249 -- {End Of Comments}
250 --
251 /*procedure lck_iterative_rule
252 (
253 p_effective_date in date
254 ,p_datetrack_mode in varchar2
255 ,p_iterative_rule_id in number
256 ,p_object_version_number in number
257 ,p_validation_start_date out nocopy date
258 ,p_validation_end_date out nocopy date
259 );
260 */
261 --
262 end pay_iterative_rules_api;
[Home] [Help]