1 PACKAGE AHL_UC_Utilization_PUB AS
2 /* $Header: AHLPUCUS.pls 120.0 2005/05/26 00:16:08 appldev noship $ */
3 /*#
4 * This package provides the APIs for updating the Utilization on a Unit Configuration.
5 * @rep:scope public
6 * @rep:product AHL
7 * @rep:displayname Unit Configuration Utilization
8 * @rep:lifecycle active
9 * @rep:category BUSINESS_ENTITY AHL_UNIT_CONFIG
10 */
11
12
13
14 -----------------------------------------
15 -- Define Procedure for Utilization --
16 -----------------------------------------
17 /*#
18 * This API is used to update the Utilization based on the counter rules
19 * defined in the Master Configuration node. The update is done based on
20 * the details of an item/counter id/counter name,uom_code.
21 * Cascades the updates down to all children if the p_cascade_flag is set to 'Y'.
22 * @param p_api_version Api Version Number
23 * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
24 * @param p_commit to decide whether to commit the transaction or not, default value FND_API.G_FALSE
25 * @param p_validation_level validation level, default value FND_API.G_VALID_LEVEL_FULL
26 * @param p_Utilization_tbl Table of the type AHL_UC_Utilization_PVT.Utilization_Tbl_Type
27 * @param x_return_status return status
28 * @param x_msg_count return message count
29 * @param x_msg_data return message data
30 * @rep:scope public
31 * @rep:lifecycle active
32 * @rep:displayname Update Unit Utilization
33 */
34 PROCEDURE Update_Utilization(p_api_version IN NUMBER,
35 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
36 p_commit IN VARCHAR2 := FND_API.G_FALSE,
37 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
38 p_Utilization_tbl IN AHL_UC_Utilization_PVT.Utilization_Tbl_Type,
39 x_return_status OUT NOCOPY VARCHAR2,
40 x_msg_count OUT NOCOPY NUMBER,
41 x_msg_data OUT NOCOPY VARCHAR2 );
42
43
44 -- Start of Comments --
45 -- Procedure name : Update_Utilization
46 -- Type : Public
47 -- Function : Updates the utilization based on the counter rules defined in the master configuration
48 -- given the details of an item/counter id/counter name/uom_code.
49 -- Casacades the updates down to all the children if the p_cascade_flag is set to 'Y'.
50 -- Pre-reqs :
51 -- Parameters :
52 -- Standard IN Parameters :
53 -- p_api_version IN NUMBER Required
54 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
55 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
56 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
57 --
58 -- Standard OUT Parameters :
59 -- x_return_status OUT VARCHAR2 Required
60 -- x_msg_count OUT NUMBER Required
61 -- x_msg_data OUT VARCHAR2 Required
62 --
63 -- Update_Utilization Parameters:
64 --
65 -- p_Utilization_tbl IN Required.
66 -- For each record, at any given time only one of the following combinations is valid to identify the
67 -- item instance to be updated:
68 -- 1. Organization id and Inventory_item_id AND Serial Number.
69 -- This information will identify the part number and serial number of a configuration.
70 -- 2. Counter ID -- if this is passed a specific counter ONLY will be updated irrespective of the value
71 -- of p_cascade_flag.
72 -- 3. CSI_ITEM_INSTANCE_ID -- if this is passed, then this item instance and items down the hierarchy (depends on
73 -- the value p_cascade_flag) will be updated.
74 -- At any given time only one of the following combinations is valid to identify the type of item counters to be
75 -- updated:
76 -- 1. UOM_CODE
77 -- 2. COUNTER_NAME
78 --
79 -- Reading_Value IN Required.
80 -- This will be the value of the counter reading.
81 --
82 -- cascade_flag -- Can take values Y and N. Y indicates that the counter updates will cascade down the hierarchy
83 -- beginning at the item number passed. Ift its value is N then only the item counter will be updated.
84 --
85
86 -- End of Comments --
87
88 END AHL_UC_Utilization_PUB;
[Home] [Help]