1 PACKAGE HZ_CLASSIFICATION_V2PUB AS
2 /*$Header: ARH2CLSS.pls 120.12 2006/08/17 10:15:51 idali noship $ */
3 /*#
4 * This package contains the public APIs for class categories, class code
5 * relationships, class code assignments, and class category uses.
6 * @rep:scope public
7 * @rep:product HZ
8 * @rep:displayname Classification
9 * @rep:category BUSINESS_ENTITY HZ_CLASSIFICATION
10 * @rep:lifecycle active
11 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
12 */
13
14 --------------------------------------
15 -- declaration of record type
16 --------------------------------------
17
18 TYPE class_category_rec_type IS RECORD (
19 class_category VARCHAR2(30),
20 allow_multi_parent_flag VARCHAR2(1),
21 allow_multi_assign_flag VARCHAR2(1),
22 allow_leaf_node_only_flag VARCHAR2(1),
23 created_by_module VARCHAR2(150),
24 application_id NUMBER,
25 delimiter VARCHAR2(1)
26 );
27
28 TYPE class_code_relation_rec_type IS RECORD (
29 class_category VARCHAR2(30),
30 class_code VARCHAR2(30),
31 sub_class_code VARCHAR2(30),
32 start_date_active DATE,
33 end_date_active DATE,
34 created_by_module VARCHAR2(150),
35 application_id NUMBER
36 );
37
38 TYPE code_assignment_rec_type IS RECORD (
39 code_assignment_id NUMBER,
40 owner_table_name VARCHAR2(30),
41 owner_table_id NUMBER,
42 owner_table_key_1 VARCHAR2(255),
43 owner_table_key_2 VARCHAR2(255),
44 owner_table_key_3 VARCHAR2(255),
45 owner_table_key_4 VARCHAR2(255),
46 owner_table_key_5 VARCHAR2(255),
47 class_category VARCHAR2(30),
48 class_code VARCHAR2(30),
49 primary_flag VARCHAR2(1),
50 content_source_type VARCHAR2(30) := HZ_PARTY_V2PUB.G_MISS_CONTENT_SOURCE_TYPE,
51 start_date_active DATE,
52 end_date_active DATE,
53 status VARCHAR2(1),
54 created_by_module VARCHAR2(150),
55 rank NUMBER,
56 application_id NUMBER,
57 -- SSM SST Integration and Extension
58 actual_content_source VARCHAR2(30)
59 );
60
61 TYPE class_category_use_rec_type IS RECORD (
62 class_category VARCHAR2(30),
63 owner_table VARCHAR2(240),
64 column_name VARCHAR2(240),
65 additional_where_clause VARCHAR2(4000),
66 created_by_module VARCHAR2(150),
67 application_id NUMBER
68 );
69
70 TYPE class_code_rec_type IS RECORD (
71 type VARCHAR2(30),
72 code VARCHAR2(30),
73 meaning VARCHAR2(80),
74 description VARCHAR2(240),
75 start_date_active DATE,
76 end_date_active DATE,
77 enabled_flag VARCHAR2(1),
78 attribute_category VARCHAR2(30),
79 attribute1 VARCHAR2(150),
80 attribute2 VARCHAR2(150),
81 attribute3 VARCHAR2(150),
82 attribute4 VARCHAR2(150),
83 attribute5 VARCHAR2(150),
84 attribute6 VARCHAR2(150),
85 attribute7 VARCHAR2(150),
86 attribute8 VARCHAR2(150),
87 attribute9 VARCHAR2(150),
88 attribute10 VARCHAR2(150),
89 attribute11 VARCHAR2(150),
90 attribute12 VARCHAR2(150),
91 attribute13 VARCHAR2(150),
92 attribute14 VARCHAR2(150),
93 attribute15 VARCHAR2(150)
94 );
95
96 --------------------------------------
97 -- declaration of public procedures and functions
98 --------------------------------------
99
100 /**
101 * PROCEDURE create_class_category
102 *
103 * DESCRIPTION
104 * Creates class category.
105 *
106 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
107 *
108 * ARGUMENTS
109 * IN:
110 * p_init_msg_list Initialize message stack if it is set to
111 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
112 * p_class_category_rec Class category record.
113 * IN/OUT:
114 * OUT:
115 * x_return_status Return status after the call. The status can
116 * be FND_API.G_RET_STS_SUCCESS (success),
117 * FND_API.G_RET_STS_ERROR (error),
118 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
119 * x_msg_count Number of messages in message stack.
120 * x_msg_data Message text if x_msg_count is 1.
121 *
122 * NOTES
123 *
124 * MODIFICATION HISTORY
125 *
126 * 07-23-2001 Indrajit Sen o Created.
127 *
128 */
129
130 /*#
131 * Use this routine to create a class category. With this API you can create a record in the
132 * HZ_CLASS_CATEGORIES table. A class category provides a method of classifying parties and
133 * party sites. For example, the NAICS_1997 (1997 North American Industry Classification
134 * System) is a class category. A class category corresponds to an AR lookup type and the
135 * related class codes are lookup codes of the lookup type. You must create a valid lookup
136 * type before you can use that lookup type to create a class category.
137 * @rep:scope public
138 * @rep:lifecycle active
139 * @rep:displayname Create Class Category
140 * @rep:businessevent oracle.apps.ar.hz.ClassCategory.create
141 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
142 */
143 PROCEDURE create_class_category(
144 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
145 p_class_category_rec IN CLASS_CATEGORY_REC_TYPE,
146 x_return_status OUT NOCOPY VARCHAR2,
147 x_msg_count OUT NOCOPY NUMBER,
148 x_msg_data OUT NOCOPY VARCHAR2
149 );
150
151 /**
152 * PROCEDURE update_class_category
153 *
154 * DESCRIPTION
155 * Updates class category.
156 *
157 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
158 *
159 * ARGUMENTS
160 * IN:
161 * p_init_msg_list Initialize message stack if it is set to
162 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
163 * p_class_category_rec Class category record.
164 * IN/OUT:
165 * p_object_version_number Used for locking the being updated record.
166 * OUT:
167 * x_return_status Return status after the call. The status can
168 * be FND_API.G_RET_STS_SUCCESS (success),
169 * FND_API.G_RET_STS_ERROR (error),
170 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
171 * x_msg_count Number of messages in message stack.
172 * x_msg_data Message text if x_msg_count is 1.
173 *
174 * NOTES
175 *
176 * MODIFICATION HISTORY
177 *
178 * 07-23-2001 Indrajit Sen o Created.
179 *
180 */
181
182 /*#
183 * Use this routine to update a class category. The API updates records in the
184 * HZ_CLASS_CATEGORIES table.
185 * @rep:scope public
186 * @rep:lifecycle active
187 * @rep:displayname Update Class Category
188 * @rep:businessevent oracle.apps.ar.hz.ClassCategory.update
189 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
190 */
191 PROCEDURE update_class_category(
192 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
193 p_class_category_rec IN CLASS_CATEGORY_REC_TYPE,
194 p_object_version_number IN OUT NOCOPY NUMBER,
195 x_return_status OUT NOCOPY VARCHAR2,
196 x_msg_count OUT NOCOPY NUMBER,
197 x_msg_data OUT NOCOPY VARCHAR2
198 );
199
200 /**
201 * PROCEDURE get_class_category_rec
202 *
203 * DESCRIPTION
204 * Gets class category record.
205 *
206 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
207 *
208 * ARGUMENTS
209 * IN:
210 * p_init_msg_list Initialize message stack if it is set to
211 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
212 * p_class_category Class category name.
213 * IN/OUT:
214 * OUT:
215 * x_class_category_rec Returned class category record.
216 * x_return_status Return status after the call. The status can
217 * be FND_API.G_RET_STS_SUCCESS (success),
218 * FND_API.G_RET_STS_ERROR (error),
219 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
220 * x_msg_count Number of messages in message stack.
221 * x_msg_data Message text if x_msg_count is 1.
222 *
223 * NOTES
224 *
225 * MODIFICATION HISTORY
226 *
227 * 07-23-2001 Indrajit Sen o Created.
228 *
229 */
230
231 PROCEDURE get_class_category_rec (
232 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
233 p_class_category IN VARCHAR2,
234 x_class_category_rec OUT NOCOPY CLASS_CATEGORY_REC_TYPE,
235 x_return_status OUT NOCOPY VARCHAR2,
236 x_msg_count OUT NOCOPY NUMBER,
237 x_msg_data OUT NOCOPY VARCHAR2
238 );
239
240 /**
241 * PROCEDURE create_class_code_relation
242 *
243 * DESCRIPTION
244 * Creates class code relationship.
245 *
246 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
247 *
248 * ARGUMENTS
249 * IN:
250 * p_init_msg_list Initialize message stack if it is set to
251 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
252 * p_class_code_relation_rec Class code relation record.
253 * IN/OUT:
254 * OUT:
255 * x_return_status Return status after the call. The status can
256 * be FND_API.G_RET_STS_SUCCESS (success),
257 * FND_API.G_RET_STS_ERROR (error),
258 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
259 * x_msg_count Number of messages in message stack.
260 * x_msg_data Message text if x_msg_count is 1.
261 *
262 * NOTES
263 *
264 * MODIFICATION HISTORY
265 *
266 * 07-23-2001 Indrajit Sen o Created.
267 *
268 */
269
270 /*#
271 * Use this routine to create a class code relation. The API creates a record in the
272 * HZ_CLASS_CODE_RELATIONS table. The class codes are related to a class category.
273 * @rep:scope public
274 * @rep:lifecycle active
275 * @rep:displayname Create Class Code Relation
276 * @rep:businessevent oracle.apps.ar.hz.ClassCodeRelation.create
277 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
278 */
279 PROCEDURE create_class_code_relation(
280 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
281 p_class_code_relation_rec IN CLASS_CODE_RELATION_REC_TYPE,
282 x_return_status OUT NOCOPY VARCHAR2,
283 x_msg_count OUT NOCOPY NUMBER,
284 x_msg_data OUT NOCOPY VARCHAR2
285 );
286
287 /**
288 * PROCEDURE update_class_code_relation
289 *
290 * DESCRIPTION
291 * Updates class code relation.
292 *
293 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
294 *
295 * ARGUMENTS
296 * IN:
297 * p_init_msg_list Initialize message stack if it is set to
298 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
299 * p_class_code_relation_rec Class code relation record.
300 * IN/OUT:
301 * p_object_version_number Used for locking the being updated record.
302 * OUT:
303 * x_return_status Return status after the call. The status can
304 * be FND_API.G_RET_STS_SUCCESS (success),
305 * FND_API.G_RET_STS_ERROR (error),
306 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
307 * x_msg_count Number of messages in message stack.
308 * x_msg_data Message text if x_msg_count is 1.
309 *
310 * NOTES
311 *
312 * MODIFICATION HISTORY
313 *
314 * 07-23-2001 Indrajit Sen o Created.
315 *
316 */
317
318 /*#
319 * Use this routine to update a class code relation. The API updates records in the
320 * HZ_CLASS_CODE_RELATIONS table.
321 * @rep:scope public
322 * @rep:lifecycle active
323 * @rep:displayname Update Class Code Relation
324 * @rep:businessevent oracle.apps.ar.hz.ClassCodeRelation.update
325 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
326 */
327 PROCEDURE update_class_code_relation(
328 p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE,
329 p_class_code_relation_rec IN CLASS_CODE_RELATION_REC_TYPE,
330 p_object_version_number IN OUT NOCOPY NUMBER,
331 x_return_status OUT NOCOPY VARCHAR2,
332 x_msg_count OUT NOCOPY NUMBER,
333 x_msg_data OUT NOCOPY VARCHAR2
334 );
335
336 /**
337 * PROCEDURE get_class_code_relation_rec
338 *
339 * DESCRIPTION
340 * Gets class code relation record.
341 *
342 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
343 *
344 * ARGUMENTS
345 * IN:
346 * p_init_msg_list Initialize message stack if it is set to
347 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
348 * p_class_category Class category name.
349 * p_class_code Class code.
350 * p_sub_class_code Sub class code.
351 * p_start_date_active Start date active.
352 * IN/OUT:
353 * OUT:
354 * x_class_code_relation_rec Returned class code relation record.
355 * x_return_status Return status after the call. The status can
356 * be FND_API.G_RET_STS_SUCCESS (success),
357 * FND_API.G_RET_STS_ERROR (error),
358 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
359 * x_msg_count Number of messages in message stack.
360 * x_msg_data Message text if x_msg_count is 1.
361 *
362 * NOTES
363 *
364 * MODIFICATION HISTORY
365 *
369
366 * 07-23-2001 Indrajit Sen o Created.
367 *
368 */
370 PROCEDURE get_class_code_relation_rec(
371 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
372 p_class_category IN VARCHAR2,
373 p_class_code IN VARCHAR2,
374 p_sub_class_code IN VARCHAR2,
375 p_start_date_active IN DATE,
376 x_class_code_relation_rec OUT NOCOPY CLASS_CODE_RELATION_REC_TYPE,
377 x_return_status OUT NOCOPY VARCHAR2,
378 x_msg_count OUT NOCOPY NUMBER,
379 x_msg_data OUT NOCOPY VARCHAR2
380 );
381
382 /**
383 * PROCEDURE create_code_assignment
384 *
385 * DESCRIPTION
386 * Creates code assignment.
387 *
388 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
389 *
390 * ARGUMENTS
391 * IN:
392 * p_init_msg_list Initialize message stack if it is set to
393 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
394 * p_code_assignement_rec Code assignment record.
395 * IN/OUT:
396 * OUT:
397 * x_return_status Return status after the call. The status can
398 * be FND_API.G_RET_STS_SUCCESS (success),
399 * FND_API.G_RET_STS_ERROR (error),
400 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
401 * x_msg_count Number of messages in message stack.
402 * x_msg_data Message text if x_msg_count is 1.
403 * x_code_assignment_id Code assignment ID.
404 *
405 * NOTES
406 *
407 * MODIFICATION HISTORY
408 *
409 * 07-23-2001 Indrajit Sen o Created.
410 *
411 */
412
413 /*#
414 * Use this routine to create a code assignment. The API creates records in the
415 * HZ_CODE_ASSIGNMENTS table. The assignment of a class code links an instance of the class
416 * code to an instance of the classified table. The HZ_CODE_ASSIGNMENTS table is an
417 * intersection table that links the classification codes in the AR_LOOKUPS view to the
418 * instances of the parties or other entities stored in the table identified in the
419 * OWNER_TABLE_NAME column. The OWNER_TABLE_ID column holds the value of the ID column in the
420 * classified table.
421 * @rep:scope public
422 * @rep:lifecycle active
423 * @rep:displayname Create Code Assignment
424 * @rep:businessevent oracle.apps.ar.hz.CodeAssignment.create
425 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
426 */
427 PROCEDURE create_code_assignment(
428 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
429 p_code_assignment_rec IN CODE_ASSIGNMENT_REC_TYPE,
430 x_return_status OUT NOCOPY VARCHAR2,
431 x_msg_count OUT NOCOPY NUMBER,
432 x_msg_data OUT NOCOPY VARCHAR2,
433 x_code_assignment_id OUT NOCOPY NUMBER
434 );
435
436 /**
437 * PROCEDURE update_code_assignment
438 *
439 * DESCRIPTION
440 * Updates code assignment.
441 *
442 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
443 *
444 * ARGUMENTS
445 * IN:
446 * p_init_msg_list Initialize message stack if it is set to
447 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
448 * p_code_assignment_rec Code assignment record.
449 * IN/OUT:
450 * p_object_version_number Used for locking the being updated record.
451 * OUT:
452 * x_return_status Return status after the call. The status can
453 * be FND_API.G_RET_STS_SUCCESS (success),
454 * FND_API.G_RET_STS_ERROR (error),
455 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
456 * x_msg_count Number of messages in message stack.
457 * x_msg_data Message text if x_msg_count is 1.
458 *
459 * NOTES
460 *
461 * MODIFICATION HISTORY
462 *
463 * 07-23-2001 Indrajit Sen o Created.
464 *
465 */
466
467 /*#
468 * Use this routine to update a Code Assignment. The API updates records in the
469 * HZ_CODE_ASSIGNMENTS table.
470 * @rep:scope public
471 * @rep:lifecycle active
472 * @rep:displayname Update Code Assignment
473 * @rep:businessevent oracle.apps.ar.hz.CodeAssignment.update
474 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
475 */
476 PROCEDURE update_code_assignment(
477 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
478 p_code_assignment_rec IN CODE_ASSIGNMENT_REC_TYPE,
479 p_object_version_number IN OUT NOCOPY NUMBER,
480 x_return_status OUT NOCOPY VARCHAR2,
481 x_msg_count OUT NOCOPY NUMBER,
482 x_msg_data OUT NOCOPY VARCHAR2
483 );
484
485 /**
486 * PROCEDURE set_primary_code_assignment
487 *
488 * DESCRIPTION
489 * Sets primary code assignment.
490 *
494 * IN:
491 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
492 *
493 * ARGUMENTS
495 * p_init_msg_list Initialize message stack if it is set to
496 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
497 * p_owner_table_name Owner table name.
498 * p_owner_table_id Owner table ID.
499 * p_class_category Class category.
500 * p_class_code Class code.
501 * p_content_source_type Contact source type.
502 * IN/OUT:
503 * OUT:
504 * x_code_assignment_id Code assignment ID.
505 * x_return_status Return status after the call. The status can
506 * be FND_API.G_RET_STS_SUCCESS (success),
507 * FND_API.G_RET_STS_ERROR (error),
508 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
509 * x_msg_count Number of messages in message stack.
510 * x_msg_data Message text if x_msg_count is 1.
511 *
512 * NOTES
513 *
514 * MODIFICATION HISTORY
515 *
516 * 07-23-2001 Indrajit Sen o Created.
517 *
518 */
519
520 procedure set_primary_code_assignment(
521 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
522 p_owner_table_name IN VARCHAR2,
523 p_owner_table_id IN NUMBER,
524 p_class_category IN VARCHAR2,
525 p_class_code IN VARCHAR2,
526 p_content_source_type IN VARCHAR2,
527 p_created_by_module IN VARCHAR2, /* Bug 3856348 */
528 x_code_assignment_id OUT NOCOPY NUMBER,
529 x_return_status OUT NOCOPY VARCHAR2,
530 x_msg_count OUT NOCOPY NUMBER,
531 x_msg_data OUT NOCOPY VARCHAR2
532 );
533
534 /**
535 * PROCEDURE get_code_assignment_rec
536 *
537 * DESCRIPTION
538 * Gets code assignment record.
539 *
540 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
541 *
542 * ARGUMENTS
543 * IN:
544 * p_init_msg_list Initialize message stack if it is set to
545 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
546 * p_code_assignment_id Code assignment ID.
547 * IN/OUT:
548 * OUT:
549 * x_code_assignment_rec Returned code assignment record.
550 * x_return_status Return status after the call. The status can
551 * be FND_API.G_RET_STS_SUCCESS (success),
552 * FND_API.G_RET_STS_ERROR (error),
553 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
554 * x_msg_count Number of messages in message stack.
555 * x_msg_data Message text if x_msg_count is 1.
556 *
557 * NOTES
558 *
559 * MODIFICATION HISTORY
560 *
561 * 07-23-2001 Indrajit Sen o Created.
562 *
563 */
564
565 PROCEDURE get_code_assignment_rec(
566 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
567 p_code_assignment_id IN NUMBER,
568 x_code_assignment_rec OUT NOCOPY CODE_ASSIGNMENT_REC_TYPE,
569 x_return_status OUT NOCOPY VARCHAR2,
570 x_msg_count OUT NOCOPY NUMBER,
571 x_msg_data OUT NOCOPY VARCHAR2
572 );
573
574 /**
575 * PROCEDURE create_class_category_use
576 *
577 * DESCRIPTION
578 * Creates class category use.
579 *
580 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
581 *
582 * ARGUMENTS
583 * IN:
584 * p_init_msg_list Initialize message stack if it is set to
585 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
586 * p_class_category_use_rec Class category use record.
587 * IN/OUT:
588 * OUT:
589 * x_return_status Return status after the call. The status can
590 * be FND_API.G_RET_STS_SUCCESS (success),
591 * FND_API.G_RET_STS_ERROR (error),
592 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
593 * x_msg_count Number of messages in message stack.
594 * x_msg_data Message text if x_msg_count is 1.
595 *
596 * NOTES
597 *
598 * MODIFICATION HISTORY
599 *
600 * 07-23-2001 Indrajit Sen o Created.
601 *
602 */
603
604 /*#
605 * Use this routine to create a class category Use. The API creates a record
606 * in the HZ_CLASS_CATEGORY_USES table. The classification model is an open structure. The
607 * HZ_CLASS_CATEGORY_USES table indicates which tables or subsets of tables use which
608 * classifications. The HZ_CLASS_CATEGORY_USES table stores information about the tables which
609 * use a particular class category. The ADDITIONAL_WHERE_CLAUSE is the filter for the subsets
610 * of tables. For example, you can use the SIC 1987 class category to classify parties
611 * that have the party type Organization. The COLUMN_NAME column stores the value of the
615 * @rep:lifecycle active
612 * OWNER_TABLE column in the classified table that is used as the ID column for the class code
613 * assignment.
614 * @rep:scope public
616 * @rep:displayname Create Class Category Use
617 * @rep:businessevent oracle.apps.ar.hz.ClassCategoryUse.create
618 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
619 */
620 PROCEDURE create_class_category_use (
621 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
622 p_class_category_use_rec IN CLASS_CATEGORY_USE_REC_TYPE,
623 x_return_status OUT NOCOPY VARCHAR2,
624 x_msg_count OUT NOCOPY NUMBER,
625 x_msg_data OUT NOCOPY VARCHAR2
626 );
627
628 /**
629 * PROCEDURE update_class_category_use
630 *
631 * DESCRIPTION
632 * Updates class category use.
633 *
634 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
635 *
636 * ARGUMENTS
637 * IN:
638 * p_init_msg_list Initialize message stack if it is set to
639 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
640 * p_class_category_use_rec Class category use record.
641 * IN/OUT:
642 * p_object_version_number Used for locking the being updated record.
643 * OUT:
644 * x_return_status Return status after the call. The status can
645 * be FND_API.G_RET_STS_SUCCESS (success),
646 * FND_API.G_RET_STS_ERROR (error),
647 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
648 * x_msg_count Number of messages in message stack.
649 * x_msg_data Message text if x_msg_count is 1.
650 *
651 * NOTES
652 *
653 * MODIFICATION HISTORY
654 *
655 * 07-23-2001 Indrajit Sen o Created.
656 *
657 */
658
659 /*#
660 * Use this routine to update a Class Category Use. The API updates records in the
661 * HZ_CLASS_CATEGORY_USES table.
662 * @rep:scope public
663 * @rep:lifecycle active
664 * @rep:displayname Update Class Category Use
665 * @rep:businessevent oracle.apps.ar.hz.ClassCategoryUse.update
666 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
667 */
668 PROCEDURE update_class_category_use (
669 p_init_msg_list IN VARCHAR2:=FND_API.G_FALSE,
670 p_class_category_use_rec IN CLASS_CATEGORY_USE_REC_TYPE,
671 p_object_version_number IN OUT NOCOPY NUMBER,
672 x_return_status OUT NOCOPY VARCHAR2,
673 x_msg_count OUT NOCOPY NUMBER,
674 x_msg_data OUT NOCOPY VARCHAR2
675 );
676
677 /**
678 * PROCEDURE get_class_category_use_rec
679 *
680 * DESCRIPTION
681 * Gets class category use record.
682 *
683 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
684 *
685 * ARGUMENTS
686 * IN:
687 * p_init_msg_list Initialize message stack if it is set to
688 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
689 * p_class_category Class category name.
690 * p_owner_table Owner table name.
691 * IN/OUT:
692 * OUT:
693 * x_class_category_use_rec Returned class category use record.
694 * x_return_status Return status after the call. The status can
695 * be FND_API.G_RET_STS_SUCCESS (success),
696 * FND_API.G_RET_STS_ERROR (error),
697 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
698 * x_msg_count Number of messages in message stack.
699 * x_msg_data Message text if x_msg_count is 1.
700 *
701 * NOTES
702 *
703 * MODIFICATION HISTORY
704 *
705 * 07-23-2001 Indrajit Sen o Created.
706 *
707 */
708
709 PROCEDURE get_class_category_use_rec(
710 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
711 p_class_category IN VARCHAR2,
712 p_owner_table IN VARCHAR2,
713 x_class_category_use_rec OUT NOCOPY CLASS_CATEGORY_USE_REC_TYPE,
714 x_return_status OUT NOCOPY VARCHAR2,
715 x_msg_count OUT NOCOPY NUMBER,
716 x_msg_data OUT NOCOPY VARCHAR2
717 );
718
719
720 /**
721 * FUNCTION is_valid_category
722 *
723 * DESCRIPTION
724 * ERS No: 2074686. The function checks if a given id can be assigned to a class_category and
725 * owner_table. It returns 'T' if party_id can be assigned or 'F' else.
726 *
727 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
728 *
729 * ARGUMENTS
730 * IN:
731 * p_owner_table Owner table name.
732 * p_class_category Name of class category
733 * p_id id (party_id or a party_relationship_id)
734 * IN/OUT:
735 * OUT:
736 *
737 * NOTES
738 *
739 * MODIFICATION HISTORY
740 *
741 * 02-14-2002 Anupam Bordia o Created.
742 * 02-18-2002 Anupam Bordia o Altered signature to remove OUT NOCOPY parameters so that the
743 * function can be used within a SQL.
744 * 02-03-2003 Sreedhar Mohan o Rewritten the function as part of new HZ.K changes.
745 *
746 */
747
748 /*#
749 * Use this function to determine if an ID can be assigned to a class_category and
750 * owner_table. The function returns T if an ID can be assigned to the given
751 * class_category. Otherwise, the function returns F.
752 * @return True if class category is valid
753 * @rep:scope public
754 * @rep:lifecycle active
755 * @rep:displayname Is Class Category Valid
756 * @rep:doccd 120hztig.pdf Classification API Use, Oracle Trading Community Architecture Technical Implementation Guide
757 */
761 p_id NUMBER := FND_API.G_MISS_NUM,
758 FUNCTION IS_VALID_CATEGORY(
759 p_owner_table VARCHAR2,
760 p_class_category VARCHAR2,
762 p_key_1 VARCHAR2 := FND_API.G_MISS_CHAR,
763 p_key_2 VARCHAR2 := FND_API.G_MISS_CHAR,
764 p_key_3 VARCHAR2 := FND_API.G_MISS_CHAR,
765 p_key_4 VARCHAR2 := FND_API.G_MISS_CHAR,
766 p_key_5 VARCHAR2 := FND_API.G_MISS_CHAR
767 ) RETURN VARCHAR2;
768
769
770 /**
771 * PROCEDURE create_class_code
772 *
773 * DESCRIPTION
774 * This is a wrapper on top of FND_LOOKUP_VALUES_PKG.insert_row. It also
775 * updates frozen flag and validate class code meaning.
776 *
777 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
778 *
779 * ARGUMENTS
780 * IN:
781 * p_init_msg_list Initialize message stack if it is set to
782 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
783 * p_class_code_rec Lookup value related columns
784 * IN/OUT:
785 * OUT:
786 * x_return_status Return status after the call. The status can
787 * be FND_API.G_RET_STS_SUCCESS (success),
788 * FND_API.G_RET_STS_ERROR (error),
789 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
790 * x_msg_count Number of messages in message stack.
791 * x_msg_data Message text if x_msg_count is 1.
792 *
793 * NOTES
794 *
795 * MODIFICATION HISTORY
796 *
797 * 05-28-2002 Amy Wu o Created.
798 *
799 */
800
801 PROCEDURE create_class_code(
802 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
803 p_class_code_rec IN CLASS_CODE_REC_TYPE,
804 x_return_status OUT NOCOPY VARCHAR2,
805 x_msg_count OUT NOCOPY NUMBER,
806 x_msg_data OUT NOCOPY VARCHAR2
807 );
808
809
810
811 /**
812 * PROCEDURE update_class_code
813 *
814 * DESCRIPTION
815 * This is a wrapper on top of FND_LOOKUP_VALUES_PKG.update_row. It also
816 * updates frozen flag and validate class code meaning.
817 *
821 * IN:
818 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
819 *
820 * ARGUMENTS
822 * p_init_msg_list Initialize message stack if it is set to
823 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
824 * p_class_code_rec Lookup value related columns
825 * IN/OUT:
826 * p_object_version_number Used for locking the being updated record.
827 * OUT:
828 * x_return_status Return status after the call. The status can
829 * be FND_API.G_RET_STS_SUCCESS (success),
830 * FND_API.G_RET_STS_ERROR (error),
831 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
832 * x_msg_count Number of messages in message stack.
833 * x_msg_data Message text if x_msg_count is 1.
834 *
835 * NOTES
836 *
837 * MODIFICATION HISTORY
838 *
839 * 05-28-2002 Amy Wu o Created.
840 *
841 */
842
843 PROCEDURE update_class_code(
844 p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE,
845 p_class_code_rec IN CLASS_CODE_REC_TYPE,
846 p_object_version_number IN OUT NOCOPY NUMBER,
847 x_return_status OUT NOCOPY VARCHAR2,
848 x_msg_count OUT NOCOPY NUMBER,
849 x_msg_data OUT NOCOPY VARCHAR2
850 );
851
852
853 PROCEDURE v2_copy_class_category (
854 p_class_category IN VARCHAR2,
855 p_copy_class_category IN VARCHAR2,
856 x_return_status IN OUT NOCOPY VARCHAR2
857 );
858
859 END HZ_CLASSIFICATION_V2PUB;
[Home] [Help]