1 Package PAY_EVENT_VALUE_CHANGES_API AUTHID CURRENT_USER as
2 /* $Header: pyevcapi.pkh 120.1 2005/10/02 02:31:07 aroussel $ */
3 /*#
4 * This package contains APIs for Event Value Changes.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Event Value Change
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_event_value_change >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates event value changes.
17 *
18 * Enforcing the required business rules. Event Value Changes Extend on Event
22 *
19 * Qualifiers to further qualify Datetracked Events. These provide an optional
20 * advanced qualifying mechanism These are used in the Interpretation phase of
21 * the Payroll Events Model.
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * The business group where this record to be created should exist. Also the
28 * datetracked event and the event qualifier should exist for the same business
29 * group.
30 *
31 * <p><b>Post Success</b><br>
32 * The Event Value Change has been successfully created.
33 *
34 * <p><b>Post Failure</b><br>
35 * The API does not create the event value change and raises an error.
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 Reference date for validating lookup values are
40 * applicable during the start to end active date range. This date does not
41 * determine when the changes take effect.
42 * @param p_event_qualifier_id The seeded qualifier for which this change
43 * details are relevant
44 * @param p_default_event A flag stating if this row gives the default
45 * behaviour for all value changes related to this qualifier.
46 * @param p_valid_event A flag stating if this change causes the owning event
47 * to be valid and therefore recalculated.
48 * @param p_datetracked_event_id The event that these changes relate
49 * @param p_business_group_id Business Group of the Record.
50 * @param p_legislation_code Legislation Code
51 * @param p_from_value The original value
52 * @param p_to_value The new value which has resulted
53 * @param p_proration_style Type of proration to be pursued. (Usually null,
54 * French localisation)
55 * @param p_qualifier_value Exact value of qualifier
56 * @param p_event_value_change_id If p_validate is false, this uniquely
57 * identifies the value change created. If p_validate is set to true, this
58 * parameter will be null.
59 * @param p_object_version_number If p_validate is false, then set to the
60 * version number of the created event value change. If p_validate is true,
61 * then the value will be null.
62 * @param p_effective_start_date If p_validate is false, then set to the
63 * effective end date for the created Value Change. If p_validate is true, then
64 * set to null.
65 * @param p_effective_end_date If p_validate is false, then set to the
66 * effective end date for the created Value Change row which now exists as of
67 * the effective date. If p_validate is true or all row instances have been
68 * deleted then set to null.
69 * @rep:displayname Create Event Value Change
70 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
71 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
72 * @rep:scope public
73 * @rep:lifecycle active
74 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
75 */
76 --
77 -- {End Of Comments}
78 --
79 Procedure create_event_value_change
80 (p_validate in boolean default false
81 ,p_effective_date in date
82 ,p_event_qualifier_id in number
83 ,p_default_event in varchar2
84 ,p_valid_event in varchar2
85 ,p_datetracked_event_id in number default null
86 ,p_business_group_id in number default null
87 ,p_legislation_code in varchar2 default null
88 ,p_from_value in varchar2 default null
89 ,p_to_value in varchar2 default null
90 ,p_proration_style in varchar2 default null
91 ,p_qualifier_value in varchar2 default null
92 ,p_event_value_change_id out nocopy number
93 ,p_object_version_number out nocopy number
94 ,p_effective_start_date out nocopy date
95 ,p_effective_end_date out nocopy date
96 );
97 --
98 -- ----------------------------------------------------------------------------
99 -- |------------------------< update_event_value_change >---------------------|
100 -- ----------------------------------------------------------------------------
101 --
102 -- {Start Of Comments}
103 /*#
104 * This API updates an Event Value Change.
105 *
106 * Enforcing the required business rules. Event Value Changes Extend on Event
107 * Qualifiers to further qualify Datetracked Events. These provide an optional
108 * advanced qualifying mechanism These are used in the Interpretation phase of
109 * the Payroll Events Model.
110 *
111 * <p><b>Licensing</b><br>
112 * This API is licensed for use with Human Resources.
113 *
114 * <p><b>Prerequisites</b><br>
115 * The event value change as identified by the in parameters
116 * event_value_change_id and p_object_version_number.
117 *
118 * <p><b>Post Success</b><br>
119 * The Event Qualifier has been successfully updated.
120 *
121 * <p><b>Post Failure</b><br>
122 * The API does not update the event value change and raises an error.
123 * @param p_validate If true, then validation alone will be performed and the
124 * database will remain unchanged. If false and all validation checks pass,
125 * then the database will be modified.
126 * @param p_effective_date Reference date for validating lookup values are
127 * applicable during the start to end active date range. This date does not
128 * determine when the changes take effect.
129 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
130 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
131 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
132 * depend on the dates of previous record changes and the effective date of
133 * this change.
134 * @param p_event_qualifier_id The seeded qualifier for which this change
135 * details are relevant
136 * @param p_default_event A flag stating if this row gives the default
137 * behaviour for all value changes related to this qualifier.
138 * @param p_valid_event A flag stating if this change causes the owning event
139 * to be valid and therefore recalculated.
140 * @param p_datetracked_event_id The event that to which these changes relate
141 * @param p_business_group_id Business Group of the Record.
142 * @param p_legislation_code Legislation Code
143 * @param p_from_value The original value
144 * @param p_to_value The new value which has resulted
145 * @param p_proration_style Type of proration to be pursued. (Usually null,
146 * French localisation)
147 * @param p_qualifier_value Exact value of qualifier
148 * @param p_event_value_change_id Identifier of the event value change being
149 * deleted.
150 * @param p_object_version_number Pass in the current version number of the
151 * event value change to be updated. When the API completes if p_validate is
152 * false, will be set to the new version number of the updated event value
153 * change. If p_validate is true will be set to the same value which was passed
154 * in.
155 * @param p_effective_start_date If p_validate is false, then set to the
156 * effective end date for the updated Value Change. If p_validate is true, then
157 * set to null.
158 * @param p_effective_end_date If p_validate is false, then set to the
159 * effective end date for the updated Value Change row which now exists as of
160 * the effective date. If p_validate is true or all row instances have been
161 * deleted then set to null.
162 * @rep:displayname Update Event Value Change
163 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
164 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
165 * @rep:scope public
166 * @rep:lifecycle active
167 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
168 */
169 --
170 -- {End Of Comments}
171 --
172 procedure update_event_value_change
173 (p_validate in boolean default false
174 ,p_effective_date in date
175 ,p_datetrack_mode in varchar2
176 ,p_event_qualifier_id in number
177 ,p_default_event in varchar2
178 ,p_valid_event in varchar2
179 ,p_datetracked_event_id in number default hr_api.g_number
180 ,p_business_group_id in number default hr_api.g_number
181 ,p_legislation_code in varchar2 default hr_api.g_varchar2
182 ,p_from_value in varchar2 default hr_api.g_varchar2
183 ,p_to_value in varchar2 default hr_api.g_varchar2
184 ,p_proration_style in varchar2 default hr_api.g_varchar2
185 ,p_qualifier_value in varchar2 default hr_api.g_varchar2
186 ,p_event_value_change_id in number
187 ,p_object_version_number in out nocopy number
188 ,p_effective_start_date out nocopy date
189 ,p_effective_end_date out nocopy date
190 );
191 --
192 -- ----------------------------------------------------------------------------
193 -- |------------------------< delete_event_value_change >---------------------|
194 -- ----------------------------------------------------------------------------
195 --
196 -- {Start Of Comments}
197 /*#
198 * This API deletes an event value change.
199 *
200 * Enforcing the required business rules. Event Value Changes Extend on Event
201 * Qualifiers to further qualify Datetracked Events. These provide an optional
202 * advanced qualifying mechanism These are used in the Interpretation phase of
203 * the Payroll Events Model.
204 *
205 * <p><b>Licensing</b><br>
206 * This API is licensed for use with Human Resources.
207 *
208 * <p><b>Prerequisites</b><br>
209 * The event value change as identified by the in parameters
210 * p_event_value_change_id and p_object_version_number must already exist.
211 *
212 * <p><b>Post Success</b><br>
213 * The Event Value Change has been successfully deleted.
214 *
215 * <p><b>Post Failure</b><br>
216 * The API does not delete the event value change and raises an error.
217 * @param p_validate If true, then validation alone will be performed and the
218 * database will remain unchanged. If false and all validation checks pass,
219 * then the database will be modified.
220 * @param p_effective_date Reference date for validating lookup values are
221 * applicable during the start to end active date range. This date does not
222 * determine when the changes take effect.
223 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
224 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
225 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
226 * on the dates of previous record changes and the effective date of this
227 * change.
228 * @param p_event_value_change_id Identifier of the event value change being
229 * deleted.
230 * @param p_object_version_number Pass in the current version number of the
231 * Event Value Change to be deleted to be deleted. When the API completes if
232 * p_validate is false, will be set to the new version number of the deleted
233 * Event Value Change to be deleted. If p_validate is true will be set to the
234 * same value which was passed in.
235 * @param p_business_group_id Business Group of the Record.
236 * @param p_legislation_code Legislation Code
237 * @param p_effective_start_date If p_validate is false, then set to the
238 * effective end date for the deleted Value Change If p_validate is true, then
239 * set to null.
240 * @param p_effective_end_date If p_validate is false, then set to the
241 * effective end date for the deleted Value Change row which now exists as of
242 * the effective date. If p_validate is true or all row instances have been
243 * deleted then set to null.
244 * @rep:displayname Delete Event Value Change
245 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
246 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
247 * @rep:scope public
248 * @rep:lifecycle active
249 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
250 */
251 --
252 -- {End Of Comments}
253 --
254 procedure delete_event_value_change
255 (p_validate in boolean default false
256 ,p_effective_date in date
257 ,p_datetrack_mode in varchar2
258 ,p_event_value_change_id in number
259 ,p_object_version_number in out nocopy number
260 ,p_business_group_id in number default hr_api.g_number
261 ,p_legislation_code in varchar2 default hr_api.g_varchar2
262 ,p_effective_start_date out nocopy date
263 ,p_effective_end_date out nocopy date
264 );
265 --
266
267 end pay_event_value_changes_api;
[Home] [Help]