1 Package PAY_EVENT_QUALIFIERS_API AUTHID CURRENT_USER as
2 /* $Header: pyevqapi.pkh 120.1 2005/10/02 02:31:23 aroussel $ */
3 /*#
4 * This package contains APIs for Event Qualifiers.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Event Qualifiers
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_event_qualifier >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an Event Qualifier.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The business group where this record to be created should exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Event Qualifier has been successfully created.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create the event qualifier 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_dated_table_id The table for which this qualifier is relevant.
36 * @param p_column_name The column for which this qualifier is relevant.
37 * @param p_qualifier_name The name of this event qualifier.
38 * @param p_legislation_code Legislation Code
39 * @param p_business_group_id Business Group of the Record.
40 * @param p_comparison_column The column for which this qualifier is relevant.
41 * (In SQL syntax)
42 * @param p_qualifier_definition The explicit details of the qualifier
43 * @param p_qualifier_where_clause The explicit details of the dynamic query
44 * clause.
45 * @param p_entry_qualification {@rep:casecolumn
46 * PAY_EVENT_QUALIFIERS_F.ENTRY_QUALIFICATION}
47 * @param p_assignment_qualification {@rep:casecolumn
48 * PAY_EVENT_QUALIFIERS_F.ASSIGNMENT_QUALIFICATION}
49 * @param p_multi_event_sql SQL to find multiple
50 * @param p_event_qualifier_id If p_validate is false, this uniquely identifies
51 * the event qualifier created. If p_validate is set to true, this parameter
52 * will be null.
53 * @param p_object_version_number If p_validate is false, then set to the
54 * version number of the created Event Qualifier. If p_validate is true, then
55 * the value will be null.
56 * @param p_effective_start_date If p_validate is false, then set to the
57 * earliest effective start date for the created Event Qualifier. If p_validate
58 * is true, then set to null.
59 * @param p_effective_end_date If p_validate is false, then set to the
60 * effective end date for the created Event Qualifier. If p_validate is true,
61 * then set to null.
62 * @rep:displayname Create Event Qualifier
63 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
64 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
65 * @rep:scope public
66 * @rep:lifecycle active
67 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
68 */
69 --
70 -- {End Of Comments}
71 --
72 Procedure create_event_qualifier
73 (p_validate in boolean default false
74 ,p_effective_date in date
75 ,p_dated_table_id in number
76 ,p_column_name in varchar2
77 ,p_qualifier_name in varchar2
78 ,p_legislation_code in varchar2 default null
79 ,p_business_group_id in number default null
80 ,p_comparison_column in varchar2 default null
81 ,p_qualifier_definition in varchar2 default null
82 ,p_qualifier_where_clause in varchar2 default null
83 ,p_entry_qualification in varchar2 default null
84 ,p_assignment_qualification in varchar2 default null
85 ,p_multi_event_sql in varchar2 default null
86 ,p_event_qualifier_id out nocopy number
87 ,p_object_version_number out nocopy number
88 ,p_effective_start_date out nocopy date
89 ,p_effective_end_date out nocopy date
90 );
91 --
92 -- ----------------------------------------------------------------------------
93 -- |--------------------------< update_event_qualifier >----------------------|
94 -- ----------------------------------------------------------------------------
95 --
96 -- {Start Of Comments}
97 /*#
98 * This API updates an Event Qualifier.
99 *
100 *
101 * <p><b>Licensing</b><br>
102 * This API is licensed for use with Human Resources.
103 *
104 * <p><b>Prerequisites</b><br>
105 * The event qualifier as identified by the in parameters event_qualifier_id
106 * and p_object_version_number.
107 *
108 * <p><b>Post Success</b><br>
109 * The Event Qualifier has been successfully updated.
110 *
111 * <p><b>Post Failure</b><br>
112 * The API does not update the event qualifiers and raises an error.
113 * @param p_validate If true, then validation alone will be performed and the
114 * database will remain unchanged. If false and all validation checks pass,
115 * then the database will be modified.
116 * @param p_effective_date Determines when the DateTrack operation comes into
117 * force.
118 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
119 * updating the record. You must set to either UPDATE, CORRECTION,
120 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
121 * particular record depend on the dates of previous record changes and the
122 * effective date of this change.
123 * @param p_event_qualifier_id Primary Key of the record.
124 * @param p_dated_table_id The table for which this qualifier is relevant.
125 * @param p_column_name The column for which this qualifier is relevant.
126 * @param p_qualifier_name The name of this event qualifier.
127 * @param p_object_version_number Pass in the current version number of the
128 * Event Qualifier to be updated. When the API completes if p_validate is
129 * false, will be set to the new version number of the updated Event Qualifier.
130 * If p_validate is true will be set to the same value which was passed in.
131 * @param p_legislation_code Legislation Code
132 * @param p_business_group_id Business Group of the Record
133 * @param p_comparison_column The column for which this qualifier is relevant.
134 * (In SQL syntax)
135 * @param p_qualifier_definition The explicit details of the qualifier
136 * @param p_qualifier_where_clause The explicit details of the dynamic query
137 * clause.
138 * @param p_entry_qualification {@rep:casecolumn
139 * PAY_EVENT_QUALIFIERS_F.ENTRY_QUALIFICATION}
140 * @param p_assignment_qualification {@rep:casecolumn
141 * PAY_EVENT_QUALIFIERS_F.ASSIGNMENT_QUALIFICATION}
142 * @param p_multi_event_sql SQL to find multiple
143 * @param p_effective_start_date If p_validate is false, then set to the
144 * effective start date on the updated Event Qualifier row which now exists as
145 * of the effective date. If p_validate is true, then set to null.
146 * @param p_effective_end_date If p_validate is false, then set to the
147 * effective end date on the updated Event Qualifier row which now exists as of
148 * the effective date. If p_validate is true, then set to null.
149 * @rep:displayname Update Event Qualifier
150 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
151 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
152 * @rep:scope public
153 * @rep:lifecycle active
154 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
155 */
156 --
157 -- {End Of Comments}
158 --
159 procedure update_event_qualifier
160 (p_validate in boolean default false
161 ,p_effective_date in date
162 ,p_datetrack_update_mode in varchar2
163 ,p_event_qualifier_id in number
164 ,p_dated_table_id in number
165 ,p_column_name in varchar2
166 ,p_qualifier_name in varchar2
167 ,p_object_version_number in out nocopy number
168 ,p_legislation_code in varchar2 default hr_api.g_varchar2
169 ,p_business_group_id in number default hr_api.g_number
170 ,p_comparison_column in varchar2 default hr_api.g_varchar2
171 ,p_qualifier_definition in varchar2 default hr_api.g_varchar2
172 ,p_qualifier_where_clause in varchar2 default hr_api.g_varchar2
173 ,p_entry_qualification in varchar2 default hr_api.g_varchar2
174 ,p_assignment_qualification in varchar2 default hr_api.g_varchar2
175 ,p_multi_event_sql in varchar2 default hr_api.g_varchar2
176 ,p_effective_start_date out nocopy date
177 ,p_effective_end_date out nocopy date
178 );
179 --
180 -- ----------------------------------------------------------------------------
181 -- |--------------------------< delete_event_qualifier >----------------------|
182 -- ----------------------------------------------------------------------------
183 --
184 -- {Start Of Comments}
185 /*#
186 * This API deletes an Event Qualifier.
187 *
188 *
189 * <p><b>Licensing</b><br>
190 * This API is licensed for use with Human Resources.
191 *
192 * <p><b>Prerequisites</b><br>
193 * The event qualifier as identified by the in parameters p_event_qualifier_id
194 * and p_object_version_number must already exist.
195 *
196 * <p><b>Post Success</b><br>
197 * The Event Qualifier has been successfully deleted.
198 *
199 * <p><b>Post Failure</b><br>
200 * The API does not delete the event qualifier and raises an error.
201 * @param p_validate If true, then validation alone will be performed and the
202 * database will remain unchanged. If false and all validation checks pass,
203 * then the database will be modified.
204 * @param p_effective_date Determines when the DateTrack operation comes into
205 * force.
206 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
207 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
208 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
209 * on the dates of previous record changes and the effective date of this
210 * change.
211 * @param p_event_qualifier_id Identifier of the event qualifier being deleted.
212 * @param p_object_version_number Pass in the current version number of the
213 * event qualifier to be deleted. When the API completes if p_validate is
214 * false, will be set to the new version number of the deleted event qualifier.
215 * If p_validate is true will be set to the same value which was passed in.
216 * @param p_business_group_id Business Group of the Record
217 * @param p_legislation_code Legislation Code
218 * @param p_effective_start_date If p_validate is false, then set to the
219 * effective start date for the deleted Event Qualifier row which now exists as
220 * of the effective date. If p_validate is true or all row instances have been
221 * deleted then set to null.
222 * @param p_effective_end_date If p_validate is false, then set to the
223 * effective end date for the deleted Event Qualifier row which now exists as
224 * of the effective date. If p_validate is true or all row instances have been
225 * deleted then set to null.
226 * @rep:displayname Delete Event Qualifier
227 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
228 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
229 * @rep:scope public
230 * @rep:lifecycle active
231 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
232 */
233 --
234 -- {End Of Comments}
235 --
236 procedure delete_event_qualifier
237 (p_validate in boolean default false
238 ,p_effective_date in date
239 ,p_datetrack_delete_mode in varchar2
240 ,p_event_qualifier_id in number
241 ,p_object_version_number in out nocopy number
242 ,p_business_group_id in number default hr_api.g_number
243 ,p_legislation_code in varchar2 default hr_api.g_varchar2
244 ,p_effective_start_date out nocopy date
245 ,p_effective_end_date out nocopy date
246 );
247 --
248
249 end pay_event_qualifiers_api;
[Home] [Help]