1 Package per_events_api as
2 /* $Header: peevtapi.pkh 120.1 2005/10/02 02:17:00 aroussel $ */
3 /*#
4 * This package contains HR Event APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Event
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_event >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a standard or interview event.
17 *
18 * Use this API to create a standard event, or schedule an employee review or
19 * applicant interview. The type of event created depends on the parameters you
20 * specify. Note: You can schedule employees, applicants and contingent workers
21 * for standard events.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources and iRecruitment.
25 *
26 * <p><b>Prerequisites</b><br>
27 * The business group for which the event will be created within must already
28 * exist. When booking an employee review, applicant interview, or performance
29 * review, the person's assignment must already exist. At least one of the
30 * following event lookup types must have been defined: EMP_EVENT_TYPE,
31 * APL_EVENT_TYPE, EMP_INTERVIEW_TYPE, APL_INTERVIEW_TYPE.
32 *
33 * <p><b>Post Success</b><br>
34 * The event will have been created.
35 *
36 * <p><b>Post Failure</b><br>
37 * The event will not be created and an error will be raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_date_start Start date of the event.
42 * @param p_type The type of event. Valid values are defined by the lookup
43 * types 'EMP_EVENT_TYPE' (for employee or contingent worker standard events),
44 * 'APL_EVENT_TYPE' (for applicant standard events), 'EMP_INTERVIEW_TYPE' (for
45 * employee review events), and 'APL_INTERVIEW_TYPE' (for applicant interview
46 * events).
47 * @param p_business_group_id Uniquely identifies the business group under
48 * which the event will be created.
49 * @param p_location_id Uniquely identifies the location of the event.
50 * @param p_internal_contact_person_id Uniquely identifies the person who is
51 * the internal contact for this event.
52 * @param p_organization_run_by_id Uniquely identifies the organization running
53 * the event.
54 * @param p_assignment_id For interview events, this uniquely identifies the
55 * assignment related to the interview or review.
56 * @param p_contact_telephone_number Contact number for the event.
57 * @param p_date_end End date of the event.
58 * @param p_emp_or_apl Defines whether the event is an employee and contingent
59 * worker event, or an applicant event. Valid values are defined by the
60 * 'EMP_APL' lookup type.
61 * @param p_event_or_interview Defines whether the event is a standard event or
62 * an interview event. Valid values are defined by the 'EVENT_INTERVIEW' lookup
63 * type.
64 * @param p_external_contact External contact for the event.
65 * @param p_time_end End time of the event.
66 * @param p_time_start Start time of the event.
67 * @param p_attribute_category This context value determines which flexfield
68 * structure to use with the descriptive flexfield segments.
69 * @param p_attribute1 Descriptive flexfield segment.
70 * @param p_attribute2 Descriptive flexfield segment.
71 * @param p_attribute3 Descriptive flexfield segment.
72 * @param p_attribute4 Descriptive flexfield segment.
73 * @param p_attribute5 Descriptive flexfield segment.
74 * @param p_attribute6 Descriptive flexfield segment.
75 * @param p_attribute7 Descriptive flexfield segment.
76 * @param p_attribute8 Descriptive flexfield segment.
77 * @param p_attribute9 Descriptive flexfield segment.
78 * @param p_attribute10 Descriptive flexfield segment.
79 * @param p_attribute11 Descriptive flexfield segment.
80 * @param p_attribute12 Descriptive flexfield segment.
81 * @param p_attribute13 Descriptive flexfield segment.
82 * @param p_attribute14 Descriptive flexfield segment.
83 * @param p_attribute15 Descriptive flexfield segment.
84 * @param p_attribute16 Descriptive flexfield segment.
85 * @param p_attribute17 Descriptive flexfield segment.
86 * @param p_attribute18 Descriptive flexfield segment.
87 * @param p_attribute19 Descriptive flexfield segment.
88 * @param p_attribute20 Descriptive flexfield segment.
89 * @param p_party_id Party to whom the event applies.
90 * @param p_event_id If p_validate is false, then this uniquely identifies the
91 * event. If p_validate is true, then this is set to null.
92 * @param p_object_version_number If p_validate is false, then set to the
93 * version number of the created event record. If p_validate is true, then the
94 * value will be null.
95 * @rep:displayname Create Event
96 * @rep:category BUSINESS_ENTITY HR_EVENT
97 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
98 * @rep:scope public
99 * @rep:lifecycle active
100 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
101 */
102 --
103 -- {End Of Comments}
104 --
105 procedure create_event
106
107 (p_validate in BOOLEAN default FALSE
108 ,p_date_start in DATE
109 ,p_type in VARCHAR2
110 ,p_business_group_id in NUMBER default NULL -- HR/TCA merge
111 ,p_location_id in NUMBER default NULL
112 ,p_internal_contact_person_id in NUMBER default NULL
113 ,p_organization_run_by_id in NUMBER default NULL
114 ,p_assignment_id in NUMBER default NULL
115 ,p_contact_telephone_number in VARCHAR2 default NULL
116 ,p_date_end in DATE default NULL
117 ,p_emp_or_apl in VARCHAR2 default NULL
118 ,p_event_or_interview in VARCHAR2 default NULL
119 ,p_external_contact in VARCHAR2 default NULL
120 ,p_time_end in VARCHAR2 default NULL
121 ,p_time_start in VARCHAR2 default NULL
122 ,p_attribute_category in VARCHAR2 default NULL
123 ,p_attribute1 in VARCHAR2 default NULL
124 ,p_attribute2 in VARCHAR2 default NULL
125 ,p_attribute3 in VARCHAR2 default NULL
126 ,p_attribute4 in VARCHAR2 default NULL
127 ,p_attribute5 in VARCHAR2 default NULL
128 ,p_attribute6 in VARCHAR2 default NULL
129 ,p_attribute7 in VARCHAR2 default NULL
130 ,p_attribute8 in VARCHAR2 default NULL
131 ,p_attribute9 in VARCHAR2 default NULL
132 ,p_attribute10 in VARCHAR2 default NULL
133 ,p_attribute11 in VARCHAR2 default NULL
134 ,p_attribute12 in VARCHAR2 default NULL
135 ,p_attribute13 in VARCHAR2 default NULL
136 ,p_attribute14 in VARCHAR2 default NULL
137 ,p_attribute15 in VARCHAR2 default NULL
138 ,p_attribute16 in VARCHAR2 default NULL
139 ,p_attribute17 in VARCHAR2 default NULL
140 ,p_attribute18 in VARCHAR2 default NULL
141 ,p_attribute19 in VARCHAR2 default NULL
142 ,p_attribute20 in VARCHAR2 default NULL
143 ,p_party_id in NUMBER default NULL -- HR/TCA merge
144 ,p_event_id out nocopy NUMBER
145 ,p_object_version_number out nocopy NUMBER
146 );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |-------------------------------< update_event >---------------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154 * This API updates a standard or interview event.
155 *
156 * Use this API to update a standard event, employee review, or applicant
157 * interview.
158 *
159 * <p><b>Licensing</b><br>
160 * This API is licensed for use with Human Resources and iRecruitment.
161 *
162 * <p><b>Prerequisites</b><br>
163 * The event must have already been created.
164 *
165 * <p><b>Post Success</b><br>
166 * The event will have been updated.
167 *
168 * <p><b>Post Failure</b><br>
169 * The event will not be updated and an error will be raised.
170 * @param p_validate If true, then validation alone will be performed and the
171 * database will remain unchanged. If false and all validation checks pass,
172 * then the database will be modified.
173 * @param p_location_id Uniquely identifies the location of the event.
174 * @param p_business_group_id Uniquely identifies the business group that the
175 * event belongs to.
176 * @param p_internal_contact_person_id Uniquely identifies the person who is
177 * the internal contact for this event.
178 * @param p_organization_run_by_id Uniquely identifies the organization running
179 * the event.
180 * @param p_assignment_id For interview events, this uniquely identifies the
181 * assignment related to the interview or review.
182 * @param p_contact_telephone_number Contact number for the event.
183 * @param p_date_end End date of the event.
184 * @param p_emp_or_apl Defines whether the event is an employee and contingent
185 * worker event, or an applicant event. Valid values are defined by the
186 * 'EMP_APL' lookup type.
187 * @param p_event_or_interview Defines whether the event is a standard event or
188 * an interview event. Valid values are defined by the 'EVENT_INTERVIEW' lookup
189 * type.
190 * @param p_external_contact External contact for the event.
191 * @param p_time_end End time of the event.
192 * @param p_time_start Start time of the event.
193 * @param p_attribute_category This context value determines which flexfield
194 * structure to use with the descriptive flexfield segments.
195 * @param p_attribute1 Descriptive flexfield segment.
196 * @param p_attribute2 Descriptive flexfield segment.
197 * @param p_attribute3 Descriptive flexfield segment.
198 * @param p_attribute4 Descriptive flexfield segment.
199 * @param p_attribute5 Descriptive flexfield segment.
200 * @param p_attribute6 Descriptive flexfield segment.
201 * @param p_attribute7 Descriptive flexfield segment.
202 * @param p_attribute8 Descriptive flexfield segment.
203 * @param p_attribute9 Descriptive flexfield segment.
204 * @param p_attribute10 Descriptive flexfield segment.
205 * @param p_attribute11 Descriptive flexfield segment.
206 * @param p_attribute12 Descriptive flexfield segment.
207 * @param p_attribute13 Descriptive flexfield segment.
208 * @param p_attribute14 Descriptive flexfield segment.
209 * @param p_attribute15 Descriptive flexfield segment.
210 * @param p_attribute16 Descriptive flexfield segment.
211 * @param p_attribute17 Descriptive flexfield segment.
212 * @param p_attribute18 Descriptive flexfield segment.
213 * @param p_attribute19 Descriptive flexfield segment.
214 * @param p_attribute20 Descriptive flexfield segment.
215 * @param p_date_start Start date of the event.
216 * @param p_type The type of event. Valid values are defined by the lookup
217 * types 'EMP_EVENT_TYPE' (for employee or contingent worker standard events),
218 * 'APL_EVENT_TYPE' (for applicant standard events), 'EMP_INTERVIEW_TYPE' (for
219 * employee review events), and 'APL_INTERVIEW_TYPE' (for applicant interview
220 * events).
221 * @param p_party_id Party to whom the event applies.
222 * @param p_event_id Uniquely identifies the event that will be updated.
223 * @param p_object_version_number Pass in the current version number of the
224 * Event to be updated. When the API completes if p_validate is false, will be
225 * set to the new version number of the updated Event. If p_validate is true
226 * will be set to the same value which was passed in.
227 * @rep:displayname Update Event
228 * @rep:category BUSINESS_ENTITY HR_EVENT
229 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
230 * @rep:scope public
231 * @rep:lifecycle active
232 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
233 */
234 --
235 -- {End Of Comments}
236 --
237 procedure update_event
238 (p_validate in BOOLEAN default FALSE
239 ,p_location_id in NUMBER default hr_api.g_number
240 ,p_business_group_id in NUMBER default hr_api.g_number
241 ,p_internal_contact_person_id in NUMBER default hr_api.g_number
242 ,p_organization_run_by_id in NUMBER default hr_api.g_number
243 ,p_assignment_id in NUMBER default hr_api.g_number
244 ,p_contact_telephone_number in VARCHAR2 default hr_api.g_varchar2
245 ,p_date_end in DATE default hr_api.g_date
246 ,p_emp_or_apl in VARCHAR2 default hr_api.g_varchar2
247 ,p_event_or_interview in VARCHAR2 default hr_api.g_varchar2
248 ,p_external_contact in VARCHAR2 default hr_api.g_varchar2
249 ,p_time_end in VARCHAR2 default hr_api.g_varchar2
250 ,p_time_start in VARCHAR2 default hr_api.g_varchar2
251 ,p_attribute_category in VARCHAR2 default hr_api.g_varchar2
252 ,p_attribute1 in VARCHAR2 default hr_api.g_varchar2
253 ,p_attribute2 in VARCHAR2 default hr_api.g_varchar2
254 ,p_attribute3 in VARCHAR2 default hr_api.g_varchar2
255 ,p_attribute4 in VARCHAR2 default hr_api.g_varchar2
256 ,p_attribute5 in VARCHAR2 default hr_api.g_varchar2
257 ,p_attribute6 in VARCHAR2 default hr_api.g_varchar2
258 ,p_attribute7 in VARCHAR2 default hr_api.g_varchar2
259 ,p_attribute8 in VARCHAR2 default hr_api.g_varchar2
260 ,p_attribute9 in VARCHAR2 default hr_api.g_varchar2
261 ,p_attribute10 in VARCHAR2 default hr_api.g_varchar2
262 ,p_attribute11 in VARCHAR2 default hr_api.g_varchar2
263 ,p_attribute12 in VARCHAR2 default hr_api.g_varchar2
264 ,p_attribute13 in VARCHAR2 default hr_api.g_varchar2
265 ,p_attribute14 in VARCHAR2 default hr_api.g_varchar2
266 ,p_attribute15 in VARCHAR2 default hr_api.g_varchar2
267 ,p_attribute16 in VARCHAR2 default hr_api.g_varchar2
268 ,p_attribute17 in VARCHAR2 default hr_api.g_varchar2
269 ,p_attribute18 in VARCHAR2 default hr_api.g_varchar2
270 ,p_attribute19 in VARCHAR2 default hr_api.g_varchar2
271 ,p_attribute20 in VARCHAR2 default hr_api.g_varchar2
272 ,p_date_start in DATE default hr_api.g_date
273 ,p_type in VARCHAR2 default hr_api.g_varchar2
274 ,p_party_id in NUMBER default hr_api.g_number
275 ,p_event_id in out nocopy NUMBER
276 ,p_object_version_number in out nocopy NUMBER
277 );
278 --
279 -- ----------------------------------------------------------------------------
280 -- |-------------------------------< delete_event >---------------------------|
281 -- ----------------------------------------------------------------------------
282 --
283 -- {Start Of Comments}
284 /*#
285 * This API deletes a standard or interview event.
286 *
287 * Use this API to delete a standard event, employee review, or applicant
288 * interview.
289 *
290 * <p><b>Licensing</b><br>
291 * This API is licensed for use with Human Resources and iRecruitment.
292 *
293 * <p><b>Prerequisites</b><br>
294 * The event must have already been created.
295 *
296 * <p><b>Post Success</b><br>
297 * The event will have been deleted.
298 *
299 * <p><b>Post Failure</b><br>
300 * The event will not be deleted and an error will be raised.
301 * @param p_validate If true, then validation alone will be performed and the
302 * database will remain unchanged. If false and all validation checks pass,
303 * then the database will be modified.
304 * @param p_event_id Uniquely identifies the event that will be deleted.
305 * @param p_object_version_number Current version number of the Event to be
306 * deleted.
307 * @rep:displayname Delete Event
308 * @rep:category BUSINESS_ENTITY HR_EVENT
309 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
310 * @rep:scope public
311 * @rep:lifecycle active
312 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
313 */
314 --
315 -- {End Of Comments}
316 --
317 procedure delete_event
318 (p_validate in boolean default false
319 ,p_event_id in number
320 ,p_object_version_number in number
321 );
322
323 end per_events_api;
[Home] [Help]