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