1 Package hr_std_hol_abs_api as
2 /* $Header: peshaapi.pkh 120.1 2005/10/02 02:24:12 aroussel $ */
3 /*#
4 * This package contains Standard Holiday Absence APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Standard Holiday Absence
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_std_hol_abs >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a standard holiday absence for a person.
17 *
18 * Use this API to record the statutory holidays a person works, and if a
19 * person elects to take another day off in lieu of this holiday.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The person for which the standard holiday absence will be created must exist
26 * and be effective.
27 *
28 * <p><b>Post Success</b><br>
29 * The standard holiday absence will have been created.
30 *
31 * <p><b>Post Failure</b><br>
32 * The standard holiday absence will not be created and an error will be
33 * raised.
34 * @param p_date_not_taken Date of the standard holiday when the person worked.
35 * @param p_person_id Identifies the person for whom you create the Standard
36 * Holiday Absence record.
37 * @param p_standard_holiday_id Uniquely identifies the standard holiday when
38 * the person worked.
39 * @param p_actual_date_taken Date the person elected to take another day off
40 * in lieu of a standard holiday.
41 * @param p_reason The reason for the holiday absence.
42 * @param p_expired Specifies if the standard holiday absence has expired.
43 * Valid values are 'Y' (it has expired) or 'N' (it has not expired).
44 * @param p_attribute_category This context value determines which flexfield
45 * structure to use with the descriptive flexfield segments.
46 * @param p_attribute1 Descriptive flexfield segment.
47 * @param p_attribute2 Descriptive flexfield segment.
48 * @param p_attribute3 Descriptive flexfield segment.
49 * @param p_attribute4 Descriptive flexfield segment.
50 * @param p_attribute5 Descriptive flexfield segment.
51 * @param p_attribute6 Descriptive flexfield segment.
52 * @param p_attribute7 Descriptive flexfield segment.
53 * @param p_attribute8 Descriptive flexfield segment.
54 * @param p_attribute9 Descriptive flexfield segment.
55 * @param p_attribute10 Descriptive flexfield segment.
56 * @param p_attribute11 Descriptive flexfield segment.
57 * @param p_attribute12 Descriptive flexfield segment.
58 * @param p_attribute13 Descriptive flexfield segment.
59 * @param p_attribute14 Descriptive flexfield segment.
60 * @param p_attribute15 Descriptive flexfield segment.
61 * @param p_attribute16 Descriptive flexfield segment.
62 * @param p_attribute17 Descriptive flexfield segment.
63 * @param p_attribute18 Descriptive flexfield segment.
64 * @param p_attribute19 Descriptive flexfield segment.
65 * @param p_attribute20 Descriptive flexfield segment.
66 * @param p_validate If true, then validation alone will be performed and the
67 * database will remain unchanged. If false and all validation checks pass,
68 * then the database will be modified.
69 * @param p_effective_date Reference date for validating lookup values are
70 * applicable during the start to end active date range. This date does not
71 * determine when the changes take effect.
72 * @param p_object_version_number If p_validate is false, then set to the
73 * version number of the created Standard Holiday Absence. If p_validate is
74 * true, then the value will be null.
75 * @param p_std_holiday_absences_id If p_validate is false, then this uniquely
76 * identifies the Standard Holiday Absence. If p_validate is true, then this is
77 * set to null.
78 * @rep:displayname Create Standard Holiday Absence
79 * @rep:category BUSINESS_ENTITY HR_CALENDAR_EVENT
80 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
81 * @rep:scope public
82 * @rep:lifecycle active
83 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
84 */
85 --
86 -- {End Of Comments}
87 --
88 procedure create_std_hol_abs
89 (p_date_not_taken in date,
90 p_person_id in number,
91 p_standard_holiday_id in number,
92 p_actual_date_taken in date default null,
93 p_reason in varchar2 default null,
94 p_expired in varchar2 default null,
95 p_attribute_category in varchar2 default null,
96 p_attribute1 in varchar2 default null,
97 p_attribute2 in varchar2 default null,
98 p_attribute3 in varchar2 default null,
99 p_attribute4 in varchar2 default null,
100 p_attribute5 in varchar2 default null,
101 p_attribute6 in varchar2 default null,
102 p_attribute7 in varchar2 default null,
103 p_attribute8 in varchar2 default null,
104 p_attribute9 in varchar2 default null,
105 p_attribute10 in varchar2 default null,
106 p_attribute11 in varchar2 default null,
107 p_attribute12 in varchar2 default null,
108 p_attribute13 in varchar2 default null,
109 p_attribute14 in varchar2 default null,
110 p_attribute15 in varchar2 default null,
111 p_attribute16 in varchar2 default null,
112 p_attribute17 in varchar2 default null,
113 p_attribute18 in varchar2 default null,
114 p_attribute19 in varchar2 default null,
115 p_attribute20 in varchar2 default null,
116 p_validate in boolean default false,
117 p_effective_date in date,
118 p_object_version_number out nocopy number,
119 p_std_holiday_absences_id out nocopy number);
120 --
121 -- ----------------------------------------------------------------------------
122 -- |----------------------------< update_std_hol_abs >------------------------|
123 -- ----------------------------------------------------------------------------
124 --
125 -- {Start Of Comments}
126 /*#
127 * This API updates a standard holiday absence for a person.
128 *
129 * Use this API to update the statutory holidays a person works, and if a
130 * person elects to take another day off in lieu of this holiday.
131 *
132 * <p><b>Licensing</b><br>
133 * This API is licensed for use with Human Resources.
134 *
135 * <p><b>Prerequisites</b><br>
136 * The Standard Holiday Absence must already exist.
137 *
138 * <p><b>Post Success</b><br>
139 * The standard holiday absence will have been updated.
140 *
141 * <p><b>Post Failure</b><br>
142 * The standard holiday absence will not be updated and an error will be
143 * raised.
144 * @param p_std_holiday_absences_id Uniquely identifies the standard holiday
145 * absence that is being updated.
146 * @param p_date_not_taken Date of the standard holiday when the person worked.
147 * @param p_standard_holiday_id Uniquely identifies the standard holiday when
148 * the person worked.
149 * @param p_actual_date_taken Date the person elected to take another day off
150 * in lieu of a standard holiday.
151 * @param p_reason The reason for the holiday absence.
152 * @param p_expired Specifies if the standard holiday absence has expired.
153 * Valid values are 'Y' (it has expired) or 'N' (it has not expired).
154 * @param p_attribute_category This context value determines which flexfield
155 * structure to use with the descriptive flexfield segments.
156 * @param p_attribute1 Descriptive flexfield segment.
157 * @param p_attribute2 Descriptive flexfield segment.
158 * @param p_attribute3 Descriptive flexfield segment.
159 * @param p_attribute4 Descriptive flexfield segment.
160 * @param p_attribute5 Descriptive flexfield segment.
161 * @param p_attribute6 Descriptive flexfield segment.
162 * @param p_attribute7 Descriptive flexfield segment.
163 * @param p_attribute8 Descriptive flexfield segment.
164 * @param p_attribute9 Descriptive flexfield segment.
165 * @param p_attribute10 Descriptive flexfield segment.
166 * @param p_attribute11 Descriptive flexfield segment.
167 * @param p_attribute12 Descriptive flexfield segment.
168 * @param p_attribute13 Descriptive flexfield segment.
169 * @param p_attribute14 Descriptive flexfield segment.
170 * @param p_attribute15 Descriptive flexfield segment.
171 * @param p_attribute16 Descriptive flexfield segment.
172 * @param p_attribute17 Descriptive flexfield segment.
173 * @param p_attribute18 Descriptive flexfield segment.
174 * @param p_attribute19 Descriptive flexfield segment.
175 * @param p_attribute20 Descriptive flexfield segment.
176 * @param p_object_version_number Pass in the current version number of the
177 * Standard Holiday Absence to be updated. When the API completes if p_validate
178 * is false, will be set to the new version number of the updated Standard
179 * Holiday Absence. If p_validate is true will be set to the same value which
180 * was passed in.
181 * @param p_validate If true, then validation alone will be performed and the
182 * database will remain unchanged. If false and all validation checks pass,
183 * then the database will be modified.
184 * @param p_effective_date Reference date for validating lookup values are
185 * applicable during the start to end active date range. This date does not
186 * determine when the changes take effect.
187 * @rep:displayname Update Standard Holiday Absence
188 * @rep:category BUSINESS_ENTITY HR_CALENDAR_EVENT
189 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
190 * @rep:scope public
191 * @rep:lifecycle active
192 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
193 */
194 --
195 -- {End Of Comments}
196 --
197 procedure update_std_hol_abs
198 (p_std_holiday_absences_id in number,
199 p_date_not_taken in date default hr_api.g_date,
200 p_standard_holiday_id in number default hr_api.g_number,
201 p_actual_date_taken in date default hr_api.g_date,
202 p_reason in varchar2 default hr_api.g_varchar2,
203 p_expired in varchar2 default hr_api.g_varchar2,
204 p_attribute_category in varchar2 default hr_api.g_varchar2,
205 p_attribute1 in varchar2 default hr_api.g_varchar2,
206 p_attribute2 in varchar2 default hr_api.g_varchar2,
207 p_attribute3 in varchar2 default hr_api.g_varchar2,
208 p_attribute4 in varchar2 default hr_api.g_varchar2,
209 p_attribute5 in varchar2 default hr_api.g_varchar2,
210 p_attribute6 in varchar2 default hr_api.g_varchar2,
211 p_attribute7 in varchar2 default hr_api.g_varchar2,
212 p_attribute8 in varchar2 default hr_api.g_varchar2,
213 p_attribute9 in varchar2 default hr_api.g_varchar2,
214 p_attribute10 in varchar2 default hr_api.g_varchar2,
215 p_attribute11 in varchar2 default hr_api.g_varchar2,
216 p_attribute12 in varchar2 default hr_api.g_varchar2,
217 p_attribute13 in varchar2 default hr_api.g_varchar2,
218 p_attribute14 in varchar2 default hr_api.g_varchar2,
219 p_attribute15 in varchar2 default hr_api.g_varchar2,
220 p_attribute16 in varchar2 default hr_api.g_varchar2,
221 p_attribute17 in varchar2 default hr_api.g_varchar2,
222 p_attribute18 in varchar2 default hr_api.g_varchar2,
223 p_attribute19 in varchar2 default hr_api.g_varchar2,
224 p_attribute20 in varchar2 default hr_api.g_varchar2,
225 p_object_version_number in out nocopy number,
226 p_validate in boolean default false,
227 p_effective_date in date
228 );
229 --
230 -- ----------------------------------------------------------------------------
231 -- |----------------------------< delete_std_hol_abs >------------------------|
232 -- ----------------------------------------------------------------------------
233 --
234 -- {Start Of Comments}
235 /*#
236 * This API deletes a standard holiday absence for a person.
237 *
238 * A standard holiday absence records the statutory holidays a person works and
239 * if a person elects to take another day off in lieu of this holiday.
240 *
241 * <p><b>Licensing</b><br>
242 * This API is licensed for use with Human Resources.
243 *
244 * <p><b>Prerequisites</b><br>
245 * The Standard Holiday Absence must already exist.
246 *
247 * <p><b>Post Success</b><br>
248 * The standard holiday absence will have been deleted.
249 *
250 * <p><b>Post Failure</b><br>
251 * The standard holiday absence will not be deleted and an error will be
252 * raised.
253 * @param p_validate If true, then validation alone will be performed and the
254 * database will remain unchanged. If false and all validation checks pass,
255 * then the database will be modified.
256 * @param p_std_holiday_absences_id Uniquely identifies the standard holiday
257 * absence that is being deleted.
258 * @param p_object_version_number Current version number of the Standard
259 * Holiday Absence to be deleted.
260 * @rep:displayname Delete Standard Holiday Absence
261 * @rep:category BUSINESS_ENTITY HR_CALENDAR_EVENT
262 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
263 * @rep:scope public
264 * @rep:lifecycle active
265 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
266 */
267 --
268 -- {End Of Comments}
269 --
270 procedure delete_std_hol_abs
271 (p_validate in boolean default false
272 ,p_std_holiday_absences_id in number
273 ,p_object_version_number in number
274 );
275 --
276 end hr_std_hol_abs_api;
[Home] [Help]