1 PACKAGE igs_admapplication_pub AS
2 /* $Header: IGSPAPPS.pls 120.5 2006/09/21 11:46:13 rghosh noship $ */
3 /*#
4 * This Package contains Public API's for giving ratings,Outcome,offer reponse and Qualification codes to an Admission Application
5 * @rep:scope public
6 * @rep:product IGS
7 * @rep:displayname Admission Application
8 * @rep:lifecycle active
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY IGS_ADM_APPLICATION
11 */
12 -- Start of comments
13 -- API name : RECORD_ACADEMIC_INDEX
14 -- Type : Public.
15 -- Function : To record Academic index value for an application instance.
16 -- Pre-reqs : None.
17 -- Parameters :
18 -- IN : p_api_version :
19 -- It is Required parameter. Its data type is Number
20 -- p_init_msg_list :
21 -- It is an optional parameter.Default value is FND_API.G_FALSE
22 -- p_commit :
23 -- It is an optional parameter.Default value is FND_API.G_FALSE
24 -- p_validation_level :
25 -- It is an optional parameter.Default value is FND_API.G_VALID_LEVEL_FULL
26 -- p_person_id :
27 -- It is a Required parameter. Its data type is Number.
28 -- Maximum length is 15.Unique identifier assigned to the Applicant
29 -- p_admission_appl_number :
30 -- It is a Required parameter. Its data type is Number.
31 -- maximum length is 2.This holding the admission application number
32 -- associated with the applicant's application
33 -- p_nominated_program_cd :
34 -- It is a Required parameter. Its data type is Varchar2.
35 -- maximum length is 6.This holding the program code of the program
36 -- for that the applicant is seeking admission
37 -- p_sequence_number :
38 -- It is a Required parameter. Its data type is Number.
39 -- maximum length is 6.This holding the sequence number of the application
40 -- p_predicted_gpa :
41 -- Its data type is Number(5,2).
42 -- maximum length is (5,2).This holding the new predicated GPA to
43 -- be recorded
44 -- p_academic_index :
45 -- It is a Required parameter. Its data type is Varchar2.
46 -- maximum length is 10.This holding the new Academic index to
47 -- be recorded
48 -- p_calculation_date :
49 -- Its data type is Date.
50 -- This holding the Calculation date of Academic Index and GPA
51
52 -- OUT : x_return_status :
53 -- It is out parameter that will contain teh return status at the time of exiting the API.
54 -- and calling program can look into this variable to check whether API run was succesful or Not
55 -- It can have three values given below(with definition) :
56 -- G_RET_STS_SUCCESS CONSTANT VARCHAR2 (1):='S';
57 -- G_RET_STS_ERROR CONSTANT VARCHAR2 (1):='E';
58 -- G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2 (1):='U';
59 -- This variable is of type varchar2, and length should be 1
60 -- x_msg_count :
61 -- It is also a out variable which will hold total no of messages issued by API
62 -- This variable is of type number.
63 -- x_msg_data
64 -- if x_msg_count = 1 then this variable will hold the top message on message stack
65 -- else it will be null. Api will expect it as varchar2 type and length of 2000
66 -- Version : Current version 1.0
67 -- Changed....
68 -- previous version N.A.
69 -- Initial version 1.0
70 -- Notes : None.
71 -- End of comments
72 /*#
73 * The Record Academic Index API is a public API that enables Academic Index and Predicted GPA to be recorded against an application instance.
74 * The API can be called as part of workflow logic, through the action of data being entered or updated in the system and a subsequent business
75 * event being raised or as a result of the evaluation of a particular sequence of logic.
76 * @param p_API_VERSION API Version Number
77 * @param p_INIT_MSG_LIST Initialize Message List
78 * @param p_COMMIT Commit Transaction
79 * @param p_VALIDATION_LEVEL Validation Level
80 * @param X_RETURN_STATUS Return Status
81 * @param X_MSG_COUNT Message Count
82 * @param X_MSG_DATA Message Data
83 * @param p_PERSON_ID Person ID
84 * @param p_ADMISSION_APPL_NUMBER Admission Application number
85 * @param p_NOMINATED_PROGRAM_CD Nominated Program Code
86 * @param p_SEQUENCE_NUMBER Sequence Number
87 * @param p_PREDICTED_GPA Predicted GPA
88 * @param p_ACADEMIC_INDEX Academic index
89 * @param p_CALCULATION_DATE Calculation Date
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:displayname Record Indices
93 */
94 PROCEDURE RECORD_ACADEMIC_INDEX(
95 --Standard Parameters Start
96 p_api_version IN NUMBER,
97 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
98 p_commit IN VARCHAR2 default FND_API.G_FALSE,
99 p_validation_level IN NUMBER default FND_API.G_VALID_LEVEL_FULL,
100 x_return_status OUT NOCOPY VARCHAR2,
101 x_msg_count OUT NOCOPY NUMBER,
102 x_msg_data OUT NOCOPY VARCHAR2,
103 --Standard parameter ends
104 p_person_id IN NUMBER,
105 p_admission_appl_number IN NUMBER,
106 p_nominated_program_cd IN VARCHAR2,
107 p_sequence_number IN NUMBER,
108 p_predicted_gpa IN NUMBER DEFAULT NULL,
109 p_academic_index IN VARCHAR2,
110 p_calculation_date IN DATE DEFAULT NULL
111 );
112
113 -- Start of comments
114 -- API name : Record_Outcome_AdmApplication
115 -- Type : Public.
116 -- Function : This API will enable Outcome and Offer details to be recorded for an application instance.
117 -- Through a call to the API it will be possible to setup Outcome, Override Outcome,
118 -- Conditional Offer and Offer Deadline details.
119 -- Pre-reqs : None.
120 -- Parameters :
121 -- IN : p_api_version :
122 -- It is Required parameter. Its data type is Number
123 -- p_init_msg_list :
124 -- It is an optional parameter.Default value is FND_API.G_FALSE
125 -- p_commit :
126 -- It is an optional parameter.Default value is FND_API.G_FALSE
127 -- p_validation_level :
128 -- It is an optional parameter.Default value is FND_API.G_VALID_LEVEL_FULL
129 -- p_person_id :
130 -- It is a Required parameter. Its data type is Number.
131 -- Maximum length is 15.Unique identifier assigned to the Applicant
132 -- p_admission_appl_number :
133 -- It is a Required parameter. Its data type is Number.
134 -- maximum length is 2.This holding the admission application number
135 -- associated with the applicant's application
136 -- p_nominated_program_cd :
137 -- It is a Required parameter. Its data type is Varchar2.
138 -- maximum length is 6.This holding the program code of the program
139 -- for that the applicant is seeking admission
140 -- p_sequence_number :
141 -- It is a Required parameter. Its data type is Number.
142 -- maximum length is 6.This holding the sequence number of the application
143 -- p_adm_outcome_status :
144 -- It is a Required parameter. Its data type is Varchar2.
145 -- maximum length is 10.This holding the new outcome status of the admission
146 -- program application instance be recorded
147 -- p_decision_make_id :
148 -- It is a Required parameter. Its data type is Number.
149 -- maximum length is 15.This holding the Decision maker person identifier
150 -- p_decision_date :
151 -- It is a Required parameter. Its data type is Date.
152 -- This holding the Date when the decision was made
153 -- p_decision_reason_id :
154 -- It is an Optional parameter. Its data type is Number.
155 -- The maximum length is 15 .This holding the Decision reason identifier
156 -- p_pending_reason_id :
157 -- It is an Optional parameter. Its data type is Number.
158 -- The maximum length is 15 .This holding the Pending reason identifier
159 -- p_offer_dt :
160 -- It is an Optional parameter. Its data type is Date.
161 -- This holding the date that an offer of admission was made to the applicant
162 -- p_adm_outcome_status_auth_dt :
163 -- It is an Optional parameter. Its data type is Date.
164 -- This holding the date that change to the Admission Outcome Status was authorized
165 -- p_adm_otcm_status_auth_per_id :
166 -- It is an Optional parameter. Its data type is Number.
167 -- The maximum length is 15. This holding the identifier of the person
168 -- who authorized the change to the Admission Outcome Status
169 -- p_adm_outcome_status_reason :
170 -- It is an Optional parameter. Its data type is Varchar2.
171 -- The maximum length is 60. This holding the reason used to
172 -- further describe the Admission Outcome Status
173 -- p_adm_cndtnl_offer_status :
174 -- It is an Optional parameter. Its data type is Varchar2.
175 -- The maximum length is 10. This holding the status assigned
176 -- to an admission program application in relation to a conditional offer
177 -- p_cndtnl_offer_cndtn :
178 -- It is an Optional parameter. Its data type is Varchar2.
179 -- The maximum length is 2000. This holding the The conditions of a
180 -- conditional offer.
181 -- p_cndtl_offer_must_stsfd_ind :
182 -- It is an Optional parameter. Its data type is Varchar2.
183 -- The maximum length is 1. This contains whether or not a conditional
184 -- offer must be satisfied before the offer can be accepted
185 -- p_cndtnl_offer_satisfied_dt :
186 -- It is an Optional parameter. Its data type is Date.
187 -- This contains The date that a conditional offer was satisfied or waived
188 -- p_offer_response_dt :
189 -- It is an Optional parameter. Its data type is Date.
190 -- This contains The date by which an applicant
191 -- must respond to the offer of admission
192 -- p_reconsider_flag:
193 -- It is an Optional parameter. Its data type is Varchar2.
194 -- The maximum length is 1. This contains application reconsideration flag
195 -- p_prpsd_commencement_date :
196 -- It is an Optional parameter. Its data type is Date.
197 -- This contains he proposed commencement date for enrollment in a program
198 -- p_ucas_transaction:
199 -- It is an Optional parameter. Its data type is Varchar2.
200 -- The maximum length is 1. This variable decides whether user UCAS HOOK(igs_ad_ps_appl_inst_pkg.ucas_user_hook)
201 -- will be called or not. if 'Y' then it will be called else not.
202
203
204 -- OUT : x_return_status :
205 -- It is out parameter that will contain teh return status at the time of exiting the API.
206 -- and calling program can look into this variable to check whether API run was succesful or Not
207 -- It can have three values given below(with definition) :
208 -- G_RET_STS_SUCCESS CONSTANT VARCHAR2 (1):='S';
209 -- G_RET_STS_ERROR CONSTANT VARCHAR2 (1):='E';
210 -- G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2 (1):='U';
211 -- This variable is of type varchar2, and length should be 1
212 -- x_msg_count :
213 -- It is also a out variable which will hold total no of messages issued by API
214 -- This variable is of type number.
215 -- x_msg_data
216 -- if x_msg_count = 1 then this variable will hold the top message on message stack
217 -- else it will be null. Api will expect it as varchar2 type and length of 2000
218 -- Version : Current version 1.0
219 -- Changed....
220 -- previous version N.A.
221 -- Initial version 1.0
222 -- Notes : None.
223 -- End of comments
224 /*#
225 * The Record Outcome Status API is a public API that enables Outcome and Offer details to be recorded for an application instance.
226 * The API can be called as part of workflow logic, through the action of data being entered or updated in the system and a subsequent business
227 * event being raised or as a result of the evaluation of a particular sequence of logic.
228 * @param p_API_VERSION API Version Number
229 * @param p_INIT_MSG_LIST Initialize Message List
230 * @param p_COMMIT Commit Transaction
231 * @param p_VALIDATION_LEVEL Validation Level
232 * @param X_RETURN_STATUS Return Status
233 * @param X_MSG_COUNT Message Count
234 * @param X_MSG_DATA Message Data
235 * @param p_PERSON_ID Person ID
236 * @param p_ADMISSION_APPL_NUMBER Admission Application number
237 * @param p_NOMINATED_PROGRAM_CD Nominated Program Code
238 * @param p_SEQUENCE_NUMBER Sequence Number
239 * @param p_ADM_OUTCOME_STATUS Outcome Status
240 * @param p_DECISION_MAKER_ID Decision Maker ID
241 * @param p_DECISION_DATE Date on which the admission decision is taken
242 * @param p_DECISION_REASON_ID Identifier of the reason to make such a decision
243 * @param p_PENDING_REASON_ID Identifier of the reason that the application is pending
244 * @param p_OFFER_DT Date on which the offer is made on the application
245 * @param p_ADM_OUTCOME_STATUS_AUTH_DT Describes the date that the outcome status was authorized.
246 * @param p_ADM_OTCM_STATUS_AUTH_PER_ID Describes the outcome status authorising person ID
247 * @param p_ADM_OUTCOME_STATUS_REASON Used to further describe a status, for example, an outcome status of Revoked may have associated reason for the revocation
248 * @param p_ADM_CNDTNL_OFFER_STATUS Describes the status assigned to an admission program application in relation to a conditional offer
249 * @param p_CNDTNL_OFFER_CNDTN Describes the conditions of a conditional offer. An assessor may use this field to list conditions the applicant must satisfy in order to satisfy the conditional offer.
250 * @param p_CNDTL_OFFER_MUST_STSFD_IND Determines whether conditional offer must be satisfied for conditional offer
251 * @param p_CNDTNL_OFFER_SATISFIED_DT Describes the date that a conditional offer was satisfied or waived.
252 * @param p_OFFER_RESPONSE_DT Date the person to respond on the offer made
256 * @rep:scope public
253 * @param p_RECONSIDER_FLAG Reconsideration flag indicating whether the Application instance has to be reconsider or not.
254 * @param p_PRPSD_COMMENCEMENT_DATE Proposed Commencement Date
255 * @param p_UCAS_TRANSACTION Determines whether the UCAS transcation should be generated for UK institutions
257 * @rep:lifecycle active
258 * @rep:displayname Record Admissions Decision
259 */
260 PROCEDURE Record_Outcome_AdmApplication
261 ( p_api_version IN NUMBER ,
262 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
263 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
264 p_validation_level IN NUMBER :=
265 FND_API.G_VALID_LEVEL_FULL ,
266
267 p_person_id NUMBER ,
268 p_admission_appl_number NUMBER ,
269 p_nominated_program_cd VARCHAR2 ,
270 p_sequence_number NUMBER ,
271 p_adm_outcome_status VARCHAR2 ,
272 p_decision_maker_id NUMBER ,
273 p_decision_date DATE ,
274 p_decision_reason_id NUMBER DEFAULT NULL ,
275 p_pending_reason_id NUMBER DEFAULT NULL ,
276 p_offer_dt DATE DEFAULT NULL ,
277 -- Columns for Override Outcome
278 p_adm_outcome_status_auth_dt DATE DEFAULT NULL ,
279 p_adm_otcm_status_auth_per_id NUMBER DEFAULT NULL ,
280 p_adm_outcome_status_reason VARCHAR2 DEFAULT NULL ,
281 -- Columns for Conditional Offer Status
282 p_adm_cndtnl_offer_status VARCHAR2 DEFAULT NULL ,
283 p_cndtnl_offer_cndtn VARCHAR2 DEFAULT NULL ,
284 p_cndtl_offer_must_stsfd_ind VARCHAR2 DEFAULT NULL ,
285 p_cndtnl_offer_satisfied_dt DATE DEFAULT NULL ,
286
287 p_offer_response_dt DATE DEFAULT NULL ,
288 p_reconsider_flag VARCHAR2 DEFAULT 'N' ,
289 p_prpsd_commencement_date DATE DEFAULT NULL ,
290 p_ucas_transaction VARCHAR2 DEFAULT 'N' ,
291
292 x_return_status OUT NOCOPY VARCHAR2 ,
293 x_msg_count OUT NOCOPY NUMBER ,
294 x_msg_data OUT NOCOPY VARCHAR2
295
296 ) ;
297
298
299 -- Start of comments
300 -- API name : RECORD_OFFER_RESPONSE
301 -- Type : Public.
302 -- Function :
303 -- Pre-reqs : None.
304 -- Parameters :
305 -- IN : p_api_version :
306 -- It is Required parameter. Its data type is Number
307 -- p_init_msg_list :
308 -- It is an optional parameter.Default value is FND_API.G_FALSE
309 -- p_commit :
310 -- It is an optional parameter.Default value is FND_API.G_FALSE
311 -- p_validation_level :
312 -- It is an optional parameter.Default value is FND_API.G_VALID_LEVEL_FULL
313 -- p_person_id :
314 -- It is a Required parameter. Its data type is Number.
315 -- Maximum length is 15.Unique identifier assigned to the Applicant
316 -- p_admission_appl_number :
317 -- It is a Required parameter. Its data type is Number.
318 -- maximum length is 2.This holding the admission application number
319 -- associated with the applicant's application
320 -- p_nominated_program_cd :
321 -- It is a Required parameter. Its data type is Varchar2.
322 -- maximum length is 6.This holding the program code of the program
323 -- for that the applicant is seeking admission
324 -- p_sequence_number :
325 -- It is a Required parameter. Its data type is Number.
326 -- maximum length is 6.This holding the sequence number of the application
327 -- p_adm_offer_resp_status :
328 -- It is a Required parameter. Its data type is Varchar2.
329 -- maximum length is 10. It Describes the offer response status of the
330 -- admission program application instance
331 -- p_actual_response_dt :
332 -- It is a Required parameter. Its data type is DATE.
333 -- It Describes the actual date a response was made by an applicant to an offer
334 -- p_response_comments :
335 -- It is a Required parameter.Its data type is
336 -- maximum length is 2000. It Describes comments regarding the applicant's
337 -- response to the offer.
338 -- p_def_acad_cal_type :
339 -- It is a Required parameter.Its data type is Varchar2
340 -- maximum length is 10
341 -- p_def_acad_ci_sequence_num :
342 -- It is a Required parameter.Its data type is
343 -- maximum length is 6
344 -- p_def_adm_cal_type :
345 -- It is a Required parameter.Its data type is Varchar2
346 -- maximum length is 10
347 -- p_def_adm_ci_sequence_num :
348 -- It is a Required parameter.Its data type is NUMBER
349 -- maximum length is 6.
350 -- p_decline_ofr_reason :
351 -- It is a Required parameter.Its data type is Varchar2
352 -- maximum length is 60. It describes Reason for declining offer.
356 --
353 -- p_attent_other_inst_cd :
354 -- It is a Required parameter.Its data type is Varchar2
355 -- maximum length is 10. It describes Intend to attend other institution code
357 -- OUT : x_return_status :
358 -- It is out parameter that will contain the return status at the time of exiting the API.
359 -- and calling program can look into this variable to check whether API run was succesful or Not
360 -- It can have three values given below(with definition) :
361 -- G_RET_STS_SUCCESS CONSTANT VARCHAR2 (1):='S';
362 -- G_RET_STS_ERROR CONSTANT VARCHAR2 (1):='E';
363 -- G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2 (1):='U';
364 -- This variable is of type varchar2, and length should be 1
365 -- x_msg_count :
366 -- It is also a out variable which will hold total no of messages issued by API
367 -- This variable is of type number.
368 -- x_msg_data
369 -- if x_msg_count = 1 then this variable will hold the top message on message stack
370 -- else it will be null. Api will expect it as varchar2 type and length of 2000
371 -- Version : Current version 2.0
372 -- previous version 1.0.
373 -- Initial version 1.0
374 -- Notes : None.
375 --
376 -- End of comments
377
378 /*#
379 * The Record Offer Response API is a public API that enables Offer Response details to be recorded for an application
380 * instance. The API can be called as part of workflow logic, through the action of data being entered or updated in
381 * the system and a subsequent business event being raised or as a result of the evaluation of a particular sequence of logic.
382 * @param p_API_VERSION API Version Number
383 * @param p_INIT_MSG_LIST Initialize Message List
384 * @param p_COMMIT Commit Transaction
385 * @param p_VALIDATION_LEVEL Validation Level
386 * @param X_RETURN_STATUS Return Status
387 * @param X_MSG_COUNT Message Count
388 * @param X_MSG_DATA Message Data
389 * @param p_PERSON_ID Person ID
390 * @param p_ADMISSION_APPL_NUMBER Admission Application number
391 * @param p_NOMINATED_PROGRAM_CD Nominated Program Code
392 * @param p_SEQUENCE_NUMBER Sequence Number
393 * @param p_ADM_OFFER_RESp_STATUS Offer Response Status
394 * @param p_ACTUAL_RESPONSE_DT Offer Response Date
395 * @param p_RESPONSE_COMMENTS Response Comments
396 * @param p_DEF_ACAD_CAL_TYPE Deferred Academic Calendar Type
397 * @param p_DEF_ACAD_CI_SEQUENCE_NUM Deferred Academic Calendar sequence number
398 * @param p_DEF_ADM_CAL_TYPE Deferred Admission Calendar Type
399 * @param p_DEF_ADM_CI_SEQUENCE_NUM Deferred Admission Calendar sequence number
400 * @param p_DECLINE_OFR_REASON Reason For Declining Offer
401 * @param p_ATTENT_OTHER_INST_CD Intend To Attend Other Institution Code
402 * @rep:scope public
403 * @rep:lifecycle active
404 * @rep:displayname Record Offer Response
405 */
406 PROCEDURE RECORD_OFFER_RESPONSE(
407 --Standard Parameters Start
408 p_api_version IN NUMBER,
409 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
410 p_commit IN VARCHAR2 default FND_API.G_FALSE,
411 p_validation_level IN NUMBER default FND_API.G_VALID_LEVEL_FULL,
412 x_return_status OUT NOCOPY VARCHAR2,
413 x_msg_count OUT NOCOPY NUMBER,
414 x_msg_data OUT NOCOPY VARCHAR2,
415 --Standard parameter ends
416 p_person_id IN NUMBER,
417 p_admission_appl_number IN NUMBER,
418 p_nominated_program_cd IN VARCHAR2,
419 p_sequence_number IN NUMBER,
420 p_adm_offer_resp_status IN VARCHAR2, --Varchar2(10) LOV(validation exists in Form(PLD))
421 p_actual_response_dt IN DATE, --validation exists in form(pld)
422 p_response_comments IN VARCHAR2, --VARCHAR2(2000)
423 p_def_acad_cal_type IN VARCHAR2, --Varchar2(10)
424 p_def_acad_ci_sequence_num IN NUMBER, --NUMBER(5)
425 p_def_adm_cal_type IN VARCHAR2, --Varchar2(10)
426 p_def_adm_ci_sequence_num IN NUMBER, --NUMBER(5)
427 p_decline_ofr_reason IN VARCHAR2,
428 p_attent_other_inst_cd IN VARCHAR2
429 );
430
431 -- Start of comments
432 -- API name : RECORD_QUALIFICATION_CODE
433 -- Type : Public.
434 -- Function :
435 -- Pre-reqs : None.
436 -- Parameters :
437 -- IN : p_api_version :
438 -- It is Required parameter. Its data type is Number
439 -- p_init_msg_list :
440 -- It is an optional parameter.Default value is FND_API.G_FALSE
441 -- p_commit :
442 -- It is an optional parameter.Default value is FND_API.G_FALSE
443 -- p_validation_level :
444 -- It is an optional parameter.Default value is FND_API.G_VALID_LEVEL_FULL
445 -- p_person_id :
446 -- It is a Required parameter. Its data type is Number.
447 -- Maximum length is 15.Unique identifier assigned to the Applicant
448 -- p_admission_appl_number :
449 -- It is a Required parameter. Its data type is Number.
450 -- maximum length is 2.This holding the admission application number
451 -- associated with the applicant's application
452 -- p_nominated_program_cd :
456 -- p_sequence_number :
453 -- It is a Required parameter. Its data type is Varchar2.
454 -- maximum length is 6.This holding the program code of the program
455 -- for that the applicant is seeking admission
457 -- It is a Required parameter. Its data type is Number.
458 -- maximum length is 6.This holding the sequence number of the application
459 -- p_qualifying_type :
460 -- It is a Required parameter.Its data type is VARCHAR2
461 -- maximum length is 30.This holds the Qualifying Types.
462 -- p_qualifying_code :
463 -- It is a Required parameter.Its data type is Varchar2
464 -- maximum length is 10. It holds the qualification Code.
465 -- p_qualifying_value :
466 -- It is a Required parameter.Its data type is Varchar2
467 -- maximum length is 80. It contains the Qualifying value
468 --
469 -- OUT : x_return_status :
470 -- It is out parameter that will contain the return status at the time of exiting the API.
471 -- and calling program can look into this variable to check whether API run was succesful or Not
472 -- It can have three values given below(with definition) :
473 -- G_RET_STS_SUCCESS CONSTANT VARCHAR2 (1):='S';
474 -- G_RET_STS_ERROR CONSTANT VARCHAR2 (1):='E';
475 -- G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2 (1):='U';
476 -- This variable is of type varchar2, and length should be 1
477 -- x_msg_count :
478 -- It is also a out variable which will hold total no of messages issued by API
479 -- This variable is of type number.
480 -- x_msg_data
481 -- if x_msg_count = 1 then this variable will hold the top message on message stack
482 -- else it will be null. Api will expect it as varchar2 type and length of 2000
483 -- Version : Current version 1.0
484 -- previous version NA(Newly Created)
485 -- Initial version 1.0
486 -- Notes : None.
487 --
488 -- End of comments
489 /*#
490 * The Record Qualifying Codes API is a public API that enables Application Instance Qualifying Codes and or Values to be
491 * recorded against an application instance. The API can be called as part of workflow logic, through the action of data
492 * being entered or updated in the system and a subsequent business event being raised or as a result of the evaluation
493 * of a particular sequence of logic.
494 * @param p_API_VERSION API Version Number
495 * @param p_INIT_MSG_LIST Initialize Message List
496 * @param p_COMMIT Commit Transaction
497 * @param p_VALIDATION_LEVEL Validation Level
498 * @param X_RETURN_STATUS Return Status
499 * @param X_MSG_COUNT Message Count
500 * @param X_MSG_DATA Message Data
501 * @param p_PERSON_ID Person ID
502 * @param p_ADMISSION_APPL_NUMBER Admission Application number
503 * @param p_NOMINATED_COURSE_CD Nominated Course Code
504 * @param p_SEQUENCE_NUMBER Sequence Number
505 * @param p_QUALIFYING_TYPE_CODE Qualifying Type
506 * @param p_QUALIFYING_CODE Qualifying Code Name
507 * @param p_QUALIFYING_VALUE Qualifying Value
508 * @rep:scope public
509 * @rep:lifecycle active
510 * @rep:displayname Application Instance Qualifying Codes
511 */
512 PROCEDURE RECORD_QUALIFICATION_CODE(
513 p_api_version IN NUMBER ,
514 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE ,
515 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
516 p_validation_level IN NUMBER :=
517 FND_API.G_VALID_LEVEL_FULL ,
518 p_person_id IN NUMBER,
519 p_admission_appl_number IN NUMBER,
520 p_nominated_course_cd IN VARCHAR2,
521 p_sequence_number IN NUMBER,
522 p_qualifying_type_code IN VARCHAR2,
523 p_qualifying_code IN VARCHAR2,
524 p_qualifying_value IN VARCHAR2,
525 x_return_status OUT NOCOPY VARCHAR2,
526 x_msg_count OUT NOCOPY NUMBER,
527 x_msg_data OUT NOCOPY VARCHAR2
528 );
529
530 -- Start of comments
531 -- API name : UPDATE_ENTRY_QUAL_STATUS
532 -- Type : Public.
533 -- Function : To enable the user to update the entry qualification status of an application instance
534 -- Pre-reqs : None.
535 -- Parameters :
536 -- IN : p_api_version :
537 -- It is Required parameter. Its data type is Number
538 -- p_init_msg_list :
539 -- It is an optional parameter.Default value is FND_API.G_FALSE
540 -- p_commit :
541 -- It is an optional parameter.Default value is FND_API.G_FALSE
542 -- p_validation_level :
543 -- It is an optional parameter.Default value is FND_API.G_VALID_LEVEL_FULL
544 -- p_person_id :
545 -- It is a Required parameter. Its data type is Number.
546 -- Maximum length is 15.Unique identifier assigned to the Applicant
547 -- p_admission_appl_number :
548 -- It is a Required parameter. Its data type is Number.
552 -- It is a Required parameter. Its data type is Varchar2.
549 -- maximum length is 2.This holds the admission application number
550 -- associated with the applicant's application
551 -- p_nominated_program_cd :
553 -- maximum length is 6.This holds the program code of the nominated program
554 -- for which the applicant is seeking admission
555 -- p_sequence_number :
556 -- It is a Required parameter. Its data type is Number.
557 -- maximum length is 6.This holds the sequence number of the application
558 -- p_entry_qual_status :
559 -- This is a required parameter. Its data type is Varchar2.
560 -- Maximum length is 10. This holds the details about the Entry Qualification
561 -- status of an application.
562 -- OUT : x_return_status :
563 -- It is out parameter that will contain the return status at the time of exiting the API.
564 -- and calling program can look into this variable to check whether API run was succesful or Not
565 -- It can have three values given below(with definition) :
566 -- G_RET_STS_SUCCESS CONSTANT VARCHAR2 (1):='S';
567 -- G_RET_STS_ERROR CONSTANT VARCHAR2 (1):='E';
568 -- G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2 (1):='U';
569 -- This variable is of type varchar2, and length should be 1
570 -- x_msg_count :
571 -- It is also a out variable which will hold total no of messages issued by API
572 -- This variable is of type number.
573 -- x_msg_data
574 -- if x_msg_count = 1 then this variable will hold the top message on message stack
575 -- else it will be null. Api will expect it as varchar2 type and length of 2000
576 -- Version : Current version 1.0
577 -- previous version NA(Newly Created)
578 -- Initial version 1.0
579 -- Notes : None.
580 --
581 -- End of comments
582 /*#
583 * The Update Entry Qualification Status API is a public API that enables the user to update the Entry Qualification
584 * Status of an application instance.
585 * @param p_API_VERSION API Version Number
586 * @param p_INIT_MSG_LIST Initialize Message List
587 * @param p_COMMIT Commit Transaction
588 * @param p_VALIDATION_LEVEL Validation Level
589 * @param X_RETURN_STATUS Return Status
590 * @param X_MSG_COUNT Message Count
591 * @param X_MSG_DATA Message Data
592 * @param p_PERSON_ID Person ID
593 * @param p_ADMISSION_APPL_NUMBER Admission Application number
594 * @param p_NOMINATED_PROGRAM_CD Nominated Program Code
595 * @param p_SEQUENCE_NUMBER Sequence Number
596 * @param p_ENTRY_QUAL_STATUS Entry Qualification Status
597 * @rep:scope public
598 * @rep:lifecycle active
599 * @rep:displayname Update Entry Qualification Status
600 */
601 PROCEDURE UPDATE_ENTRY_QUAL_STATUS(
602 --Standard Parameters Start
603 p_api_version IN NUMBER,
604 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
605 p_commit IN VARCHAR2 default FND_API.G_FALSE,
606 p_validation_level IN NUMBER default FND_API.G_VALID_LEVEL_FULL,
607 x_return_status OUT NOCOPY VARCHAR2,
608 x_msg_count OUT NOCOPY NUMBER,
609 x_msg_data OUT NOCOPY VARCHAR2,
610 --Standard parameter ends
611 p_person_id IN NUMBER,
612 p_admission_appl_number IN NUMBER,
613 p_nominated_program_cd IN VARCHAR2,
614 p_sequence_number IN NUMBER,
615 p_entry_qual_status IN VARCHAR2
616 );
617
618 END igs_admapplication_pub;
[Home] [Help]