1 Package PER_ESTAB_ATTENDANCES_API as
2 /* $Header: peesaapi.pkh 120.1 2005/10/02 02:16:54 aroussel $ */
3 /*#
4 * This package contains HR Establishment Attendance APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Establishment Attendance
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_attended_estab >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an establishment attendance record for a person.
17 *
18 * Use this API to record the details of a person's attendance at schools,
19 * colleges and other establishments, including the attendance dates and if
20 * they were full-time.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources and iRecruitment.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The person must already exist. The establishment they attended must have
27 * already been created.
28 *
29 * <p><b>Post Success</b><br>
30 * The establishment attendance will have been created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The establishment attendance will not be created and an error will be
34 * raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_fulltime Specifies if the person attended the establishment full
42 * time. Valid values are defined by the 'YES_NO' lookup type.
43 * @param p_attended_start_date Date attendance started.
44 * @param p_attended_end_date Date attendance ended.
45 * @param p_establishment Name of the establishment. Specify a value when the
46 * establishment does not already exist in the database. If the establishment
47 * already exists, use p_establishment_id.
48 * @param p_business_group_id The business group under which the establishment
49 * attendance will be recorded. This is usually the same business group that
50 * the person belongs to.
51 * @param p_person_id Identifies the person for whom you create the
52 * Establishment Attendance record.
53 * @param p_party_id Party to whom the establishment attendance applies.
54 * @param p_address The address of the establishment.
55 * @param p_establishment_id Uniquely identifies an establishment that already
56 * exists in the database. If an establishment does not already exist, you can
57 * specify p_establishment (a free-format text field that is not validated).
58 * @param p_attribute_category This context value determines which flexfield
59 * structure to use with the descriptive flexfield segments.
60 * @param p_attribute1 Descriptive flexfield segment.
61 * @param p_attribute2 Descriptive flexfield segment.
62 * @param p_attribute3 Descriptive flexfield segment.
63 * @param p_attribute4 Descriptive flexfield segment.
64 * @param p_attribute5 Descriptive flexfield segment.
65 * @param p_attribute6 Descriptive flexfield segment.
66 * @param p_attribute7 Descriptive flexfield segment.
67 * @param p_attribute8 Descriptive flexfield segment.
68 * @param p_attribute9 Descriptive flexfield segment.
69 * @param p_attribute10 Descriptive flexfield segment.
70 * @param p_attribute11 Descriptive flexfield segment.
71 * @param p_attribute12 Descriptive flexfield segment.
72 * @param p_attribute13 Descriptive flexfield segment.
73 * @param p_attribute14 Descriptive flexfield segment.
74 * @param p_attribute15 Descriptive flexfield segment.
75 * @param p_attribute16 Descriptive flexfield segment.
76 * @param p_attribute17 Descriptive flexfield segment.
77 * @param p_attribute18 Descriptive flexfield segment.
78 * @param p_attribute19 Descriptive flexfield segment.
79 * @param p_attribute20 Descriptive flexfield segment.
80 * @param p_attendance_id If p_validate is false, then this uniquely identifies
81 * the establishment attendance. If p_validate is true, then this is set to
82 * null.
83 * @param p_object_version_number If p_validate is false, then set to the
84 * version number of the created establishment attendance record. If p_validate
85 * is true, then the value will be null.
86 * @rep:displayname Create Establishment Attendance
87 * @rep:category BUSINESS_ENTITY PER_ESTAB_ATTENDANCES
88 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
89 * @rep:scope public
90 * @rep:lifecycle active
91 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
92 */
93 --
94 -- {End Of Comments}
95 --
96 procedure CREATE_ATTENDED_ESTAB
97 (p_validate in boolean default false
98 ,p_effective_date in date
99 ,p_fulltime in varchar2
100 ,p_attended_start_date in date default null
101 ,p_attended_end_date in date default null
102 ,p_establishment in varchar2 default null
103 ,p_business_group_id in number default null
104 ,p_person_id in number default null
105 ,p_party_id in number default null
106 ,p_address in varchar2 default null
107 ,p_establishment_id in number default null
108 ,p_attribute_category in varchar2 default null
109 ,p_attribute1 in varchar2 default null
110 ,p_attribute2 in varchar2 default null
111 ,p_attribute3 in varchar2 default null
112 ,p_attribute4 in varchar2 default null
113 ,p_attribute5 in varchar2 default null
114 ,p_attribute6 in varchar2 default null
115 ,p_attribute7 in varchar2 default null
116 ,p_attribute8 in varchar2 default null
117 ,p_attribute9 in varchar2 default null
118 ,p_attribute10 in varchar2 default null
119 ,p_attribute11 in varchar2 default null
120 ,p_attribute12 in varchar2 default null
121 ,p_attribute13 in varchar2 default null
122 ,p_attribute14 in varchar2 default null
123 ,p_attribute15 in varchar2 default null
124 ,p_attribute16 in varchar2 default null
125 ,p_attribute17 in varchar2 default null
126 ,p_attribute18 in varchar2 default null
127 ,p_attribute19 in varchar2 default null
128 ,p_attribute20 in varchar2 default null
129 ,p_attendance_id out nocopy number
130 ,p_object_version_number out nocopy number
131 );
132 --
133 -- ----------------------------------------------------------------------------
134 -- |--------------------------< update_attended_estab >-----------------------|
135 -- ----------------------------------------------------------------------------
136 --
137 -- {Start Of Comments}
138 /*#
139 * This API updates an establishment attendance record for a person.
140 *
141 * Use this API to update the details of a person's attendance at schools,
142 * colleges and other establishments, including the attendance dates and if
143 * they were full-time.
144 *
145 * <p><b>Licensing</b><br>
146 * This API is licensed for use with Human Resources and iRecruitment.
147 *
148 * <p><b>Prerequisites</b><br>
149 * The establishment attendance record for this person must have already been
150 * created.
151 *
152 * <p><b>Post Success</b><br>
153 * The establishment attendance will have been updated.
154 *
155 * <p><b>Post Failure</b><br>
156 * The establishment attendance will not be updated and an error will be
157 * raised.
158 * @param p_validate If true, then validation alone will be performed and the
159 * database will remain unchanged. If false and all validation checks pass,
160 * then the database will be modified.
161 * @param p_effective_date Reference date for validating lookup values are
162 * applicable during the start to end active date range. This date does not
163 * determine when the changes take effect.
164 * @param p_attendance_id Uniquely identifies the establishment attendance that
165 * is being updated.
166 * @param p_fulltime Specifies if the person attended the establishment full
167 * time. Valid values are defined by the 'YES_NO' lookup type.
168 * @param p_attended_start_date Date attendance started.
169 * @param p_attended_end_date Date attendance ended.
170 * @param p_establishment Name of the establishment. Specify a value when the
171 * establishment does not already exist in the database. If the establishment
172 * already exists, use p_establishment_id.
173 * @param p_establishment_id Uniquely identifies an establishment that already
174 * exists in the database. If an establishment does not already exist, you can
175 * specify p_establishment (a free-format text field that is not validated).
176 * @param p_address The address of the establishment.
177 * @param p_attribute_category This context value determines which flexfield
178 * structure to use with the descriptive flexfield segments.
179 * @param p_attribute1 Descriptive flexfield segment.
180 * @param p_attribute2 Descriptive flexfield segment.
181 * @param p_attribute3 Descriptive flexfield segment.
182 * @param p_attribute4 Descriptive flexfield segment.
183 * @param p_attribute5 Descriptive flexfield segment.
184 * @param p_attribute6 Descriptive flexfield segment.
185 * @param p_attribute7 Descriptive flexfield segment.
186 * @param p_attribute8 Descriptive flexfield segment.
187 * @param p_attribute9 Descriptive flexfield segment.
188 * @param p_attribute10 Descriptive flexfield segment.
189 * @param p_attribute11 Descriptive flexfield segment.
190 * @param p_attribute12 Descriptive flexfield segment.
191 * @param p_attribute13 Descriptive flexfield segment.
192 * @param p_attribute14 Descriptive flexfield segment.
193 * @param p_attribute15 Descriptive flexfield segment.
194 * @param p_attribute16 Descriptive flexfield segment.
195 * @param p_attribute17 Descriptive flexfield segment.
196 * @param p_attribute18 Descriptive flexfield segment.
197 * @param p_attribute19 Descriptive flexfield segment.
198 * @param p_attribute20 Descriptive flexfield segment.
199 * @param p_object_version_number Pass in the current version number of the
200 * Establishment Attendance to be updated. When the API completes if p_validate
201 * is false, will be set to the new version number of the updated Establishment
202 * Attendance. If p_validate is true will be set to the same value which was
203 * passed in.
204 * @rep:displayname Update Establishment Attendance
205 * @rep:category BUSINESS_ENTITY PER_ESTAB_ATTENDANCES
206 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
207 * @rep:scope public
208 * @rep:lifecycle active
209 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
210 */
211 --
212 -- {End Of Comments}
213 --
214 procedure UPDATE_ATTENDED_ESTAB
215 (p_validate in boolean default false
216 ,p_effective_date in date
217 ,p_attendance_id in number
218 ,p_fulltime in varchar2
219 ,p_attended_start_date in date default hr_api.g_date
220 ,p_attended_end_date in date default hr_api.g_date
221 ,p_establishment in varchar2 default hr_api.g_varchar2
222 ,p_establishment_id in number default hr_api.g_number
223 ,p_address in varchar2 default hr_api.g_varchar2
224 ,p_attribute_category in varchar2 default hr_api.g_varchar2
225 ,p_attribute1 in varchar2 default hr_api.g_varchar2
226 ,p_attribute2 in varchar2 default hr_api.g_varchar2
227 ,p_attribute3 in varchar2 default hr_api.g_varchar2
228 ,p_attribute4 in varchar2 default hr_api.g_varchar2
229 ,p_attribute5 in varchar2 default hr_api.g_varchar2
230 ,p_attribute6 in varchar2 default hr_api.g_varchar2
231 ,p_attribute7 in varchar2 default hr_api.g_varchar2
232 ,p_attribute8 in varchar2 default hr_api.g_varchar2
233 ,p_attribute9 in varchar2 default hr_api.g_varchar2
234 ,p_attribute10 in varchar2 default hr_api.g_varchar2
235 ,p_attribute11 in varchar2 default hr_api.g_varchar2
236 ,p_attribute12 in varchar2 default hr_api.g_varchar2
237 ,p_attribute13 in varchar2 default hr_api.g_varchar2
238 ,p_attribute14 in varchar2 default hr_api.g_varchar2
239 ,p_attribute15 in varchar2 default hr_api.g_varchar2
240 ,p_attribute16 in varchar2 default hr_api.g_varchar2
241 ,p_attribute17 in varchar2 default hr_api.g_varchar2
242 ,p_attribute18 in varchar2 default hr_api.g_varchar2
243 ,p_attribute19 in varchar2 default hr_api.g_varchar2
244 ,p_attribute20 in varchar2 default hr_api.g_varchar2
245 ,p_object_version_number in out nocopy number
246 );
247 --
248 -- ----------------------------------------------------------------------------
249 -- |--------------------------< delete_attended_estab >-----------------------|
250 -- ----------------------------------------------------------------------------
251 --
252 -- {Start Of Comments}
253 /*#
254 * This API deletes one instance of a person's establishment attendance.
255 *
256 * Use this API to delete the record of a person's attendance at a particular
257 * establishment.
258 *
259 * <p><b>Licensing</b><br>
260 * This API is licensed for use with Human Resources and iRecruitment.
261 *
262 * <p><b>Prerequisites</b><br>
263 * The establishment attendance record for this person must have already been
264 * created.
265 *
266 * <p><b>Post Success</b><br>
267 * The establishment attendance will have been deleted.
268 *
269 * <p><b>Post Failure</b><br>
270 * The establishment attendance will not be deleted and an error will be
271 * raised.
272 * @param p_validate If true, then validation alone will be performed and the
273 * database will remain unchanged. If false and all validation checks pass,
274 * then the database will be modified.
275 * @param p_attendance_id Uniquely identifies the establishment attendance to
276 * be deleted.
277 * @param p_object_version_number Current version number of the Establishment
278 * Attendance to be deleted.
279 * @rep:displayname Delete Establishment Attendance
280 * @rep:category BUSINESS_ENTITY PER_ESTAB_ATTENDANCES
281 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
282 * @rep:scope public
283 * @rep:lifecycle active
284 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
285 */
286 --
287 -- {End Of Comments}
288 --
289 procedure DELETE_ATTENDED_ESTAB
290 (p_validate in boolean default false
291 ,p_attendance_id in number
292 ,p_object_version_number in number
293 );
294 --
295
296 end PER_ESTAB_ATTENDANCES_API;
[Home] [Help]