DBA Data[Home] [Help]

PACKAGE: APPS.IRC_RECRUITING_SITES_API

Source


1 Package IRC_RECRUITING_SITES_API AUTHID CURRENT_USER as
2 /* $Header: irrseapi.pkh 120.4 2010/03/05 12:50:02 sbadiger ship $ */
3 /*#
4  * This package contains APIs for recruiting sites.
5  * @rep:scope public
6  * @rep:product irc
7  * @rep:displayname Recruiting Site
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_recruiting_site >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a recruiting site.
17  *
18  * A recruiting site has information necessary to post adverts to third
19  * parties.
20  *
21  * <p><b>Licensing</b><br>
22  * This API is licensed for use with iRecruitment.
23  *
27  * <p><b>Post Success</b><br>
24  * <p><b>Prerequisites</b><br>
25  * No known prerequisites.
26  *
28  * The recruiting site will be created in the database
29  *
30  * <p><b>Post Failure</b><br>
31  * The recruiting site will not be created in the database and an error will be
32  * raised
33  * @param p_validate If true, then validation alone will be performed and the
34  * database will remain unchanged. If false and all validation checks pass,
35  * then the database will be modified.
36  * @param p_language_code Specifies to which language the translation values
37  * apply. You can set to the base or any installed language. The default value
38  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
39  * value.
40  * @param p_effective_date Reference date for validating lookup values are
41  * applicable during the start to end active date range. This date does not
42  * determine when the changes take effect.
43  * @param p_site_name The name of the recruiting site
44  * @param p_date_from The date from which the recruiting site can be used
45  * @param p_date_to The last date on which the recruiting site can be used
46  * @param p_posting_username The username for posting adverts to the third
47  * party recruiting site
48  * @param p_posting_password The password for posting adverts to the third
49  * party recruiting site
50  * @param p_internal Indicates that the recruiting site is for posting internal
51  * vacancies (Y or N)
52  * @param p_external Indicates that the recruiting site is for posting external
53  * vacancies (Y or N)
54  * @param p_third_party Indicates that the recruiting site is a third party
55  * recruiting site (Y or N)
56  * @param p_redirection_url Reserved for future use
57  * @param p_posting_url The URL for posting adverts to the third party
58  * recruiting site
59  * @param p_posting_cost The cost of posting to the third party recruiting site
60  * @param p_posting_cost_period The period that the cost of posting covers.
61  * Valid values are defined by 'IRC_POSTING_COST_FREQ' lookup type.
62  * @param p_posting_cost_currency The currency that the cost of posting is in
63  * @param p_stylesheet The optional XML stylesheet for conversion of the data
64  * format for posting to the third party recruiting site
65  * @param p_attribute_category This context value determines which flexfield
66  * structure to use with the descriptive flexfield segments.
67  * @param p_attribute1 Descriptive flexfield segment.
68  * @param p_attribute2 Descriptive flexfield segment.
69  * @param p_attribute3 Descriptive flexfield segment.
70  * @param p_attribute4 Descriptive flexfield segment.
71  * @param p_attribute5 Descriptive flexfield segment.
72  * @param p_attribute6 Descriptive flexfield segment.
73  * @param p_attribute7 Descriptive flexfield segment.
74  * @param p_attribute8 Descriptive flexfield segment.
75  * @param p_attribute9 Descriptive flexfield segment.
76  * @param p_attribute10 Descriptive flexfield segment.
77  * @param p_attribute11 Descriptive flexfield segment.
78  * @param p_attribute12 Descriptive flexfield segment.
79  * @param p_attribute13 Descriptive flexfield segment.
80  * @param p_attribute14 Descriptive flexfield segment.
81  * @param p_attribute15 Descriptive flexfield segment.
82  * @param p_attribute16 Descriptive flexfield segment.
83  * @param p_attribute17 Descriptive flexfield segment.
84  * @param p_attribute18 Descriptive flexfield segment.
85  * @param p_attribute19 Descriptive flexfield segment.
86  * @param p_attribute20 Descriptive flexfield segment.
87  * @param p_attribute21 Descriptive flexfield segment.
88  * @param p_attribute22 Descriptive flexfield segment.
89  * @param p_attribute23 Descriptive flexfield segment.
90  * @param p_attribute24 Descriptive flexfield segment.
91  * @param p_attribute25 Descriptive flexfield segment.
92  * @param p_attribute26 Descriptive flexfield segment.
93  * @param p_attribute27 Descriptive flexfield segment.
94  * @param p_attribute28 Descriptive flexfield segment.
95  * @param p_attribute29 Descriptive flexfield segment.
96  * @param p_attribute30 Descriptive flexfield segment.
97  * @param p_recruiting_site_id If p_validate is false, then this uniquely
98  * identifies the recruiting site created. If p_validate is true, then set to
99  * null.
100  * @param p_object_version_number If p_validate is false, then set to the
101  * version number of the created recruiting site. If p_validate is true, then
102  * the value will be null.
103  * @param p_posting_impl_class Posting Implementation Class Name
104  * @rep:displayname Create Recruiting Site
105  * @rep:category BUSINESS_ENTITY IRC_RECRUITING_SITE
106  * @rep:category BUSINESS_ENTITY IRC_RECRUITING_3RD_PARTY_SITE
107  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
108  * @rep:scope public
109  * @rep:lifecycle active
110  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
111 */
112 --
113 -- {End Of Comments}
114 --
115 procedure CREATE_RECRUITING_SITE
116   (p_validate                      in     boolean  default false
117   ,p_language_code                 in  varchar2   default hr_api.userenv_lang
118   ,p_effective_date                in     date
119   ,p_site_name                     in     varchar2
120   ,p_date_from                      in date default null
121   ,p_date_to                        in date default null
122   ,p_posting_username               in varchar2 default null
123   ,p_posting_password               in varchar2 default null
124   ,p_internal                      in     varchar2  default 'N'
125   ,p_external                      in     varchar2  default 'N'
126   ,p_third_party                   in     varchar2 default 'Y'
127   ,p_redirection_url               in     varchar2 default null
128   ,p_posting_url                   in     varchar2 default null
129   ,p_posting_cost                  in     number   default null
130   ,p_posting_cost_period           in     varchar2 default null
131   ,p_posting_cost_currency         in     varchar2 default null
132   ,p_stylesheet           in     varchar2 default null
133   ,p_attribute_category            in     varchar2 default null
134   ,p_attribute1                    in     varchar2 default null
135   ,p_attribute2                    in     varchar2 default null
136   ,p_attribute3                    in     varchar2 default null
137   ,p_attribute4                    in     varchar2 default null
138   ,p_attribute5                    in     varchar2 default null
139   ,p_attribute6                    in     varchar2 default null
140   ,p_attribute7                    in     varchar2 default null
141   ,p_attribute8                    in     varchar2 default null
142   ,p_attribute9                    in     varchar2 default null
143   ,p_attribute10                   in     varchar2 default null
144   ,p_attribute11                   in     varchar2 default null
145   ,p_attribute12                   in     varchar2 default null
146   ,p_attribute13                   in     varchar2 default null
147   ,p_attribute14                   in     varchar2 default null
148   ,p_attribute15                   in     varchar2 default null
149   ,p_attribute16                   in     varchar2 default null
150   ,p_attribute17                   in     varchar2 default null
151   ,p_attribute18                   in     varchar2 default null
152   ,p_attribute19                   in     varchar2 default null
153   ,p_attribute20                   in     varchar2 default null
154   ,p_attribute21                   in     varchar2 default null
155   ,p_attribute22                   in     varchar2 default null
156   ,p_attribute23                   in     varchar2 default null
157   ,p_attribute24                   in     varchar2 default null
158   ,p_attribute25                   in     varchar2 default null
159   ,p_attribute26                   in     varchar2 default null
160   ,p_attribute27                   in     varchar2 default null
161   ,p_attribute28                   in     varchar2 default null
162   ,p_attribute29                   in     varchar2 default null
163   ,p_attribute30                   in     varchar2 default null
164   ,p_recruiting_site_id               out nocopy number
165   ,p_object_version_number            out nocopy number
166   ,p_posting_impl_class            in     varchar2 default null
167   );
168 --
169 -- ----------------------------------------------------------------------------
170 -- |--------------------------< update_recruiting_site >----------------------|
171 -- ----------------------------------------------------------------------------
172 --
173 -- {Start Of Comments}
174 /*#
175  * This API updates a recruiting site.
176  *
177  * A recruiting site has information necessary to post adverts to third
178  * parties.
179  *
180  * <p><b>Licensing</b><br>
181  * This API is licensed for use with iRecruitment.
182  *
183  * <p><b>Prerequisites</b><br>
187  * The recruiting site will be updated in the database
184  * The recruiting site must already exist
185  *
186  * <p><b>Post Success</b><br>
188  *
189  * <p><b>Post Failure</b><br>
190  * The recruiting site will not be updated in the database and an error will be
191  * raised
192  * @param p_recruiting_site_id Identifies the recruiting site
193  * @param p_validate If true, then validation alone will be performed and the
194  * database will remain unchanged. If false and all validation checks pass,
195  * then the database will be modified.
196  * @param p_language_code Specifies to which language the translation values
197  * apply. You can set to the base or any installed language. The default value
198  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
199  * value.
200  * @param p_effective_date Reference date for validating lookup values are
201  * applicable during the start to end active date range. This date does not
202  * determine when the changes take effect.
203  * @param p_site_name The name of the recruiting site
204  * @param p_date_from The date from which the recruiting site can be used
205  * @param p_date_to The last date on which the recruiting site can be used
206  * @param p_posting_username The username for posting adverts to the third
207  * party recruiting site
208  * @param p_posting_password The password for posting adverts to the third
209  * party recruiting site
210  * @param p_internal Indicates that the recruiting site is for posting internal
211  * vacancies (Y or N)
212  * @param p_external Indicates that the recruiting site is for posting external
213  * vacancies (Y or N)
214  * @param p_third_party Indicates that the recruiting site is a third party
215  * recruiting site (Y or N)
216  * @param p_redirection_url Reserved for future use
217  * @param p_posting_url The URL for posting adverts to the third party
218  * recruiting site
219  * @param p_posting_cost The cost of posting to the third party recruiting site
220  * @param p_posting_cost_period The period that the cost of posting covers.
221  * Valid values are defined by 'IRC_POSTING_COST_FREQ' lookup type.
222  * @param p_posting_cost_currency The currency that the cost of posting is in
223  * @param p_stylesheet The optional XML stylesheet for conversion of the data
224  * format for posting to the third party recruiting site
225  * @param p_attribute_category This context value determines which flexfield
226  * structure to use with the descriptive flexfield segments.
227  * @param p_attribute1 Descriptive flexfield segment.
228  * @param p_attribute2 Descriptive flexfield segment.
229  * @param p_attribute3 Descriptive flexfield segment.
230  * @param p_attribute4 Descriptive flexfield segment.
231  * @param p_attribute5 Descriptive flexfield segment.
232  * @param p_attribute6 Descriptive flexfield segment.
233  * @param p_attribute7 Descriptive flexfield segment.
234  * @param p_attribute8 Descriptive flexfield segment.
235  * @param p_attribute9 Descriptive flexfield segment.
236  * @param p_attribute10 Descriptive flexfield segment.
237  * @param p_attribute11 Descriptive flexfield segment.
238  * @param p_attribute12 Descriptive flexfield segment.
239  * @param p_attribute13 Descriptive flexfield segment.
240  * @param p_attribute14 Descriptive flexfield segment.
241  * @param p_attribute15 Descriptive flexfield segment.
242  * @param p_attribute16 Descriptive flexfield segment.
243  * @param p_attribute17 Descriptive flexfield segment.
244  * @param p_attribute18 Descriptive flexfield segment.
245  * @param p_attribute19 Descriptive flexfield segment.
246  * @param p_attribute20 Descriptive flexfield segment.
247  * @param p_attribute21 Descriptive flexfield segment.
248  * @param p_attribute22 Descriptive flexfield segment.
249  * @param p_attribute23 Descriptive flexfield segment.
250  * @param p_attribute24 Descriptive flexfield segment.
251  * @param p_attribute25 Descriptive flexfield segment.
252  * @param p_attribute26 Descriptive flexfield segment.
253  * @param p_attribute27 Descriptive flexfield segment.
254  * @param p_attribute28 Descriptive flexfield segment.
255  * @param p_attribute29 Descriptive flexfield segment.
256  * @param p_attribute30 Descriptive flexfield segment.
257  * @param p_object_version_number Pass in the current version number of the
258  * recruiting site to be updated. When the API completes if p_validate is
259  * false, will be set to the new version number of the updated recruiting site.
260  * If p_validate is true will be set to the same value which was passed in.
261  * @param p_posting_impl_class Posting Implementation Class Name
262  * @rep:displayname Update Recruiting Site
263  * @rep:category BUSINESS_ENTITY IRC_RECRUITING_SITE
264  * @rep:category BUSINESS_ENTITY IRC_RECRUITING_3RD_PARTY_SITE
265  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
266  * @rep:scope public
267  * @rep:lifecycle active
268  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
269 */
270 --
271 -- {End Of Comments}
272 --
273 procedure UPDATE_RECRUITING_SITE
274   (p_recruiting_site_id            in     number
275   ,p_validate                      in     boolean  default false
276   ,p_language_code                 in     varchar2 default hr_api.userenv_lang
277   ,p_effective_date                in     date
278   ,p_site_name                     in     varchar2 default hr_api.g_varchar2
279   ,p_date_from                     in     date default hr_api.g_date
280   ,p_date_to                       in     date default hr_api.g_date
281   ,p_posting_username              in     varchar2 default hr_api.g_varchar2
282   ,p_posting_password              in     varchar2 default hr_api.g_varchar2
283   ,p_internal                      in     varchar2 default hr_api.g_varchar2
284   ,p_external                      in     varchar2 default hr_api.g_varchar2
285   ,p_third_party                   in     varchar2 default hr_api.g_varchar2
286   ,p_redirection_url               in     varchar2 default hr_api.g_varchar2
287   ,p_posting_url                   in     varchar2 default hr_api.g_varchar2
288   ,p_posting_cost                  in     number   default hr_api.g_number
289   ,p_posting_cost_period           in     varchar2 default hr_api.g_varchar2
290   ,p_posting_cost_currency         in     varchar2 default hr_api.g_varchar2
291   ,p_stylesheet           in     varchar2 default hr_api.g_varchar2
292   ,p_attribute_category            in     varchar2 default hr_api.g_varchar2
293   ,p_attribute1                    in     varchar2 default hr_api.g_varchar2
294   ,p_attribute2                    in     varchar2 default hr_api.g_varchar2
295   ,p_attribute3                    in     varchar2 default hr_api.g_varchar2
296   ,p_attribute4                    in     varchar2 default hr_api.g_varchar2
297   ,p_attribute5                    in     varchar2 default hr_api.g_varchar2
298   ,p_attribute6                    in     varchar2 default hr_api.g_varchar2
299   ,p_attribute7                    in     varchar2 default hr_api.g_varchar2
300   ,p_attribute8                    in     varchar2 default hr_api.g_varchar2
301   ,p_attribute9                    in     varchar2 default hr_api.g_varchar2
302   ,p_attribute10                   in     varchar2 default hr_api.g_varchar2
303   ,p_attribute11                   in     varchar2 default hr_api.g_varchar2
304   ,p_attribute12                   in     varchar2 default hr_api.g_varchar2
305   ,p_attribute13                   in     varchar2 default hr_api.g_varchar2
306   ,p_attribute14                   in     varchar2 default hr_api.g_varchar2
307   ,p_attribute15                   in     varchar2 default hr_api.g_varchar2
308   ,p_attribute16                   in     varchar2 default hr_api.g_varchar2
309   ,p_attribute17                   in     varchar2 default hr_api.g_varchar2
310   ,p_attribute18                   in     varchar2 default hr_api.g_varchar2
311   ,p_attribute19                   in     varchar2 default hr_api.g_varchar2
312   ,p_attribute20                   in     varchar2 default hr_api.g_varchar2
313   ,p_attribute21                   in     varchar2 default hr_api.g_varchar2
314   ,p_attribute22                   in     varchar2 default hr_api.g_varchar2
315   ,p_attribute23                   in     varchar2 default hr_api.g_varchar2
316   ,p_attribute24                   in     varchar2 default hr_api.g_varchar2
317   ,p_attribute25                   in     varchar2 default hr_api.g_varchar2
318   ,p_attribute26                   in     varchar2 default hr_api.g_varchar2
319   ,p_attribute27                   in     varchar2 default hr_api.g_varchar2
320   ,p_attribute28                   in     varchar2 default hr_api.g_varchar2
321   ,p_attribute29                   in     varchar2 default hr_api.g_varchar2
322   ,p_attribute30                   in     varchar2 default hr_api.g_varchar2
323   ,p_object_version_number         in out nocopy number
324   ,p_posting_impl_class            in     varchar2 default hr_api.g_varchar2
325   );
326 --
327 -- ----------------------------------------------------------------------------
328 -- |--------------------------< delete_recruiting_site >----------------------|
329 -- ----------------------------------------------------------------------------
330 --
331 -- {Start Of Comments}
332 /*#
333  * This API will delete a recruiting site.
334  *
335  *
336  * <p><b>Licensing</b><br>
337  * This API is licensed for use with iRecruitment.
338  *
339  * <p><b>Prerequisites</b><br>
340  * The recruiting site must already exist
341  *
342  * <p><b>Post Success</b><br>
343  * The recruiting site will be deleted from the database
344  *
345  * <p><b>Post Failure</b><br>
346  * The recruiting site will not be deleted from the database and an error will
347  * be raised
348  * @param p_validate If true, then validation alone will be performed and the
349  * database will remain unchanged. If false and all validation checks pass,
350  * then the database will be modified.
351  * @param p_recruiting_site_id Identifies the recruiting site
352  * @param p_object_version_number Current version number of the recruiting site
353  * to be deleted.
354  * @rep:displayname Delete Recruiting Site
355  * @rep:category BUSINESS_ENTITY IRC_RECRUITING_SITE
356  * @rep:category BUSINESS_ENTITY IRC_RECRUITING_3RD_PARTY_SITE
357  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
358  * @rep:scope public
359  * @rep:lifecycle active
360  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
361 */
362 --
363 -- {End Of Comments}
364 --
365 procedure DELETE_RECRUITING_SITE
366   (p_validate                      in     boolean  default false
367   ,p_recruiting_site_id            in     number
368   ,p_object_version_number         in     number
369   );
370 --
371 end IRC_RECRUITING_SITES_API;