1 Package IRC_NOTIFICATION_PREFS_API AUTHID CURRENT_USER as
2 /* $Header: irinpapi.pkh 120.4 2008/02/21 14:16:27 viviswan noship $ */
3 /*#
4 * This package contains Notification Preferences APIs.
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Notification Preferences
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_notification_prefs >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates notification preferences for a person.
17 *
18 * These notification preferences are used for recruiting purposes only.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with iRecruitment.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The person must already exist
25 *
26 * <p><b>Post Success</b><br>
27 * The notification preferences will be created in the database
28 *
29 * <p><b>Post Failure</b><br>
30 * The notification preferences will not be created in the database and an
31 * error will be raised
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_person_id Identifies the person for whom you create the
36 * notification preferences record.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_address_id The existing address that is used for recruiting
41 * purposes
42 * @param p_matching_jobs Indicates if the person wants to receive emails about
43 * matching jobs (Y or N)
44 * @param p_matching_job_freq The number of days between receiving emails about
45 * matching jobs. Valid values are defined by 'IRC_MESSAGE_FREQ' lookup type.
46 * @param p_allow_access Indicates if managers may search for the person for
47 * recruiting (Y or N)
48 * @param p_receive_info_mail Indicates if the person wants to receive general
49 * recruiting emails (Y or N)
50 * @param p_attribute_category This context value determines which flexfield
51 * structure to use with the descriptive flexfield segments.
52 * @param p_attribute1 Descriptive flexfield segment.
53 * @param p_attribute2 Descriptive flexfield segment.
54 * @param p_attribute3 Descriptive flexfield segment.
55 * @param p_attribute4 Descriptive flexfield segment.
56 * @param p_attribute5 Descriptive flexfield segment.
57 * @param p_attribute6 Descriptive flexfield segment.
58 * @param p_attribute7 Descriptive flexfield segment.
59 * @param p_attribute8 Descriptive flexfield segment.
60 * @param p_attribute9 Descriptive flexfield segment.
61 * @param p_attribute10 Descriptive flexfield segment.
62 * @param p_attribute11 Descriptive flexfield segment.
63 * @param p_attribute12 Descriptive flexfield segment.
64 * @param p_attribute13 Descriptive flexfield segment.
65 * @param p_attribute14 Descriptive flexfield segment.
66 * @param p_attribute15 Descriptive flexfield segment.
67 * @param p_attribute16 Descriptive flexfield segment.
68 * @param p_attribute17 Descriptive flexfield segment.
69 * @param p_attribute18 Descriptive flexfield segment.
70 * @param p_attribute19 Descriptive flexfield segment.
71 * @param p_attribute20 Descriptive flexfield segment.
72 * @param p_attribute21 Descriptive flexfield segment.
73 * @param p_attribute22 Descriptive flexfield segment.
74 * @param p_attribute23 Descriptive flexfield segment.
75 * @param p_attribute24 Descriptive flexfield segment.
76 * @param p_attribute25 Descriptive flexfield segment.
77 * @param p_attribute26 Descriptive flexfield segment.
78 * @param p_attribute27 Descriptive flexfield segment.
79 * @param p_attribute28 Descriptive flexfield segment.
80 * @param p_attribute29 Descriptive flexfield segment.
81 * @param p_attribute30 Descriptive flexfield segment.
82 * @param p_notification_preference_id If p_validate is false, then this
83 * uniquely identifies the notification preferences created. If p_validate is
84 * true, then set to null.
85 * @param p_object_version_number If p_validate is false, then set to the
86 * version number of the created notification preferences. If p_validate is
87 * true, then the value will be null.
88 * @param p_agency_id Identifies the agency.
89 * @param p_attempt_id Identifies the registration assessment attempt.
90 * @rep:displayname Create Notification Preferences
91 * @rep:category BUSINESS_ENTITY IRC_CANDIDATE_NOTIFY_PREFS
92 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
93 * @rep:scope public
94 * @rep:lifecycle active
95 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
96 */
97 --
98 -- {End Of Comments}
99 --
100 procedure CREATE_NOTIFICATION_PREFS
101 (p_validate in boolean default false
102 ,p_person_id in number
103 ,p_effective_date in date
104 ,p_address_id in number default null
105 ,p_matching_jobs in varchar2 default 'N'
106 ,p_matching_job_freq in varchar2 default '1'
107 ,p_allow_access in varchar2 default 'N'
108 ,p_receive_info_mail in varchar2 default 'N'
109 ,p_attribute_category in varchar2 default null
110 ,p_attribute1 in varchar2 default null
111 ,p_attribute2 in varchar2 default null
112 ,p_attribute3 in varchar2 default null
113 ,p_attribute4 in varchar2 default null
114 ,p_attribute5 in varchar2 default null
115 ,p_attribute6 in varchar2 default null
116 ,p_attribute7 in varchar2 default null
117 ,p_attribute8 in varchar2 default null
118 ,p_attribute9 in varchar2 default null
119 ,p_attribute10 in varchar2 default null
120 ,p_attribute11 in varchar2 default null
121 ,p_attribute12 in varchar2 default null
122 ,p_attribute13 in varchar2 default null
123 ,p_attribute14 in varchar2 default null
124 ,p_attribute15 in varchar2 default null
125 ,p_attribute16 in varchar2 default null
126 ,p_attribute17 in varchar2 default null
127 ,p_attribute18 in varchar2 default null
128 ,p_attribute19 in varchar2 default null
129 ,p_attribute20 in varchar2 default null
130 ,p_attribute21 in varchar2 default null
131 ,p_attribute22 in varchar2 default null
132 ,p_attribute23 in varchar2 default null
133 ,p_attribute24 in varchar2 default null
134 ,p_attribute25 in varchar2 default null
135 ,p_attribute26 in varchar2 default null
136 ,p_attribute27 in varchar2 default null
137 ,p_attribute28 in varchar2 default null
138 ,p_attribute29 in varchar2 default null
139 ,p_attribute30 in varchar2 default null
140 ,p_agency_id in number default null
141 ,p_attempt_id in number default null
142 ,p_notification_preference_id out nocopy number
143 ,p_object_version_number out nocopy number
144 );
145 --
146 -- ----------------------------------------------------------------------------
147 -- |------------------------< update_notification_prefs >---------------------|
148 -- ----------------------------------------------------------------------------
149 --
150 -- {Start Of Comments}
151 /*#
152 * This API updates notification preferences for a person.
153 *
154 * These notification preferences are only used for recruiting purposes.
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with iRecruitment.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The notification preferences must already exist
161 *
162 * <p><b>Post Success</b><br>
163 * The notification preferences will be updated in the database
164 *
165 * <p><b>Post Failure</b><br>
166 * The notification preferences will not be updated in the database and an
167 * error will be raised
168 * @param p_validate If true, then validation alone will be performed and the
169 * database will remain unchanged. If false and all validation checks pass,
170 * then the database will be modified.
171 * @param p_party_id Obsolete parameter. Do not use
172 * @param p_person_id Identifies the person for whom you update the
173 * notification preferences record.
174 * @param p_effective_date Reference date for validating lookup values are
175 * applicable during the start to end active date range. This date does not
176 * determine when the changes take effect.
177 * @param p_matching_jobs Indicates if the person wants to receive emails about
178 * matching jobs (Y or N)
179 * @param p_matching_job_freq The number of days between receiving emails about
180 * matching jobs. Valid values are defined by 'IRC_MESSAGE_FREQ' lookup type.
181 * @param p_allow_access Indicates if managers may search for the person for
182 * recruiting (Y or N)
183 * @param p_receive_info_mail Indicates if the person wants to receive general
184 * recruiting emails (Y or N)
185 * @param p_address_id The existing address that is used for recruiting
186 * purposes
187 * @param p_attribute_category This context value determines which flexfield
188 * structure to use with the descriptive flexfield segments.
189 * @param p_attribute1 Descriptive flexfield segment.
190 * @param p_attribute2 Descriptive flexfield segment.
191 * @param p_attribute3 Descriptive flexfield segment.
192 * @param p_attribute4 Descriptive flexfield segment.
193 * @param p_attribute5 Descriptive flexfield segment.
194 * @param p_attribute6 Descriptive flexfield segment.
195 * @param p_attribute7 Descriptive flexfield segment.
196 * @param p_attribute8 Descriptive flexfield segment.
197 * @param p_attribute9 Descriptive flexfield segment.
198 * @param p_attribute10 Descriptive flexfield segment.
199 * @param p_attribute11 Descriptive flexfield segment.
200 * @param p_attribute12 Descriptive flexfield segment.
201 * @param p_attribute13 Descriptive flexfield segment.
202 * @param p_attribute14 Descriptive flexfield segment.
203 * @param p_attribute15 Descriptive flexfield segment.
204 * @param p_attribute16 Descriptive flexfield segment.
205 * @param p_attribute17 Descriptive flexfield segment.
206 * @param p_attribute18 Descriptive flexfield segment.
207 * @param p_attribute19 Descriptive flexfield segment.
208 * @param p_attribute20 Descriptive flexfield segment.
209 * @param p_attribute21 Descriptive flexfield segment.
210 * @param p_attribute22 Descriptive flexfield segment.
211 * @param p_attribute23 Descriptive flexfield segment.
212 * @param p_attribute24 Descriptive flexfield segment.
213 * @param p_attribute25 Descriptive flexfield segment.
214 * @param p_attribute26 Descriptive flexfield segment.
215 * @param p_attribute27 Descriptive flexfield segment.
216 * @param p_attribute28 Descriptive flexfield segment.
217 * @param p_attribute29 Descriptive flexfield segment.
218 * @param p_attribute30 Descriptive flexfield segment.
219 * @param p_notification_preference_id Identifies the notification preferences
220 * to be updated
221 * @param p_object_version_number Pass in the current version number of the
222 * notification preferences to be updated. When the API completes if p_validate
223 * is false, will be set to the new version number of the updated notification
224 * preferences. If p_validate is true will be set to the same value which was
225 * passed in.
226 * @param p_agency_id Identifies the agency.
227 * @param p_attempt_id Identifies the registration assessment attempt.
228 * @rep:displayname Update Notification Preferences
229 * @rep:category BUSINESS_ENTITY IRC_CANDIDATE_NOTIFY_PREFS
230 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
231 * @rep:scope public
232 * @rep:lifecycle active
233 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
234 */
235 --
236 -- {End Of Comments}
237 --
238 procedure UPDATE_NOTIFICATION_PREFS
239 (p_validate in boolean default false
240 ,p_party_id in number default hr_api.g_number
241 ,p_person_id in number default hr_api.g_number
242 ,p_effective_date in date
243 ,p_matching_jobs in varchar2 default hr_api.g_varchar2
244 ,p_matching_job_freq in varchar2 default hr_api.g_varchar2
245 ,p_allow_access in varchar2 default hr_api.g_varchar2
246 ,p_receive_info_mail in varchar2 default hr_api.g_varchar2
247 ,p_address_id in number default hr_api.g_number
248 ,p_attribute_category in varchar2 default hr_api.g_varchar2
249 ,p_attribute1 in varchar2 default hr_api.g_varchar2
250 ,p_attribute2 in varchar2 default hr_api.g_varchar2
251 ,p_attribute3 in varchar2 default hr_api.g_varchar2
252 ,p_attribute4 in varchar2 default hr_api.g_varchar2
253 ,p_attribute5 in varchar2 default hr_api.g_varchar2
254 ,p_attribute6 in varchar2 default hr_api.g_varchar2
255 ,p_attribute7 in varchar2 default hr_api.g_varchar2
256 ,p_attribute8 in varchar2 default hr_api.g_varchar2
257 ,p_attribute9 in varchar2 default hr_api.g_varchar2
258 ,p_attribute10 in varchar2 default hr_api.g_varchar2
259 ,p_attribute11 in varchar2 default hr_api.g_varchar2
260 ,p_attribute12 in varchar2 default hr_api.g_varchar2
261 ,p_attribute13 in varchar2 default hr_api.g_varchar2
262 ,p_attribute14 in varchar2 default hr_api.g_varchar2
263 ,p_attribute15 in varchar2 default hr_api.g_varchar2
264 ,p_attribute16 in varchar2 default hr_api.g_varchar2
265 ,p_attribute17 in varchar2 default hr_api.g_varchar2
266 ,p_attribute18 in varchar2 default hr_api.g_varchar2
267 ,p_attribute19 in varchar2 default hr_api.g_varchar2
268 ,p_attribute20 in varchar2 default hr_api.g_varchar2
269 ,p_attribute21 in varchar2 default hr_api.g_varchar2
270 ,p_attribute22 in varchar2 default hr_api.g_varchar2
271 ,p_attribute23 in varchar2 default hr_api.g_varchar2
272 ,p_attribute24 in varchar2 default hr_api.g_varchar2
273 ,p_attribute25 in varchar2 default hr_api.g_varchar2
274 ,p_attribute26 in varchar2 default hr_api.g_varchar2
275 ,p_attribute27 in varchar2 default hr_api.g_varchar2
276 ,p_attribute28 in varchar2 default hr_api.g_varchar2
277 ,p_attribute29 in varchar2 default hr_api.g_varchar2
278 ,p_attribute30 in varchar2 default hr_api.g_varchar2
279 ,p_notification_preference_id in number
280 ,p_agency_id in number default hr_api.g_number
281 ,p_attempt_id in number default hr_api.g_number
282 ,p_object_version_number in out nocopy number
283 );
284 --
285 -- ----------------------------------------------------------------------------
286 -- |------------------------< delete_notification_prefs >---------------------|
287 -- ----------------------------------------------------------------------------
288 --
289 -- {Start Of Comments}
290 /*#
291 * This API deletes notification preferences for a person.
292 *
293 *
294 * <p><b>Licensing</b><br>
295 * This API is licensed for use with iRecruitment.
296 *
297 * <p><b>Prerequisites</b><br>
298 * The notification preferences must already exist
299 *
300 * <p><b>Post Success</b><br>
301 * The notification preferences will be deleted from the database
302 *
303 * <p><b>Post Failure</b><br>
304 * The notification preferences will not be deleted from the database and an
305 * error will be raised
306 * @param p_validate If true, then validation alone will be performed and the
307 * database will remain unchanged. If false and all validation checks pass,
308 * then the database will be modified.
309 * @param p_notification_preference_id Identifies the notification preferences
310 * to be deleted
311 * @param p_object_version_number Current version number of the notification
312 * preferences to be deleted.
313 * @rep:displayname Delete Notification Preferences
314 * @rep:category BUSINESS_ENTITY IRC_CANDIDATE_NOTIFY_PREFS
315 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
316 * @rep:scope public
317 * @rep:lifecycle active
318 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
319 */
320 --
321 -- {End Of Comments}
322 --
323 procedure DELETE_NOTIFICATION_PREFS
324 (p_validate in boolean default false
325 ,p_notification_preference_id in number
326 ,p_object_version_number in number
327 );
328 --
329 end IRC_NOTIFICATION_PREFS_API;
[Home] [Help]