1 Package irc_saved_search_criteria_api AUTHID CURRENT_USER as
2 /* $Header: irissapi.pkh 120.1 2008/02/21 14:26:50 viviswan noship $ */
3 /*#
4 * This package contains APIs for maintaining Saved Search Criteria
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Save Search Criteria
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_search_criteria >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new Search Criteria.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with iRecruitment.
21 *
22 * <p><b>Prerequisites</b><br>
23 * search criteria is created only for BGs that have Applicant
24 * Tracking enabled.
25 *
26 * <p><b>Post Success</b><br>
27 * Search Criteria is successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API does not create the Search Criteria and raises an error.
31 *
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
36 * @param p_vacancy_id Vacancy id of the Vacancy.
37 * @param p_saved_search_criteria_id If p_validate is false, then this uniquely
38 * identifies the Search Criteria created. If p_validate is true, then set to null.
39 * @param p_object_version_number If p_validate is false, then set to the
40 * version number of the created search criteria. If p_validate is true,
41 * then the value will be null.
42 * @rep:displayname Save Search Criteria
43 * @rep:category BUSINESS_ENTITY IRC_RECRUITMENT_CANDIDATE
44 * @rep:lifecycle active
45 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
46 * @rep:scope public
47 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
48 */
49 --
50 -- {End Of Comments}
51 --
52 procedure create_search_criteria
53 (p_validate in boolean default false
54 ,p_vacancy_id in number
55 ,p_saved_search_criteria_id out nocopy number
56 ,p_object_version_number out nocopy number
57 );
58 --
59 -- ----------------------------------------------------------------------------
60 -- |------------------------< update_search_criteria >---------------------|
61 -- ----------------------------------------------------------------------------
62 --
63 -- {Start Of Comments}
64 /*#
65 * This API updates an existing Saved Search Criteria.
66 *
67 *
68 * <p><b>Licensing</b><br>
69 * This API is licensed for use with iRecruitment.
70 *
71 * <p><b>Prerequisites</b><br>
72 * Saved Search criteria should exist.
73 *
74 * <p><b>Post Success</b><br>
75 * Successfully updates the Saved Search Criteria.
76 *
77 * <p><b>Post Failure</b><br>
78 * The API does not update the Saved Search Criteria and raises an error.
79 *
80 * @param p_validate If true, then validation alone will be performed and the
81 * database will remain unchanged. If false and all validation checks pass,
82 * then the database will be modified.
83 * @param p_vacancy_id Vacancy id of the Vacancy.
84 * @param p_saved_search_criteria_id If p_validate is false, then this uniquely
85 * identifies the Search Criteria is saved. If p_validate is true, then set to null.
86 * @param p_object_version_number If p_validate is false, then set to the
87 * version number of the saved search criteria. If p_validate is true,
88 * then the value will be null.
89 * @rep:displayname Update Saved Search Criteria
90 * @rep:category BUSINESS_ENTITY IRC_RECRUITMENT_CANDIDATE
91 * @rep:lifecycle active
92 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
93 * @rep:scope public
94 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
95 */
96 --
97 -- {End Of Comments}
98 --
99 procedure update_search_criteria
100 (p_validate in boolean default false
101 ,p_vacancy_id in number
102 ,p_saved_search_criteria_id in out nocopy number
103 ,p_object_version_number in out nocopy number
104 );
105 --
106 -- ----------------------------------------------------------------------------
107 -- |-------------------------------< delete_search_criteria >----------------------------|
108 -- ----------------------------------------------------------------------------
109 --
110 -- {Start Of Comments}
111 /*#
112 * This API deletes an existing Saved Search Criteria.
113 *
114 *
115 *
116 * <p><b>Licensing</b><br>
117 * This API is licensed for use with iRecruitment.
118 *
119 * <p><b>Prerequisites</b><br>
120 * Saved Search criteria should exist.
121 *
122 * <p><b>Post Success</b><br>
123 * Successfully deletes the Saved Search Criteria.
124 *
125 * <p><b>Post Failure</b><br>
126 * The API does not delete the Saved Search Criteria and raises an error.
127 *
128 * @param p_validate If true, then validation alone will be performed and the
129 * database will remain unchanged. If false and all validation checks pass,
130 * then the database will be modified.
131 * @param p_vacancy_id Vacancy id of the Vacancy.
132 * @param p_saved_search_criteria_id If p_validate is false, then this uniquely
133 * identifies the Search Criteria is saved. If p_validate is true, then set to null.
134 * @param p_object_version_number If p_validate is false, then set to the
135 * version number of the saved search criteria. If p_validate is true,
136 * then the value will be null.
137 * @rep:displayname Update Saved Search Criteria
138 * @rep:category BUSINESS_ENTITY IRC_RECRUITMENT_CANDIDATE
139 * @rep:lifecycle active
140 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
141 * @rep:scope public
142 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
143 */
144 --
145 -- {End Of Comments}
146 --
147 procedure delete_search_criteria
148 (p_validate in boolean default false
149 ,p_vacancy_id in number
150 ,p_saved_search_criteria_id in number
151 ,p_object_version_number in number
152 );
153 end irc_saved_search_criteria_api;
[Home] [Help]