1 Package hr_participants_api AUTHID CURRENT_USER as
2 /* $Header: peparapi.pkh 120.3 2008/03/31 12:28:09 ubhat ship $*/
3 /*#
4 * This package contains participant APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Participant
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_participant >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new participant.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The participating person, appraisal and questionnaire template must exist as
24 * of effective date. Questionnaire template is optional depending upon the
25 * type of participant.
26 *
27 * <p><b>Post Success</b><br>
28 * The participant will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The participant will not be created and an error will be raised.
32 * @param p_participant_id If p_validate is false, then this uniquely
33 * identifies the participant created. If p_validate is true, then set to null.
34 * @param p_object_version_number If p_validate is false, then set to the
35 * version number of the created participant. If p_validate is true, then the
36 * value will be null.
37 * @param p_questionnaire_template_id {@rep:casecolumn
38 * HR_QUESTIONNAIRES.QUESTIONNAIRE_TEMPLATE_ID}
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_effective_date Reference date for validating lookup values are
43 * applicable during the start to end active date range. This date does not
44 * determine when the changes take effect.
45 * @param p_business_group_id Business group id in which the participant is
46 * created.
47 * @param p_participation_in_table Participating entity. For example
48 * PER_APPRAISALS.
49 * @param p_participation_in_column Participating entities reference column.
50 * For example APPRAISAL_ID.
51 * @param p_participation_in_id Participating entities ID. For example the
52 * actual value of the APPRAISAL_ID.
53 * @param p_participation_status Participant's Status. Valid values are defined
54 * by 'PARTICIPATION_ACCESS' lookup type.
55 * @param p_participation_type Participant's Type. Valid values are defined by
56 * 'PARTICIPATION_TYPE' lookup type.
57 * @param p_last_notified_date Date last notified.
58 * @param p_date_completed Date last participation completed.
59 * @param p_comments Comment text.
60 * @param p_person_id Identifies the person for whom you create the participant
61 * record.
62 * @param p_attribute_category This context value determines which flexfield
63 * structure to use with the descriptive flexfield segments.
64 * @param p_attribute1 Descriptive flexfield segment.
65 * @param p_attribute2 Descriptive flexfield segment.
66 * @param p_attribute3 Descriptive flexfield segment.
67 * @param p_attribute4 Descriptive flexfield segment.
68 * @param p_attribute5 Descriptive flexfield segment.
69 * @param p_attribute6 Descriptive flexfield segment.
70 * @param p_attribute7 Descriptive flexfield segment.
71 * @param p_attribute8 Descriptive flexfield segment.
72 * @param p_attribute9 Descriptive flexfield segment.
73 * @param p_attribute10 Descriptive flexfield segment.
74 * @param p_attribute11 Descriptive flexfield segment.
75 * @param p_attribute12 Descriptive flexfield segment.
76 * @param p_attribute13 Descriptive flexfield segment.
77 * @param p_attribute14 Descriptive flexfield segment.
78 * @param p_attribute15 Descriptive flexfield segment.
79 * @param p_attribute16 Descriptive flexfield segment.
80 * @param p_attribute17 Descriptive flexfield segment.
81 * @param p_attribute18 Descriptive flexfield segment.
82 * @param p_attribute19 Descriptive flexfield segment.
83 * @param p_attribute20 Descriptive flexfield segment.
84 * @param p_participant_usage_status Used to track the offline status of the
85 * Participant's appraisal. Valid values are defined by
86 * 'APPRAISAL_OFFLINE_STATUS' lookup type.
87 * @rep:displayname Create Participant
88 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
89 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
90 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 procedure create_participant
99 (p_validate in boolean default false,
100 p_effective_date in date,
101 p_business_group_id in number,
102 p_questionnaire_template_id in number default null,
103 p_participation_in_table in varchar2,
104 p_participation_in_column in varchar2,
105 p_participation_in_id in number,
106 p_participation_status in varchar2 default 'OPEN',
107 p_participation_type in varchar2 default null,
108 p_last_notified_date in date default null,
109 p_date_completed in date default null,
113 p_attribute1 in varchar2 default null,
110 p_comments in varchar2 default null,
111 p_person_id in number,
112 p_attribute_category in varchar2 default null,
114 p_attribute2 in varchar2 default null,
115 p_attribute3 in varchar2 default null,
116 p_attribute4 in varchar2 default null,
117 p_attribute5 in varchar2 default null,
118 p_attribute6 in varchar2 default null,
119 p_attribute7 in varchar2 default null,
120 p_attribute8 in varchar2 default null,
121 p_attribute9 in varchar2 default null,
122 p_attribute10 in varchar2 default null,
123 p_attribute11 in varchar2 default null,
124 p_attribute12 in varchar2 default null,
125 p_attribute13 in varchar2 default null,
126 p_attribute14 in varchar2 default null,
127 p_attribute15 in varchar2 default null,
128 p_attribute16 in varchar2 default null,
129 p_attribute17 in varchar2 default null,
130 p_attribute18 in varchar2 default null,
131 p_attribute19 in varchar2 default null,
132 p_attribute20 in varchar2 default null,
133 p_participant_usage_status in varchar2 default null,
134 p_participant_id out nocopy number,
135 p_object_version_number out nocopy number
136 );
137 --
138 -- ----------------------------------------------------------------------------
139 -- |----------------------------< update_participant >------------------------|
140 -- ----------------------------------------------------------------------------
141 --
142 -- {Start Of Comments}
143 /*#
144 * This API updates the participant as identified by the in parameter
145 * p_participant_id and the in out parameter p_object_version_number.
146 *
147 *
148 * <p><b>Licensing</b><br>
149 * This API is licensed for use with Human Resources.
150 *
151 * <p><b>Prerequisites</b><br>
152 * The participant must exist as of effective date.
153 *
154 * <p><b>Post Success</b><br>
155 * The participant record will be successfully updated in the database.
156 *
157 * <p><b>Post Failure</b><br>
158 * The participant will not be updated and an error will be raised.
159 * @param p_participant_id {@rep:casecolumn PER_PARTICIPANTS.PARTICIPANT_ID}
160 * @param p_object_version_number Pass in the current version number of the
161 * participant to be updated. When the API completes if p_validate is false,
162 * will be set to the new version number of the updated participant. If
163 * p_validate is true will be set to the same value which was passed in.
164 * @param p_questionnaire_template_id {@rep:casecolumn
165 * HR_QUESTIONNAIRES.QUESTIONNAIRE_TEMPLATE_ID}
166 * @param p_validate If true, then validation alone will be performed and the
167 * database will remain unchanged. If false and all validation checks pass,
168 * then the database will be modified.
169 * @param p_effective_date Reference date for validating lookup values are
170 * applicable during the start to end active date range. This date does not
171 * determine when the changes take effect.
172 * @param p_participation_status Participant's Status. Valid values are defined
173 * by 'PARTICIPATION_ACCESS' lookup type.
174 * @param p_participation_type Participant's Type. Valid values are defined by
175 * 'PARTICIPATION_TYPE' lookup type.
176 * @param p_last_notified_date Date last notified.
177 * @param p_date_completed Date last participation completed.
178 * @param p_comments Comment text.
179 * @param p_person_id Obsolete parameter, do not use.
180 * @param p_attribute_category This context value determines which flexfield
181 * structure to use with the descriptive flexfield segments.
182 * @param p_attribute1 Descriptive flexfield segment.
183 * @param p_attribute2 Descriptive flexfield segment.
184 * @param p_attribute3 Descriptive flexfield segment.
185 * @param p_attribute4 Descriptive flexfield segment.
186 * @param p_attribute5 Descriptive flexfield segment.
187 * @param p_attribute6 Descriptive flexfield segment.
188 * @param p_attribute7 Descriptive flexfield segment.
189 * @param p_attribute8 Descriptive flexfield segment.
190 * @param p_attribute9 Descriptive flexfield segment.
191 * @param p_attribute10 Descriptive flexfield segment.
192 * @param p_attribute11 Descriptive flexfield segment.
193 * @param p_attribute12 Descriptive flexfield segment.
194 * @param p_attribute13 Descriptive flexfield segment.
195 * @param p_attribute14 Descriptive flexfield segment.
196 * @param p_attribute15 Descriptive flexfield segment.
197 * @param p_attribute16 Descriptive flexfield segment.
198 * @param p_attribute17 Descriptive flexfield segment.
199 * @param p_attribute18 Descriptive flexfield segment.
200 * @param p_attribute19 Descriptive flexfield segment.
201 * @param p_attribute20 Descriptive flexfield segment.
202 * @param p_participant_usage_status Used to track the offline status of the
203 * Participant's appraisal. Valid values are defined by
204 * 'APPRAISAL_OFFLINE_STATUS' lookup type.
205 * @rep:displayname Update Participant
206 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
207 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
208 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
209 * @rep:scope public
210 * @rep:lifecycle active
211 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
212 */
213 --
214 -- {End Of Comments}
215 --
216 procedure update_participant
217 (p_validate in boolean default false,
218 p_effective_date in date,
219 p_participant_id in number,
220 p_object_version_number in out nocopy number,
221 p_questionnaire_template_id in number default hr_api.g_number,
222 p_participation_status in varchar2 default hr_api.g_varchar2,
223 p_participation_type in varchar2 default hr_api.g_varchar2,
224 p_last_notified_date in date default hr_api.g_date,
225 p_date_completed in date default hr_api.g_date,
226 p_comments in varchar2 default hr_api.g_varchar2,
227 p_person_id in number default hr_api.g_number,
228 p_attribute_category in varchar2 default hr_api.g_varchar2,
229 p_attribute1 in varchar2 default hr_api.g_varchar2,
230 p_attribute2 in varchar2 default hr_api.g_varchar2,
231 p_attribute3 in varchar2 default hr_api.g_varchar2,
232 p_attribute4 in varchar2 default hr_api.g_varchar2,
233 p_attribute5 in varchar2 default hr_api.g_varchar2,
234 p_attribute6 in varchar2 default hr_api.g_varchar2,
235 p_attribute7 in varchar2 default hr_api.g_varchar2,
236 p_attribute8 in varchar2 default hr_api.g_varchar2,
237 p_attribute9 in varchar2 default hr_api.g_varchar2,
238 p_attribute10 in varchar2 default hr_api.g_varchar2,
239 p_attribute11 in varchar2 default hr_api.g_varchar2,
240 p_attribute12 in varchar2 default hr_api.g_varchar2,
241 p_attribute13 in varchar2 default hr_api.g_varchar2,
242 p_attribute14 in varchar2 default hr_api.g_varchar2,
243 p_attribute15 in varchar2 default hr_api.g_varchar2,
244 p_attribute16 in varchar2 default hr_api.g_varchar2,
245 p_attribute17 in varchar2 default hr_api.g_varchar2,
246 p_attribute18 in varchar2 default hr_api.g_varchar2,
247 p_attribute19 in varchar2 default hr_api.g_varchar2,
248 p_attribute20 in varchar2 default hr_api.g_varchar2,
249 p_participant_usage_status in varchar2 default hr_api.g_varchar2
250 );
251 --
252 -- ----------------------------------------------------------------------------
253 -- |----------------------------< delete_participant >------------------------|
254 -- ----------------------------------------------------------------------------
255 --
256 -- {Start Of Comments}
257 /*#
258 * This API deletes the participant as identified by the in parameter
259 * p_participant_id.
260 *
261 *
262 * <p><b>Licensing</b><br>
263 * This API is licensed for use with Human Resources.
264 *
265 * <p><b>Prerequisites</b><br>
266 * The participant must exist.
267 *
268 * <p><b>Post Success</b><br>
269 * The participant record will be successfully deleted from the database.
270 *
271 * <p><b>Post Failure</b><br>
272 * The participant will not be deleted and an error will be raised.
273 * @param p_validate If true, then validation alone will be performed and the
274 * database will remain unchanged. If false and all validation checks pass,
275 * then the database will be modified.
276 * @param p_participant_id {@rep:casecolumn PER_PARTICIPANTS.PARTICIPANT_ID}
277 * @param p_object_version_number Current version number of the participant to
278 * be deleted.
279 * @rep:displayname Delete Participant
280 * @rep:category BUSINESS_ENTITY PER_APPRAISAL
281 * @rep:category BUSINESS_ENTITY PER_ASSESSMENT
282 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
283 * @rep:scope public
284 * @rep:lifecycle active
285 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
286 */
287 --
288 -- {End Of Comments}
289 --
290 procedure delete_participant
291 (p_validate in boolean default false,
292 p_participant_id in number,
293 p_object_version_number in number
294 );
295 --
296 end hr_participants_api;
[Home] [Help]