1 PACKAGE AMS_ACTMETRIC_PVT AS
2 /* $Header: amsvamts.pls 120.1 2005/12/16 16:22:29 dmvincen noship $ */
3
4 --
5 -- Start of comments.
6 --
7 -- NAME
8 -- Ams_ActMetrics_Pvt 11.5.6
9 --
10 -- PURPOSE
11 -- This package is a private package used for defining constants, records,
12 -- types and procedures for activity metrics API.
13 --
14 -- Procedures:
15 -- Create_ActMetric
16 -- Update_ActMetric
17 -- Lock_ActMetric
18 -- Delete_ActMetric
19 -- Validate_ActMetric
20 -- Complete_ActMetric_Rec
21 -- check_forecasted_cost
22 -- Get_Object_Info
23 -- Init_ActMetric_Rec
24 -- Get_Results
25 -- Convert_Currency
26 -- Convert_Currency2
27 -- Convert_Currency_Vector
28 -- Convert_Currency_Object
29 -- delete_act_metrics
30 -- NOTES
31 --
32 --
33 -- HISTORY
34 -- 06/26/1999 choang Created.
35 -- 10/13/1999 ptendulk Modified According to new standards.
36 -- 01/18/2000 bgeorge Reviewed code, added new columns to the rec type,
37 -- removed isseeded function from the spec
38 -- 04/17/2000 tdonohoe Added new columns to the act_metric_rec_type to
39 -- support hierarchy traversal.
40 -- 09/14/2000 sveerave@us Added check_forecasted_cost to check exceeding of
41 -- forecasted cost
42 -- 10/11/2000 SVEERAVE@us added Init_ActMetric_Rec to initialize the record
43 -- for update
44 -- 02/12/2001 dmvincen Made Make_ActMetric_Dirty public for BUG#1603925.
45 -- 03/21/2001 huli added the "description" and "act_metric_date" fields
46 -- 05/02/2001 dmvincen Added Invalidate_Rollup. BUG#1753241.
47 -- 05/07/2001 huili Added "depend_act_metric" field for act_metric_rec_type
48 -- 05/17/2001 dmvincen Patch for 11.5.4.11 without variable metrics,
49 -- description or transaction date (act_metric_date).
50 -- 05/23/2001 dmvincen Added desc, trans date and variable metrics 11.5.5.
51 -- 08/21/2001 dmvincen Exposed procedure Get_Trans_curr_code.
52 -- Exposed procedure Convert_Currency.
53 -- Exposed procedure Convert_Currency2.
54 -- 09/10/2001 huili Added code to check status for all business objects.
55 -- 09/21/2001 huili Added the "Get_Object_Info" module.
56 -- 11/27/2001 dmvincen Added Get_Results for results cue card support.
57 -- 12/05/2001 DMVINCEN Added Convert_Currency_Vector and
58 -- Convert_Currency_Object for chart support.
59 -- 03/08/2002 DMVINCEN Added function_used_by_id, arc_function_used_by.
60 -- 10/21/2002 YZHAO 11.5.9 add new columns for budget allocation
61 -- 17-Sep-2003 sunkumar Object level locking introduced
62 -- 10/02/2003 dmvincen Added forecasted_variable_value.
63 -- 30-jan-2004 choang bug 3410962: ALIST integration for deleting lists in
64 -- a target group.
65 -- 20-Apr-2004 dmvincen Added convert_to_trans_value for graph support.
66 -- 12/16/2005 dmvincen BUG4868582: Expose Freeze status for UI.
67
68 -- Begin section added by choang - 05/26/1999
69 --
70 -- Start AMS_ACT_METRICS_ALL
71 --
72 TYPE act_metric_rec_type
73 IS RECORD (
74 activity_metric_id NUMBER,
75 last_update_date DATE,
76 last_updated_by NUMBER,
77 creation_date DATE,
78 created_by NUMBER,
79 last_update_login NUMBER,
80 object_version_number NUMBER,
81 act_metric_used_by_id NUMBER,
82 arc_act_metric_used_by VARCHAR2(30),
83 purchase_req_raised_flag VARCHAR2(1),
84 application_id NUMBER,
85 sensitive_data_flag VARCHAR2(1),
86 budget_id NUMBER,
87 metric_id NUMBER,
88 transaction_currency_code VARCHAR2(15),
89 trans_forecasted_value NUMBER,
90 trans_committed_value NUMBER,
91 trans_actual_value NUMBER,
92 functional_currency_code VARCHAR2(15),
93 func_forecasted_value NUMBER,
94 dirty_flag VARCHAR2(1),
95 func_committed_value NUMBER,
96 func_actual_value NUMBER,
97 last_calculated_date DATE,
98 variable_value NUMBER,
99 forecasted_variable_value NUMBER,
100 computed_using_function_value NUMBER,
101 metric_uom_code VARCHAR2(3),
102 org_id NUMBER,
103 difference_since_last_calc NUMBER,
104 activity_metric_origin_id NUMBER,
105 arc_activity_metric_origin VARCHAR2(30),
106 days_since_last_refresh NUMBER,
107 scenario_id NUMBER,
108 SUMMARIZE_TO_METRIC NUMBER,
109 ROLLUP_TO_METRIC NUMBER,
110 hierarchy_id NUMBER,
111 start_node NUMBER,
112 from_level NUMBER,
113 to_level NUMBER,
114 from_date DATE,
115 TO_DATE DATE,
116 amount1 NUMBER,
117 amount2 NUMBER,
118 amount3 NUMBER,
119 percent1 NUMBER,
120 percent2 NUMBER,
121 percent3 NUMBER,
122 published_flag VARCHAR2(1),
123 pre_function_name VARCHAR2(4000),
124 post_function_name VARCHAR2(4000),
125 attribute_category VARCHAR2(30),
126 attribute1 VARCHAR2(150),
127 attribute2 VARCHAR2(150),
128 attribute3 VARCHAR2(150),
129 attribute4 VARCHAR2(150),
130 attribute5 VARCHAR2(150),
131 attribute6 VARCHAR2(150),
132 attribute7 VARCHAR2(150),
133 attribute8 VARCHAR2(150),
134 attribute9 VARCHAR2(150),
135 attribute10 VARCHAR2(150),
136 attribute11 VARCHAR2(150),
137 attribute12 VARCHAR2(150),
138 attribute13 VARCHAR2(150),
139 attribute14 VARCHAR2(150),
140 attribute15 VARCHAR2(150),
141 description VARCHAR2(4000),
142 act_metric_date DATE,
143 depend_act_metric NUMBER,
144 FUNCTION_USED_BY_ID NUMBER,
145 ARC_FUNCTION_USED_BY VARCHAR2(30),
146 /* 05/15/2002 yzhao: add 6 new columns for top-down bottom-up budgeting */
147 hierarchy_type VARCHAR2(30),
148 status_code VARCHAR2(30),
149 method_code VARCHAR2(30),
150 action_code VARCHAR2(30),
151 basis_year NUMBER,
152 ex_start_node VARCHAR2(1)
153 /* 05/15/2002 yzhao: add ends */
154 );
155
156 TYPE currency_table IS TABLE OF NUMBER;
157
158 --
159 -- End AMS_ACT_METRICS_ALL
160 --
161 --
162 -- End of section added by choang.
163 --
164 --
165 -- End of comments.
166 --
167
168 -- Start of comments
169 -- API Name Have_Published
170 -- Type Public
171 -- Pre-reqs None.
172 -- Function Check the status for a business object
173 -- Parameters
174 -- IN p_obj_type IN VARCHAR2 Required
175 -- p_obj_id IN NUMBER Required
176 -- OUT x_flag OUT VARCHAR2
177 -- Version Current version: 1.0
178 -- End of comments
179
180 PROCEDURE Have_Published (
181 p_obj_type IN VARCHAR2,
182 p_obj_id IN NUMBER,
183 x_flag OUT NOCOPY VARCHAR2
184 );
185
186 -- Start of comments
187 -- API Name Get_Object_Info
188 -- Type Public
189 -- Pre-reqs None.
190 -- Function Get object information
191 -- Parameters
192 -- IN p_obj_type IN VARCHAR2 Required
193 -- p_obj_id IN NUMBER Required
194 -- OUT x_flag OUT VARCHAR2
195 -- Version Current version: 1.0
196 -- End of comments
197
198 PROCEDURE Get_Object_Info (
199 p_obj_type IN VARCHAR2,
200 p_obj_id IN NUMBER,
201 x_flag OUT NOCOPY VARCHAR2,
202 x_currency OUT NOCOPY VARCHAR2
203 );
204
205
206 -- Start of comments
207 -- NAME
208 -- Init_ActMetric_Rec
209 --
210 -- PURPOSE
211 -- This Procedure will initialize the Record for Activity Metric.
212 -- It will be called before call to Update Activity Metric
213 --
214 -- NOTES
215 --
216 -- HISTORY
217 -- 10/11/2000 SVEERAVE Created.
218 --
219 -- End of comments
220
221 PROCEDURE Init_ActMetric_Rec(
222 x_act_metric_rec IN OUT NOCOPY ams_actmetric_pvt.Act_metric_rec_type
223 );
224
225 -- Start of comments
226 -- API Name Create_ActMetric
227 -- Type Private
228 -- Pre-reqs None.
229 -- Function Creates an association of a metric to a business
230 -- object by creating a record in AMS_ACT_METRICS_ALL.
231 -- Parameters
232 -- IN p_api_version IN NUMBER Required
233 -- p_init_msg_list IN VARCHAR2 Optional
234 -- Default := FND_API.G_FALSE
235 -- p_commit IN VARCHAR2 Optional
236 -- Default := FND_API.G_FALSE
237 -- p_validation_level IN NUMBER Optional
238 -- Default := FND_API.G_VALID_LEVEL_FULL
239 -- p_act_metric_rec IN act_metric_rec_type Required
240 -- OUT x_return_status OUT VARCHAR2
241 -- x_msg_count OUT NUMBER
242 -- x_msg_data OUT VARCHAR2
243 -- Version Current version: 1.0
244 -- Previous version: 1.0
245 -- Initial version: 1.0
246 -- End of comments
247
248
249 PROCEDURE Create_ActMetric (
250 p_api_version IN NUMBER,
251 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
252 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
253 --p_commit IN VARCHAR2 := Fnd_Api.G_TRUE,
254 p_validation_level IN NUMBER := Fnd_Api.G_Valid_Level_Full,
255
256 x_return_status OUT NOCOPY VARCHAR2,
257 x_msg_count OUT NOCOPY NUMBER,
258 x_msg_data OUT NOCOPY VARCHAR2,
259
260 p_act_metric_rec IN act_metric_rec_type,
261 x_activity_metric_id OUT NOCOPY NUMBER
262 );
263
264 -- Start of comments
265 -- API Name Update_ActMetric
266 -- Type Private
267 -- Pre-reqs None.
268 -- Function Updates the association of a metric to a business
269 -- object by creating a record in AMS_ACT_METRICS_ALL.
270 -- Parameters
271 -- IN p_api_version IN NUMBER Required
272 -- p_init_msg_list IN VARCHAR2 Optional
273 -- Default := FND_API.G_FALSE
274 -- p_commit IN VARCHAR2 Optional
275 -- Default := FND_API.G_FALSE
279 -- OUT x_return_status OUT VARCHAR2
276 -- p_validation_level IN NUMBER Optional
277 -- Default := FND_API.G_VALID_LEVEL_FULL
278 -- p_act_metric_rec IN act_metric_rec_type Required
280 -- x_msg_count OUT NUMBER
281 -- x_msg_data OUT VARCHAR2
282 -- Version Current version: 1.0
283 -- Previous version: 1.0
284 -- Initial version: 1.0
285 -- End of comments
286
287
288 PROCEDURE Update_ActMetric (
289 p_api_version IN NUMBER,
290 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
291 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
292 p_validation_level IN NUMBER := Fnd_Api.G_VALID_LEVEL_FULL,
293
294 x_return_status OUT NOCOPY VARCHAR2,
295 x_msg_count OUT NOCOPY NUMBER,
296 x_msg_data OUT NOCOPY VARCHAR2,
297
298 p_act_metric_rec IN act_metric_rec_type
299 );
300
301 -- Start of comments
302 -- API Name Delete_ActMetric
303 -- Type Private
304 -- Pre-reqs None.
305 -- Function Deletes the association of a metric to a business
306 -- object by creating a record in AMS_ACT_METRICS_ALL.
307 -- Parameters
308 -- IN p_api_version IN NUMBER Required
309 -- p_init_msg_list IN VARCHAR2 Optional
310 -- Default := FND_API.G_FALSE
311 -- p_commit IN VARCHAR2 Optional
312 -- Default := FND_API.G_FALSE
313 -- p_arc_act_metric_used_by IN VARCHAR2 Required
314 -- p_act_metric_used_by_id IN NUMBER Required
315 -- p_activity_metric_id IN NUMBER NULL (never set!)
316 -- OUT x_return_status OUT VARCHAR2
317 -- x_msg_count OUT NUMBER
318 -- x_msg_data OUT VARCHAR2
319 -- Version Current version: 1.0
320 -- Previous version: 1.0
321 -- Initial version: 1.0
322 -- End of comments
323
324 PROCEDURE Delete_ActMetric (
325 p_api_version IN NUMBER,
326 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
327 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
328
329 x_return_status OUT NOCOPY VARCHAR2,
330 x_msg_count OUT NOCOPY NUMBER,
331 x_msg_data OUT NOCOPY VARCHAR2,
332
333 p_arc_act_metric_used_by IN VARCHAR2,
334 p_act_metric_used_by_id IN NUMBER,
335 p_activity_metric_id IN NUMBER := NULL,
336 p_object_version_number IN NUMBER := NULL
337 );
338
339 -- Start of comments
340 -- API Name Delete_ActMetric
341 -- Type Private
342 -- Pre-reqs None.
343 -- Function Deletes the association of a metric to a business
344 -- object by creating a record in AMS_ACT_METRICS_ALL.
345 -- Parameters
346 -- IN p_api_version IN NUMBER Required
347 -- p_init_msg_list IN VARCHAR2 Optional
348 -- Default := FND_API.G_FALSE
349 -- p_commit IN VARCHAR2 Optional
350 -- Default := FND_API.G_FALSE
351 -- p_activity_metric_id IN NUMBER Required
352 -- p_object_version_number IN NUMBER
353 -- OUT x_return_status OUT VARCHAR2
354 -- x_msg_count OUT NUMBER
355 -- x_msg_data OUT VARCHAR2
356 -- Version Current version: 1.0
357 -- Previous version: 1.0
358 -- Initial version: 1.0
359 -- End of comments
360
361 PROCEDURE Delete_ActMetric (
362 p_api_version IN NUMBER,
363 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
364 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
365
366 x_return_status OUT NOCOPY VARCHAR2,
367 x_msg_count OUT NOCOPY NUMBER,
368 x_msg_data OUT NOCOPY VARCHAR2,
369
370 p_activity_metric_id IN NUMBER,
371 p_object_version_number IN NUMBER
372 );
373
374 -- Start of comments
375 -- API Name Lock_ActMetric
376 -- Type Private
377 -- Pre-reqs None.
378 -- Function Lock the given row in AMS_ACT_METRICS_ALL.
379 -- Parameters
380 -- IN p_api_version IN NUMBER Required
381 -- p_init_msg_list IN VARCHAR2 Optional
382 -- Default := FND_API.G_FALSE
383 -- p_commit IN VARCHAR2 Optional
384 -- Default := FND_API.G_FALSE
385 -- p_activity_metric_id IN NUMBER Required
386 -- p_object_version_number IN NUMBER Required
387 -- OUT x_return_status OUT VARCHAR2
388 -- x_msg_count OUT NUMBER
389 -- x_msg_data OUT VARCHAR2
390 -- Version Current version: 1.0
391 -- Previous version: 1.0
395
392 -- Initial version: 1.0
393 -- End of comments
394
396 PROCEDURE Lock_ActMetric (
397 p_api_version IN NUMBER,
398 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
399
400 x_return_status OUT NOCOPY VARCHAR2,
401 x_msg_count OUT NOCOPY NUMBER,
402 x_msg_data OUT NOCOPY VARCHAR2,
403
404 p_activity_metric_id IN NUMBER,
405 p_object_version_number IN NUMBER
406 );
407
408 -- Start of comments
409 -- API Name Validate_ActMetric
410 -- Type Private
411 -- Pre-reqs None.
412 -- Function Validate items in metrics associated with business
413 -- objects.
414 -- Parameters
415 -- IN p_api_version IN NUMBER Required
416 -- p_init_msg_list IN VARCHAR2 Optional
417 -- Default := FND_API.G_FALSE
418 -- p_commit IN VARCHAR2 Optional
419 -- Default := FND_API.G_FALSE
420 -- p_validation_level IN NUMBER Optional
421 -- Default := FND_API.G_VALID_LEVEL_FULL
422 -- p_act_metric_rec IN act_metric_rec_type Required
423 -- OUT x_return_status OUT VARCHAR2
424 -- x_msg_count OUT NUMBER
425 -- x_msg_data OUT VARCHAR2
426 -- Version Current version: 1.0
427 -- Previous version: 1.0
428 -- Initial version: 1.0
429 -- End of comments
430
431
432 PROCEDURE Validate_ActMetric (
433 p_api_version IN NUMBER,
434 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
435 p_validation_level IN NUMBER := Fnd_Api.G_Valid_Level_Full,
436
437 x_return_status OUT NOCOPY VARCHAR2,
438 x_msg_count OUT NOCOPY NUMBER,
439 x_msg_data OUT NOCOPY VARCHAR2,
440
441 p_act_metric_rec IN act_metric_rec_type
442 );
443
444
445 -- Start of comments
446 -- API Name Validate_ActMetric_Items
447 -- Type Private
448 -- Pre-reqs None.
449 -- Function Validate Activity Metric Items
450 -- Parameters
451 -- IN p_act_metric_rec IN act_metric_rec_type Required
452 -- p_validate_mode IN VARCHAR2
453 -- OUT x_return_status OUT VARCHAR2
454 -- Version Current version: 1.0
455 -- Previous version: 1.0
456 -- Initial version: 1.0
457 -- End of comments
458
459 PROCEDURE Validate_ActMetric_items(
460 p_act_metric_rec IN act_metric_rec_type,
461 p_validation_mode IN VARCHAR2 := Jtf_Plsql_Api.g_create,
462 x_return_status OUT NOCOPY VARCHAR2
463 ) ;
464
465 -- Start of comments
466 -- API Name Validate_ActMetric_Record
467 -- Type Private
468 -- Pre-reqs None.
469 -- Function Validate Activity Metric Records
470 -- Parameters
471 -- IN p_act_metric_rec IN act_metric_rec_type Required
472 -- p_complete_rec IN act_metric_rec_type Required
473 -- OUT x_return_status OUT VARCHAR2
474 -- Version Current version: 1.0
475 -- Previous version: 1.0
476 -- Initial version: 1.0
477 -- End of comments
478
479 PROCEDURE Validate_ActMetric_record(
480 p_act_metric_rec IN act_metric_rec_type,
481 p_complete_rec IN act_metric_rec_type,
482 x_return_status OUT NOCOPY VARCHAR2
483 ) ;
484
485
486 -- Start of comments
487 -- API Name Complete_ActMetric_Rec
488 -- Type Private
489 -- Pre-reqs None.
490 -- Function This Process returns the details for the Activity metric ID if
491 -- Not passed.
492 -- Parameters
493 -- IN p_act_metric_rec IN act_metric_rec_type Required
494 -- OUT x_complete_rec OUT act_metric_rec_type
495 -- Version Current version: 1.0
496 -- Previous version: 1.0
497 -- Initial version: 1.0
498 -- End of comments
499 PROCEDURE Complete_ActMetric_Rec(
500 p_act_metric_rec IN act_metric_rec_type,
501 x_complete_rec IN OUT NOCOPY act_metric_rec_type
502 );
503
504 -- Start of comments
505 -- API Name SetCommittedVal
506 -- Type Private
507 -- Pre-reqs None.
508 -- Function Updates the functional committed value of a specific
509 -- metric that is associated with the given business
510 -- entity.
511 -- Parameters
512 -- IN p_api_version IN NUMBER
513 -- p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE
514 -- p_commit IN VARCHAR2 := FND_API.G_FALSE
515 -- p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
516 -- p_arc_act_metric_used_by IN VARCHAR2 Required
517 -- p_act_metric_used_by_id IN NUMBER Required
518 -- p_metric_id IN NUMBER Required
519 -- p_func_committed_value IN NUMBER Required
520 -- OUT x_return_status OUT VARCHAR2
524 -- Previous version: 1.0
521 -- x_msg_count OUT NUMBER
522 -- x_msg_data OUT VARCHAR2
523 -- Version Current version: 1.0
525 -- Initial version: 1.0
526 -- End of comments
527
528 PROCEDURE SetCommittedVal (
529 p_api_version IN NUMBER,
530 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
531 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
532 p_validation_level IN NUMBER := Fnd_Api.G_VALID_LEVEL_FULL,
533
534 x_return_status OUT NOCOPY VARCHAR2,
535 x_msg_count OUT NOCOPY NUMBER,
536 x_msg_data OUT NOCOPY VARCHAR2,
537
538 p_arc_act_metric_used_by IN VARCHAR2,
539 p_act_metric_used_by_id IN NUMBER,
540 p_metric_id IN NUMBER,
541 p_func_committed_value IN NUMBER
542 );
543
544 -- Start of comments
545 -- API Name Default_Func_Currency
546 -- Type Private
547 -- Pre-reqs None.
548 -- Function Returns the functional Currency of the transaction.
549 --
550 -- Parameters
551 -- OUT Default Functional Currency
552 -- Version Current version: 1.0
553 -- Previous version: 1.0
554 -- Initial version: 1.0
555 -- End of comments
556 FUNCTION Default_Func_Currency
557 RETURN VARCHAR2 ;
558
559 -- Start of comments
560 -- API Name check_forecasted_cost
561 -- Type Private
562 -- Pre-reqs None.
563 -- Function Checks forecasted amount against object's budget amount,
564 -- and passes out message in case it is exceeded.
565 --
566 -- PARAMETERS
567 --p_obj_type IN VARCHAR2,
568 --p_obj_id IN NUMBER,
569 --p_category_id IN NUMBER,
570 --p_exceeded OUT NOCOPY VARCHAR2,
571 --p_message OUT NOCOPY VARCHAR2)
572 -- Version Current version: 1.0
573 -- Previous version: 1.0
574 -- Initial version: 1.0
575 -- End of comments
576
577 PROCEDURE check_forecasted_cost(p_obj_type IN VARCHAR2,
578 p_obj_id IN NUMBER,
579 p_category_id IN NUMBER,
580 x_exceeded OUT NOCOPY VARCHAR2,
581 x_message OUT NOCOPY VARCHAR2) ;
582
583
584 PROCEDURE Sync_rollup_currency
585 (p_obj_id IN NUMBER
586 ,p_obj_type IN VARCHAR2
587 ,x_return_status OUT NOCOPY VARCHAR2
588 ) ;
589
590 -- BUG#1603925: Added for Called from
591 -- AMS_refreshMetric_PVT.create_refresh_parent_level().
592 PROCEDURE Make_ActMetric_Dirty (
593 p_activity_metric_id IN NUMBER
594 );
595
596 --
597 -- Start of comments
598 -- API Name Invalidate_Rollup
599 -- Type Private
600 -- Pre-reqs None.
601 -- Function Set rollup pointers to null when parent object is changed.
602 --
603 -- PARAMETERS
604 -- p_used_by_type - eg. 'CAMP', 'EVEO', etc.
605 -- p_used_by_id - The identifier for the object.
606 -- End of comments
607 --
608 PROCEDURE Invalidate_Rollup(
609 p_api_version IN NUMBER,
610 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
611 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
612
613 x_return_status OUT NOCOPY VARCHAR2,
614 x_msg_count OUT NOCOPY NUMBER,
615 x_msg_data OUT NOCOPY VARCHAR2,
616
617 p_used_by_type IN VARCHAR2,
618 p_used_by_id IN NUMBER
619 );
620
621 --
622 -- Start of comments
623 -- API Name Post_Costs
624 -- Type Private
625 -- Pre-reqs None.
626 -- Function Post costs to budget.
627 --
628 -- PARAMETERS
629 -- p_used_by_type - eg. 'CAMP', 'EVEO', etc.
630 -- p_used_by_id - The identifier for the object.
631 -- End of comments
632 --
633 PROCEDURE Post_Costs (
634 p_api_version IN NUMBER,
635 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
636 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
637 p_validation_level IN NUMBER := Fnd_Api.G_VALID_LEVEL_FULL,
638
639 x_return_status OUT NOCOPY VARCHAR2,
640 x_msg_count OUT NOCOPY NUMBER,
641 x_msg_data OUT NOCOPY VARCHAR2,
642
643 p_obj_type IN VARCHAR2,
644 p_obj_id IN NUMBER
645 );
646
647 -- ---------------------------------------------------------------------
648 -- PROCEDURE
649 -- Convert_Currency
650 -- DESCRIPTION
651 -- This procedure is copied from GL_CURRENCY_API so that rounding can be
652 -- controlled. The functional currency need not be rounded because
653 -- precision will be lost when converting to other currencies.
654 -- The displayed currencies must be rounded.
655 -- NOTE
656 -- Modified from code done by ptendulk, and choang.
657 -- HISTORY
658 -- 09-Aug-2001 dmvincen Created.
662 p_from_currency IN VARCHAR2,
659 ---------------------------------------------------------------------
660 PROCEDURE Convert_Currency (
661 x_return_status OUT NOCOPY VARCHAR2,
663 p_to_currency IN VARCHAR2,
664 p_conv_date IN DATE DEFAULT SYSDATE,
665 p_from_amount IN NUMBER,
666 x_to_amount OUT NOCOPY NUMBER,
667 p_round IN VARCHAR2
668 );
669 PROCEDURE Convert_Currency2 (
670 x_return_status OUT NOCOPY VARCHAR2,
671 p_from_currency IN VARCHAR2,
672 p_to_currency IN VARCHAR2,
673 p_conv_date IN DATE DEFAULT SYSDATE,
674 p_from_amount IN NUMBER,
675 x_to_amount OUT NOCOPY NUMBER,
676 p_from_amount2 IN NUMBER,
677 x_to_amount2 OUT NOCOPY NUMBER,
678 p_round IN VARCHAR2
679 );
680 PROCEDURE Convert_Currency_Vector (
681 x_return_status OUT NOCOPY VARCHAR2,
682 p_from_currency IN VARCHAR2,
683 p_to_currency IN VARCHAR2,
684 p_conv_date IN DATE DEFAULT SYSDATE,
685 p_amounts IN OUT NOCOPY CURRENCY_TABLE,
686 p_round IN VARCHAR2 DEFAULT FND_API.G_TRUE
687 );
688 PROCEDURE Convert_Currency_Object (
689 x_return_status OUT NOCOPY VARCHAR2,
690 p_object_id IN NUMBER,
691 p_object_type IN VARCHAR2,
692 p_conv_date IN DATE DEFAULT SYSDATE,
693 p_amounts IN OUT NOCOPY CURRENCY_TABLE,
694 p_round IN VARCHAR2 DEFAULT FND_API.G_TRUE
695 );
696
697 -- ---------------------------------------------------------------------
698 -- PROCEDURE
699 -- Convert_to_trans_value
700 -- DESCRIPTION
701 -- Returns the transaction with conversion from the func value.
702 -- NOTE
703 --
704 -- HISTORY
705 -- 20-Apr-2004 dmvincen Created.
706 ---------------------------------------------------------------------
707 FUNCTION convert_to_trans_value(
708 p_func_value in NUMBER,
709 p_object_type in VARCHAR2,
710 p_object_id in NUMBER,
711 p_display_type in VARCHAR2
712 )
713 return NUMBER;
714
715 -- ---------------------------------------------------------------------
716 -- PROCEDURE
717 -- Get_Trans_curr_code
718 -- DESCRIPTION
719 -- Returns the transaction currency code for the given object.
720 -- NOTE
721 --
722 -- HISTORY
723 -- 09-Aug-2001 dmvincen Created.
724 ---------------------------------------------------------------------
725 PROCEDURE Get_Trans_curr_code
726 (p_obj_id IN NUMBER
727 ,p_obj_type IN VARCHAR2
728 ,x_trans_curr_code OUT NOCOPY VARCHAR2
729 );
730
731 -- Record for results cue card detail.
732 TYPE result_record IS RECORD
733 (
734 slice_date DATE,
735 currency_code VARCHAR2(15),
736 forecasted_value NUMBER,
737 actual_value NUMBER
738 );
739
740 -- Table for results cue card detail.
741 TYPE result_table IS TABLE OF result_record;
742
743 ---------------------------------------------------------------------
744 -- PROCEDURE
745 -- Get_Results
746 -- DESCRIPTION
747 -- Return the results for results cue card.
748 -- Output only. No updates.
749 -- NOTE
750 -- HISTORY
751 -- 27-NOV-2001 dmvincen Created.
752 ---------------------------------------------------------------------
753 PROCEDURE GET_RESULTS(
754 p_api_version IN NUMBER,
755 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
756 x_return_status OUT NOCOPY VARCHAR2,
757 x_msg_count OUT NOCOPY NUMBER,
758 x_msg_data OUT NOCOPY VARCHAR2,
759
760 p_metric_id IN NUMBER,
761 p_object_type IN VARCHAR2,
762 p_object_id IN NUMBER,
763 p_value_type IN VARCHAR2,
764 p_from_date IN DATE,
765 p_to_date IN DATE,
766 p_increment IN NUMBER,
767 p_interval_unit IN VARCHAR2,
768 x_result_table OUT NOCOPY result_table
769 );
770
771
772
773
774
775 --======================================================================
776 -- procedure
777 -- copy_act_metrics
778 --
779 -- PURPOSE
780 -- Created to copy activity metrics
781 --
782 -- HISTORY
783 -- 13-may-2003 sunkumar created
784 -- 17-jul-2003 sunkumar bug# 3050304 (default value of p_commit should match in package and body)
785 --======================================================================
786
787
788 procedure copy_act_metrics (
789 p_api_version IN NUMBER,
790 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
791 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
792 p_validation_level IN NUMBER := Fnd_Api.G_Valid_Level_Full,
793 p_source_object_type IN VARCHAR2,
794 p_source_object_id IN NUMBER,
795 p_target_object_id IN NUMBER,
796 x_return_status OUT NOCOPY VARCHAR2,
797 x_msg_count OUT NOCOPY NUMBER,
798 x_msg_data OUT NOCOPY VARCHAR2
799 );
800
801 --======================================================================
802 -- procedure
803 -- validate_objects
804 --
805 -- PURPOSE
809 -- 13-may-2003 sunkumar created
806 -- Created to validate the values while copying activity metrics
807 --
808 -- HISTORY
810 --======================================================================
811
812 procedure validate_objects(
813 p_api_version IN NUMBER,
814 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
815 p_validation_level IN NUMBER := Fnd_Api.G_Valid_Level_Full,
816 p_source_object_type IN VARCHAR2,
817 p_source_object_id IN NUMBER,
818 p_target_object_id IN NUMBER,
819 x_return_status OUT NOCOPY VARCHAR2,
820 x_msg_count OUT NOCOPY NUMBER,
821 x_msg_data OUT NOCOPY VARCHAR2
822 );
823
824
825 FUNCTION Lock_Object(
826 p_api_version IN NUMBER,
827 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
828 p_arc_act_metric_used_by IN VARCHAR2,
829 p_act_metric_used_by_id IN NUMBER,
830 x_return_status OUT NOCOPY VARCHAR2,
831 x_msg_count OUT NOCOPY NUMBER,
832 x_msg_data OUT NOCOPY VARCHAR2)
833 return varchar2;
834
835
836 --
837 -- PROCEDURE
838 -- delete_actmetrics_assoc
839 --
840 -- DESCRIPTION
841 -- Delete all activity metrics associated to the given object.
842 --
843 -- REQUIREMENT
844 -- bug 3410962: ALIST integration for deleting lists from target group
845 --
846 -- HISTORY
847 -- 30-Jan-2004 choang Created.
848 --
849 PROCEDURE delete_actmetrics_assoc (
850 p_api_version IN NUMBER,
851 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
852 p_commit IN VARCHAR2 := FND_API.G_FALSE,
853 p_object_type IN VARCHAR2,
857 x_msg_data OUT NOCOPY VARCHAR2
854 p_object_id IN NUMBER,
855 x_return_status OUT NOCOPY VARCHAR2,
856 x_msg_count OUT NOCOPY NUMBER,
858 );
859
860 --
861 -- FUNCTION
862 -- CAN_POST_TO_BUDGET
863 --
864 -- DESCRIPTION
865 -- Determine if the object has an approved budget and the correct status
866 -- for posting costs to budgets.
867 --
868 -- REQUIREMENT
869 -- BUG 4868582: Post to budget only with actual values entered.
870 --
871 -- RETURN
872 -- VARCHAR2 - TRUE, FALSE
873 -- HISTORY
874 -- 15-Dec-2005 dmvincen Created.
875 FUNCTION CAN_POST_TO_BUDGET(p_object_type IN VARCHAR2, p_object_id IN NUMBER)
876 RETURN VARCHAR2
877 ;
878
879 --
880 -- FUNCTION
881 -- IS_FROZEN
882 --
883 -- DESCRIPTION
884 -- Determine if the object is frozen by the status.
885 --
886 -- RETURN
887 -- VARCHAR2 - TRUE, FALSE
888 --
889 -- REQUIREMENT
890 -- BUG 4865673: Post to budget only with actual values entered.
891 --
892 -- HISTORY
893 -- 15-Dec-2005 dmvincen Created.
894 FUNCTION Check_Freeze_Status (
895 p_object_type IN VARCHAR2,
896 p_object_id IN NUMBER,
897 p_operation_mode IN VARCHAR2) -- 'C','U','D' for Create, Update, or Delete
898 RETURN VARCHAR2
899 ;
900
901 END Ams_Actmetric_Pvt;
[Home] [Help]