[Home] [Help]
PACKAGE: APPS.IEX_SCORE_PUB
Source
1 PACKAGE IEX_SCORE_PUB AS
2 /* $Header: iexpscrs.pls 120.14 2006/08/24 17:23:42 raverma ship $ */
3 /*#
4 * Scoring APIs allow the user to manage scoring engines in Oracle Collections.
5 * @rep:scope public
6 * @rep:product IEX
7 * @rep:lifecycle active
8 * @rep:displayname Scoring API
9 * @rep:category BUSINESS_ENTITY IEX_COLLECTION_SCORE
10 */
11
12
13 -- this will be passed back by the get_components procedure
14 TYPE SCORE_ENG_COMP_REC IS RECORD(
15 SCORE_ID NUMBER ,
16 SCORE_COMPONENT_ID NUMBER ,
17 SCORE_COMP_WEIGHT NUMBER ,
18 SCORE_COMP_VALUE VARCHAR2(2000));
19
20 TYPE SCORE_ENG_COMP_TBL IS TABLE OF SCORE_ENG_COMP_REC INDEX BY binary_integer;
21
22 TYPE SCORE_REC_TYPE IS RECORD(
23 SCORE_ID NUMBER ,
24 -- clchang updated 08/22/03
25 --SCORE_NAME VARCHAR2(50) := FND_API.G_MISS_CHAR,
26 SCORE_NAME VARCHAR2(256) ,
27 LAST_UPDATE_DATE DATE ,
28 LAST_UPDATED_BY NUMBER ,
29 CREATION_DATE DATE ,
30 CREATED_BY NUMBER ,
31 LAST_UPDATE_LOGIN NUMBER ,
32 SCORE_DESCRIPTION VARCHAR2(150) ,
33 ENABLED_FLAG VARCHAR2(1) ,
34 VALID_FROM_DT DATE ,
35 VALID_TO_DT DATE ,
36 CAMPAIGN_SCHED_ID NUMBER ,
37 JTF_OBJECT_CODE VARCHAR2(25) ,
38 CONCURRENT_PROG_ID NUMBER ,
39 CONCURRENT_PROG_NAME VARCHAR2(30) ,
40 SECURITY_GROUP_ID NUMBER ,
41 REQUEST_ID NUMBER ,
42 PROGRAM_APPLICATION_ID NUMBER ,
43 PROGRAM_ID NUMBER ,
44 PROGRAM_UPDATE_DATE DATE ,
45 STATUS_DETERMINATION VARCHAR2(1) ,
46 WEIGHT_REQUIRED VARCHAR2(3) ,
47 SCORE_RANGE_LOW VARCHAR2(1000) ,
48 SCORE_RANGE_HIGH VARCHAR2(1000) ,
49 OUT_OF_RANGE_RULE VARCHAR2(20) );
50
51
52 TYPE SCORE_TBL_TYPE IS TABLE OF SCORE_REC_TYPE INDEX BY binary_integer;
53
54 G_MISS_SCORE_REC IEX_SCORE_PUB.SCORE_REC_TYPE;
55 G_MISS_SCORE_TBL IEX_SCORE_PUB.SCORE_TBL_TYPE;
56
57 TYPE SCORE_COMP_REC_TYPE IS RECORD (
58 SCORE_COMPONENT_ID NUMBER ,
59 SCORE_COMP_WEIGHT NUMBER(3,2) := 0,
60 SCORE_ID NUMBER ,
61 ENABLED_FLAG VARCHAR2(10) ,
62 SCORE_COMP_TYPE_ID NUMBER ,
63 LAST_UPDATE_DATE DATE ,
64 LAST_UPDATED_BY NUMBER ,
65 CREATION_DATE DATE ,
66 CREATED_BY NUMBER ,
67 LAST_UPDATE_LOGIN NUMBER );
68
69 TYPE SCORE_COMP_TBL_TYPE IS TABLE OF SCORE_COMP_REC_TYPE
70 INDEX BY binary_integer;
71
72 G_MISS_SCORE_COMP_REC IEX_SCORE_PUB.SCORE_COMP_REC_TYPE;
73 G_MISS_SCORE_COMP_TBL IEX_SCORE_PUB.SCORE_COMP_TBL_TYPE;
74
75
76
77 -- clchang added new column 'NEW_VALUE' 09/22/2004
78
79 TYPE SCORE_COMP_DET_REC_TYPE IS RECORD (
80 SCORE_COMP_DET_ID NUMBER ,
81 RANGE_LOW NUMBER ,
82 RANGE_HIGH NUMBER ,
83 VALUE NUMBER ,
84 NEW_VALUE VARCHAR2(2000),
85 SCORE_COMPONENT_ID NUMBER ,
86 OBJECT_VERSION_NUMBER NUMBER ,
87 PROGRAM_ID NUMBER ,
88 LAST_UPDATE_DATE DATE ,
89 LAST_UPDATED_BY NUMBER ,
90 CREATION_DATE DATE ,
91 CREATED_BY NUMBER ,
92 LAST_UPDATE_LOGIN NUMBER );
93
94
95 TYPE SCORE_COMP_DET_TBL_TYPE IS TABLE OF SCORE_COMP_DET_REC_TYPE
96 INDEX BY binary_integer;
97
98 G_MISS_SCORE_COMP_DET_REC IEX_SCORE_PUB.SCORE_COMP_DET_REC_TYPE;
99 G_MISS_SCORE_COMP_DET_TBL IEX_SCORE_PUB.SCORE_COMP_DET_TBL_TYPE;
100
101 -- updated by clchang 04/19/2004 for 11i.IEX.H
102 -- added new column METRIC_FLAG
103 -- updated by jypark 11/05/2004 for 11i.IEX.H
104 -- added new column DISPLAY_ORDER
105
106 TYPE SCORE_COMP_TYPE_REC_TYPE IS RECORD (
107 SCORE_COMP_TYPE_ID NUMBER ,
108 OBJECT_VERSION_NUMBER NUMBER ,
109 PROGRAM_ID NUMBER ,
110 SECURITY_GROUP_ID NUMBER ,
111 LAST_UPDATE_DATE DATE ,
112 LAST_UPDATED_BY NUMBER ,
113 LAST_UPDATE_LOGIN NUMBER ,
114 CREATION_DATE DATE ,
115 CREATED_BY NUMBER ,
116 SCORE_COMP_VALUE VARCHAR2(2000) ,
117 ACTIVE_FLAG VARCHAR2(10) ,
118 JTF_OBJECT_CODE VARCHAR2(25) ,
119 SOURCE_LANG VARCHAR2(4) ,
120 SCORE_COMP_NAME VARCHAR2(45) ,
121 DESCRIPTION VARCHAR2(80) ,
122 FUNCTION_FLAG VARCHAR2(1) ,
123 METRIC_FLAG VARCHAR2(1) ,
124 DISPLAY_ORDER NUMBER);
125
126
127 TYPE SCORE_COMP_TYPE_TBL_TYPE IS TABLE OF SCORE_COMP_TYPE_REC_TYPE
128 INDEX BY binary_integer;
129
130 G_MISS_SCORE_COMP_TYPE_REC IEX_SCORE_PUB.SCORE_COMP_TYPE_REC_TYPE;
131 G_MISS_SCORE_COMP_TYPE_TBL IEX_SCORE_PUB.SCORE_COMP_TYPE_TBL_TYPE;
132
133
134 TYPE SCORE_ID_TBL IS TABLE OF NUMBER INDEX BY binary_integer;
135
136 TYPE SCORE_COMP_ID_TBL IS TABLE OF NUMBER INDEX BY binary_integer;
137
138 TYPE SCORE_COMP_DET_ID_TBL IS TABLE OF NUMBER INDEX BY binary_integer;
139
140 /*
141 -- Start of comments
142 -- API name : Init_AST_SCORE_Rec
143 -- Type : Private
144 -- Pre-reqs : None.
145 -- Function : Initializes and returns a new raw SQL query record type
146 -- as required by AST_SCORE_PUB
147 -- Parameters : None
148 -- Returns : IEX_SCORE_PUB.SCORE_REC_TYPE
149 -- Version : Current version 1.0
150 -- Initial version 1.0
151 -- End of comments
152
153 FUNCTION Init_IEX_SCORE_Rec RETURN IEX_SCORE_PUB.SCORE_REC_TYPE;
154
155
156 -- Start of comments
157 -- API name : Init_IEX_SCORE_COMP_Rec
158 -- Type : Private
159 -- Pre-reqs : None.
160 -- Function : Initializes and returns a new raw SQL query record type
161 -- as required by IEX_SCORE_PUB
162 -- Parameters : None
163 -- Returns : IEX_SCORE_PUB.SCORE_COMP_REC_TYPE
164 -- Version : Current version 1.0
165 -- Initial version 1.0
166 -- End of comments
167
168 FUNCTION Init_IEX_SCORE_COMP_Rec RETURN IEX_SCORE_PUB.SCORE_COMP_REC_TYPE;
169
170
171 -- Start of comments
172 -- API name : Init_IEX_SCORE_COMP_TBL
173 -- Type : Private
174 -- Pre-reqs : None.
175 -- Function : Initializes and returns a new raw SQL query record type
176 -- as required by IEX_SCORE_PUB
177 -- Parameters : None
178 -- Returns : IEX_SCORE_PUB.SCORE_COMP_TBL_TYPE
179 -- Version : Current version 1.0
180 -- Initial version 1.0
181 -- End of comments
182
183 FUNCTION Init_IEX_SCORE_COMP_Tbl RETURN IEX_SCORE_PUB.SCORE_COMP_TBL_TYPE;
184
185 */
186
187 /*#
188 * Creates scoring engines.
189 * @param p_api_version API Version Number
190 * @param p_init_msg_list Intialize Message Stack
191 * @param p_commit Commit flag
192 * @param p_score_rec Collections Scoring Engine table
193 * @param x_dup_status duplicate flag
194 * @param x_return_status API return status
195 * @param x_msg_count Number of error messages
196 * @param x_msg_data Error message data
197 * @param x_score_id scoring engine identifier
198 * @rep:scope public
199 * @rep:lifecycle active
200 * @rep:displayname Create Scoring Engines
201 */
202 Procedure Create_Score
203 (p_api_version IN NUMBER := 1.0,
204 p_init_msg_list IN VARCHAR2 ,
205 p_commit IN VARCHAR2 ,
206 P_SCORE_REC IN IEX_SCORE_PUB.SCORE_REC_TYPE ,
207 x_dup_status OUT NOCOPY VARCHAR2,
208 x_return_status OUT NOCOPY VARCHAR2,
209 x_msg_count OUT NOCOPY NUMBER,
210 x_msg_data OUT NOCOPY VARCHAR2,
211 X_SCORE_ID OUT NOCOPY NUMBER);
212
213
214 /*#
215 * updates scoring engines.
216 * @param p_api_version API Version Number
217 * @param p_init_msg_list Intialize Message Stack
218 * @param p_commit Commit flag
219 * @param p_score_tbl Scoring Engine table
220 * @param x_dup_status duplicate flag
221 * @param x_return_status API return status
222 * @param x_msg_count Number of error messages
223 * @param x_msg_data Error message data
224 * @rep:scope public
225 * @rep:lifecycle active
226 * @rep:displayname Update Scoring Engines
227 */
228 Procedure Update_Score
229 (p_api_version IN NUMBER := 1.0,
230 p_init_msg_list IN VARCHAR2 ,
231 p_commit IN VARCHAR2 ,
232 P_SCORE_TBL IN IEX_SCORE_PUB.SCORE_TBL_TYPE ,
233 x_dup_status OUT NOCOPY VARCHAR2,
234 x_return_status OUT NOCOPY VARCHAR2,
235 x_msg_count OUT NOCOPY NUMBER,
236 x_msg_data OUT NOCOPY VARCHAR2);
237
238
239
240 /*#
241 * Deletes scoring engines.
242 * @param p_api_version API Version Number
243 * @param p_init_msg_list Intialize Message Stack
244 * @param p_commit Commit flag
245 * @param p_score_id_tbl Scoring Engine Identifier table
246 * @param x_return_status API return status
247 * @param x_msg_count Number of error messages
248 * @param x_msg_data Error message data
249 * @rep:scope public
250 * @rep:lifecycle active
251 * @rep:displayname Delete Scoring Engines
252 */
253 Procedure Delete_Score
254 (p_api_version IN NUMBER := 1.0,
255 p_init_msg_list IN VARCHAR2 ,
256 p_commit IN VARCHAR2 ,
257 P_SCORE_ID_TBL IN IEX_SCORE_PUB.SCORE_ID_TBL,
258 x_return_status OUT NOCOPY VARCHAR2,
259 x_msg_count OUT NOCOPY NUMBER,
260 x_msg_data OUT NOCOPY VARCHAR2);
261
262
263
264 /*#
265 * creates scoring engine components.
266 * @param p_api_version API Version Number
267 * @param p_init_msg_list Intialize Message Stack
268 * @param p_commit Commit flag
269 * @param p_score_comp_rec Scoring Component table
270 * @param x_return_status API return status
271 * @param x_msg_count Number of error messages
272 * @param x_msg_data Error message data
273 * @param x_score_comp_id Scoring component identifier
274 * @rep:scope public
275 * @rep:lifecycle active
276 * @rep:displayname Create Scoring Engine Components
277 */
278 Procedure Create_SCORE_COMP
279 ( p_api_version IN NUMBER := 1.0,
280 p_init_msg_list IN VARCHAR2 ,
281 p_commit IN VARCHAR2 ,
282 p_SCORE_COMP_Rec IN IEX_SCORE_PUB.SCORE_COMP_REC_Type,
283 x_return_status OUT NOCOPY VARCHAR2,
284 x_msg_count OUT NOCOPY NUMBER,
285 x_msg_data OUT NOCOPY VARCHAR2,
286 x_SCORE_COMP_ID OUT NOCOPY NUMBER);
287
288 /*#
289 * updates scoring engine components.
290 * @param p_api_version API Version Number
291 * @param p_init_msg_list Intialize Message Stack
292 * @param p_commit Commit flag
293 * @param p_score_comp_tbl Scoring component table
294 * @param x_return_status API return status
295 * @param x_msg_count Number of error messages
296 * @param x_msg_data Error message data
297 * @rep:scope public
298 * @rep:lifecycle active
299 * @rep:displayname Update Scoring Engine Components
300 */
301 Procedure Update_SCORE_COMP
302 ( p_api_version IN NUMBER := 1.0,
303 p_init_msg_list IN VARCHAR2 ,
304 p_commit IN VARCHAR2 ,
305 p_SCORE_COMP_TBL IN IEX_SCORE_PUB.SCORE_COMP_TBL_Type ,
306 x_return_status OUT NOCOPY VARCHAR2,
307 x_msg_count OUT NOCOPY NUMBER,
308 x_msg_data OUT NOCOPY VARCHAR2);
309
310 /*#
311 * Deletes scoring engine components.
312 * @param p_api_version API Version Number
313 * @param p_init_msg_list Intialize Message Stack
314 * @param p_commit Commit flag
315 * @param p_score_id scoring engine identifier
316 * @param p_score_comp_id_tbl Scoring component identifier table
317 * @param x_return_status API return status
318 * @param x_msg_count Number of error messages
319 * @param x_msg_data Error message data
320 * @rep:scope public
321 * @rep:lifecycle active
322 * @rep:displayname Delete Scoring Engine Components
323 */
324 Procedure Delete_SCORE_COMP
325 ( p_api_version IN NUMBER := 1.0,
326 p_init_msg_list IN VARCHAR2 ,
327 p_commit IN VARCHAR2 ,
328 p_SCORE_ID IN NUMBER,
329 p_SCORE_COMP_ID_TBL IN IEX_SCORE_PUB.SCORE_COMP_ID_TBL,
330 x_return_status OUT NOCOPY VARCHAR2,
331 x_msg_count OUT NOCOPY NUMBER,
332 x_msg_data OUT NOCOPY VARCHAR2);
333
334 /*#
335 * creates scoring engine component types.
336 * @param p_api_version API Version Number
337 * @param p_init_msg_list Intialize Message Stack
338 * @param p_commit Commit flag
339 * @param p_score_comp_type_rec Scoring component type table
340 * @param x_dup_status duplicate flag
341 * @param x_return_status API return status
342 * @param x_msg_count Number of error messages
343 * @param x_msg_data Error message data
344 * @param x_score_comp_type_id Scoring component type identifier
345 * @rep:scope public
346 * @rep:lifecycle active
347 * @rep:displayname Create Scoring Engine Component Types
348 */
349 Procedure Create_SCORE_COMP_TYPE
350 ( p_api_version IN NUMBER := 1.0,
351 p_init_msg_list IN VARCHAR2 ,
352 p_commit IN VARCHAR2 ,
353 p_SCORE_COMP_TYPE_Rec IN IEX_SCORE_PUB.SCORE_COMP_TYPE_REC_Type,
354 x_dup_status OUT NOCOPY VARCHAR2,
355 x_return_status OUT NOCOPY VARCHAR2,
356 x_msg_count OUT NOCOPY NUMBER,
357 x_msg_data OUT NOCOPY VARCHAR2,
358 x_SCORE_COMP_TYPE_ID OUT NOCOPY NUMBER);
359
360 /*#
361 * updates scoring engine component types.
362 * @param p_api_version API Version Number
363 * @param p_init_msg_list Intialize Message Stack
364 * @param p_commit Commit flag
365 * @param p_score_comp_type_tbl Scoring component type table
366 * @param x_dup_status duplicate flag
367 * @param x_return_status API return status
368 * @param x_msg_count Number of error messages
369 * @param x_msg_data Error message data
370 * @rep:scope public
371 * @rep:lifecycle active
372 * @rep:displayname Update Scoring Engine Component Types
373 */
374 Procedure Update_SCORE_COMP_TYPE
375 ( p_api_version IN NUMBER := 1.0,
376 p_init_msg_list IN VARCHAR2 ,
377 p_commit IN VARCHAR2 ,
378 p_SCORE_COMP_TYPE_TBL IN IEX_SCORE_PUB.SCORE_COMP_TYPE_TBL_TYPE,
379 x_dup_status OUT NOCOPY VARCHAR2,
380 x_return_status OUT NOCOPY VARCHAR2,
384 /*#
381 x_msg_count OUT NOCOPY NUMBER,
382 x_msg_data OUT NOCOPY VARCHAR2);
383
385 * deletes scoring engine component types.
386 * @param p_api_version API Version Number
387 * @param p_init_msg_list Intialize Message Stack
388 * @param p_commit Commit flag
389 * @param p_score_comp_type_tbl Scoring component type table
390 * @param x_return_status API return status
391 * @param x_msg_count Number of error messages
392 * @param x_msg_data Error message data
393 * @rep:scope public
394 * @rep:lifecycle active
395 * @rep:displayname Delete Scoring Engine Component Types
396 */
397 Procedure Delete_SCORE_COMP_TYPE
398 ( p_api_version IN NUMBER := 1.0,
399 p_init_msg_list IN VARCHAR2 ,
400 p_commit IN VARCHAR2 ,
401 p_SCORE_COMP_TYPE_TBL IN IEX_SCORE_PUB.SCORE_COMP_TYPE_TBL_TYPE ,
402 x_return_status OUT NOCOPY VARCHAR2,
403 x_msg_count OUT NOCOPY NUMBER,
404 x_msg_data OUT NOCOPY VARCHAR2);
405
406
407
408 /*#
409 * creates scoring engine component details.
410 * @param p_api_version API Version Number
411 * @param p_init_msg_list Intialize Message Stack
412 * @param p_commit Commit flag
413 * @param px_score_comp_det_tbl Scoring component details table
414 * @param x_return_status API return status
415 * @param x_msg_count Number of error messages
416 * @param x_msg_data Error message data
417 * @rep:scope public
418 * @rep:lifecycle active
419 * @rep:displayname Create Scoring Engine Component Details
420 */
421 Procedure Create_SCORE_COMP_DET
422 ( p_api_version IN NUMBER := 1.0,
423 p_init_msg_list IN VARCHAR2 ,
424 p_commit IN VARCHAR2 ,
425 px_SCORE_COMP_DET_TBL IN OUT NOCOPY IEX_SCORE_PUB.SCORE_COMP_DET_TBL_Type,
426 x_return_status OUT NOCOPY VARCHAR2,
427 x_msg_count OUT NOCOPY NUMBER,
428 x_msg_data OUT NOCOPY VARCHAR2);
429
430 /*#
431 * updates scoring engine component details.
432 * @param p_api_version API Version Number
433 * @param p_init_msg_list Intialize Message Stack
434 * @param p_commit Commit flag
435 * @param p_score_comp_det_tbl Scoring component details table
436 * @param x_return_status API return status
437 * @param x_msg_count Number of error messages
438 * @param x_msg_data Error message data
439 * @rep:scope public
440 * @rep:lifecycle active
441 * @rep:displayname Update Scoring Engine Component Details
442 */
443 Procedure Update_SCORE_COMP_DET
444 ( p_api_version IN NUMBER := 1.0,
445 p_init_msg_list IN VARCHAR2 ,
446 p_commit IN VARCHAR2 ,
447 p_SCORE_COMP_DET_TBL IN IEX_SCORE_PUB.SCORE_COMP_DET_TBL_Type ,
448 x_return_status OUT NOCOPY VARCHAR2,
449 x_msg_count OUT NOCOPY NUMBER,
450 x_msg_data OUT NOCOPY VARCHAR2);
451
452
453
454 /*#
455 * deletes scoring engine component details.
456 * @param p_api_version API Version Number
457 * @param p_init_msg_list Intialize Message Stack
458 * @param p_commit Commit flag
459 * @param p_Score_comp_id Associated scoring component identifier
460 * @param p_score_comp_det_id_tbl Scoring component details table
461 * @param x_return_status API return status
462 * @param x_msg_count Number of error messages
463 * @param x_msg_data Error message data
464 * @rep:scope public
465 * @rep:lifecycle active
466 * @rep:displayname Delete Scoring Engine Component Details
467 */
468 Procedure Delete_SCORE_COMP_DET
469 ( p_api_version IN NUMBER := 1.0,
470 p_init_msg_list IN VARCHAR2 ,
471 p_commit IN VARCHAR2 ,
472 p_SCORE_COMP_ID IN NUMBER,
473 p_SCORE_COMP_DET_ID_TBL IN IEX_SCORE_PUB.SCORE_COMP_DET_ID_TBL,
474 x_return_status OUT NOCOPY VARCHAR2,
475 x_msg_count OUT NOCOPY NUMBER,
476 x_msg_data OUT NOCOPY VARCHAR2);
477
478
479 /* 12/09/2002 clchang added
480 * new function to make a copy of scoring engine.
481 */
482 /*#
483 * copies scoring engine including filters, components and component details.
484 * @param p_api_version API Version Number
485 * @param p_init_msg_list Intialize Message Stack
486 * @param p_commit Commit flag
487 * @param p_score_id Original score identifier
488 * @param x_score_id Identifier for copied score
489 * @param x_return_status API return status
490 * @param x_msg_count Number of error messages
491 * @param x_msg_data Error message data
492 * @rep:scope public
493 * @rep:lifecycle active
494 * @rep:displayname Copy Scoring Engine
495 */
496 Procedure Copy_ScoringEngine
497 (p_api_version IN NUMBER := 1.0,
498 p_init_msg_list IN VARCHAR2 ,
499 p_commit IN VARCHAR2 ,
500 p_score_id IN NUMBER DEFAULT NULL,
501 x_score_id OUT NOCOPY NUMBER ,
502 x_return_status OUT NOCOPY VARCHAR2,
503 x_msg_count OUT NOCOPY NUMBER,
504 x_msg_data OUT NOCOPY VARCHAR2);
505
506
507
508 /*#
509 * generates scores for a special scoring engine.
510 * @param p_api_version API Version Number
511 * @param p_init_msg_list Intialize Message Stack
512 * @param p_commit Commit flag
513 * @param p_score_id Score identifier used to score
514 * @param x_return_status API return status
515 * @param x_msg_count Number of error messages
516 * @param x_msg_data Error message data
517 * @rep:scope public
518 * @rep:lifecycle active
519 * @rep:displayname Get Score
520 */
521 Procedure Get_Score(p_api_version IN NUMBER := 1.0,
522 p_init_msg_list IN VARCHAR2 ,
523 p_commit IN VARCHAR2,
524 p_score_id IN NUMBER DEFAULT NULL,
525 x_return_status OUT NOCOPY VARCHAR2,
526 x_msg_count OUT NOCOPY NUMBER,
527 x_msg_data OUT NOCOPY VARCHAR2);
528
529
530 END IEX_SCORE_PUB;