1 Package PAY_FORMULA_RESULT_RULE_API AUTHID CURRENT_USER as
2 /* $Header: pyfrrapi.pkh 120.1 2005/10/02 02:46:12 aroussel $ */
3 /*#
4 * This package contains Formula Result Rule APIs.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname Formula Result Rule
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_formula_result_rule >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This Business Process is used to create a new formula result rule as of the
17 * effective date.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Payroll.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The formula and the element to be used should be valid.
25 *
26 * <p><b>Post Success</b><br>
27 * The formula result rule will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * Error Messages are raised if any business rule is violated and the Formula
31 * result rule is not created.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_status_processing_rule_id Foreign key to
39 * PAY_STATUS_PROCESSING_RULES.
40 * @param p_result_name Name of the variable returned by the formula.
41 * @param p_result_rule_type Formula result type for the formula result rule.
42 * Valid values are defined by the 'RESULT_RULE_TYPE' lookup type.
43 * @param p_business_group_id Business group of the formula result rule.
44 * @param p_legislation_code Legislation of the formula result rule.
45 * @param p_element_type_id Target element type.
46 * @param p_legislation_subgroup Identifies the startup data legislation for
47 * the formula result rule.
48 * @param p_severity_level Severity level for a message type result.
49 * @param p_input_value_id Target input value.
50 * @param p_formula_result_rule_id Primary Key If p_validate is true then this
51 * will be set to null.
52 * @param p_effective_start_date If p_validate is false, then set to the
53 * earliest effective start date for the created formula result rule. If
54 * p_validate 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 formula result rule. If p_validate is
57 * true, then set to null.
58 * @param p_object_version_number If p_validate is false, then set to the
59 * version number of the created formula result rule. If p_validate is true,
60 * then the value will be null.
61 * @rep:displayname Create Formula Result Rule
62 * @rep:category BUSINESS_ENTITY PAY_FORMULA_RESULT
63 * @rep:lifecycle active
64 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
65 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
66 * @rep:scope public
67 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
68 */
69 --
70 -- {End Of Comments}
71 --
72 procedure CREATE_FORMULA_RESULT_RULE
73 (p_validate in boolean default false
74 ,p_effective_date in date
75 ,p_status_processing_rule_id in number
76 ,p_result_name in varchar2
77 ,p_result_rule_type in varchar2
78 ,p_business_group_id in number default null
79 ,p_legislation_code in varchar2 default null
80 ,p_element_type_id in number default null
81 ,p_legislation_subgroup in varchar2 default null
82 ,p_severity_level in varchar2 default null
83 ,p_input_value_id in number default null
84 ,p_formula_result_rule_id out nocopy number
85 ,p_effective_start_date out nocopy date
86 ,p_effective_end_date out nocopy date
87 ,p_object_version_number out nocopy number
88 );
89 --
90 -- ----------------------------------------------------------------------------
91 -- |------------------------< update_formula_result_rule >--------------------|
92 -- ----------------------------------------------------------------------------
93 --
94 -- {Start Of Comments}
95 /*#
96 * This Business Process is used to update a formula result rule as of the
97 * effective date.
98 *
99 *
100 * <p><b>Licensing</b><br>
101 * This API is licensed for use with Payroll.
102 *
103 * <p><b>Prerequisites</b><br>
104 * The formula result rule to be updated should exist and the formula should be
105 * valid.
106 *
107 * <p><b>Post Success</b><br>
108 * The formula result rule will be successfully updated into the database.
109 *
110 * <p><b>Post Failure</b><br>
111 * Error Messages are raised if any business rule is violated and the Formula
112 * result rule is not updated.
113 *
114 * @param p_validate If true, then validation alone will be performed and the
115 * database will remain unchanged. If false and all validation checks pass,
116 * then the database will be modified.
117 * @param p_effective_date Determines when the DateTrack operation comes into
118 * force.
119 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
120 * updating the record. You must set to either UPDATE, CORRECTION,
121 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
122 * particular record depend on the dates of previous record changes and the
123 * effective date of this change.
124 * @param p_formula_result_rule_id Unique identifier of the formula result
125 * being updated.
126 * @param p_object_version_number Pass in the current version number of the
127 * formula result rule to be updated. When the API completes if p_validate is
128 * false, will be set to the new version number of the updated formula result
129 * rule. If p_validate is true will be set to the same value which was passed
130 * in.
131 * @param p_result_rule_type Formula result type for the formula result rule.
132 * Valid values are defined by the 'RESULT_RULE_TYPE' lookup type.
133 * @param p_element_type_id Target element type.
134 * @param p_severity_level Severity level for a message type result.
135 * @param p_input_value_id Target input value.
136 * @param p_effective_start_date If p_validate is false, then set to the
137 * effective start date on the updated formula result rule row, which now
138 * exists as of the effective date. If p_validate is true, then set to null.
139 * @param p_effective_end_date If p_validate is false, then set to the
140 * effective end date on the updated formula result rule row, which now exists
141 * as of the effective date. If p_validate is true, then set to null.
142 * @rep:displayname Update Formula Result Rule
143 * @rep:category BUSINESS_ENTITY PAY_FORMULA_RESULT
144 * @rep:lifecycle active
145 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
146 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
147 * @rep:scope public
148 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
149 */
150 --
151 -- {End Of Comments}
152 --
153 procedure UPDATE_FORMULA_RESULT_RULE
154 (p_validate in boolean default false
155 ,p_effective_date in date
156 ,p_datetrack_update_mode in varchar2
157 ,p_formula_result_rule_id in number
158 ,p_object_version_number in out nocopy number
159 ,p_result_rule_type in varchar2 default hr_api.g_varchar2
160 ,p_element_type_id in number default hr_api.g_number
161 ,p_severity_level in varchar2 default hr_api.g_varchar2
162 ,p_input_value_id in number default hr_api.g_number
163 ,p_effective_start_date out nocopy date
164 ,p_effective_end_date out nocopy date
165 );
166 --
167 -- ----------------------------------------------------------------------------
168 -- |------------------------< delete_formula_result_rule >--------------------|
169 -- ----------------------------------------------------------------------------
170 --
171 -- {Start Of Comments}
172 /*#
173 * This Business Process is used to delete a formula result rule as of the
174 * effective date.
175 *
176 *
177 * <p><b>Licensing</b><br>
178 * This API is licensed for use with Payroll.
179 *
180 * <p><b>Prerequisites</b><br>
181 * A formula result rule must exist.
182 *
183 * <p><b>Post Success</b><br>
184 * The formula result rule will be successfully deleted from the database.
185 *
186 * <p><b>Post Failure</b><br>
187 * Error Messages are raised if any business rule is violated and the Formula
188 * result rule is not deleted.
189 *
190 * @param p_validate If true, then validation alone will be performed and the
191 * database will remain unchanged. If false and all validation checks pass,
192 * then the database will be modified.
193 * @param p_effective_date Determines when the DateTrack operation comes into
194 * force.
195 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
196 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
197 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
198 * on the dates of previous record changes and the effective date of this
199 * change.
200 * @param p_formula_result_rule_id Unique identifier of the formula result
201 * being deleted.
202 * @param p_object_version_number Pass in the current version number of the
203 * formula result rule to be deleted. When the API completes if p_validate is
204 * false, will be set to the new version number of the deleted formula result
205 * rule. If p_validate is true will be set to the same value which was passed
206 * in.
207 * @param p_effective_start_date If p_validate is false, then set to the
208 * effective start date for the deleted formula result rule row, which now
209 * exists as of the effective date. If p_validate is true or all row instances
210 * have been deleted then set to null.
211 * @param p_effective_end_date If p_validate is false, then set to the
212 * effective end date for the deleted formula result rule row, which now exists
213 * as of the effective date. If p_validate is true or all row instances have
214 * been deleted, then set to null.
215 * @rep:displayname Delete Formula Result Rule
216 * @rep:category BUSINESS_ENTITY PAY_FORMULA_RESULT
217 * @rep:lifecycle active
218 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
219 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
220 * @rep:scope public
221 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
222 */
223 --
224 -- {End Of Comments}
225 --
226 procedure DELETE_FORMULA_RESULT_RULE
227 (p_validate in boolean default false
228 ,p_effective_date in date
229 ,p_datetrack_delete_mode in varchar2
230 ,p_formula_result_rule_id in number
231 ,p_object_version_number in out nocopy number
232 ,p_effective_start_date out nocopy date
233 ,p_effective_end_date out nocopy date
234 );
235 --
236 end PAY_FORMULA_RESULT_RULE_API;
[Home] [Help]