1 PACKAGE AMS_METRIC_PVT AUTHID CURRENT_USER AS
2 /* $Header: amsvmtcs.pls 120.1 2005/08/24 23:08:59 dmvincen noship $ */
3
4 --
5 -- Start of comments.
6 --
7 -- NAME
8 -- ams_metrics_pvt
9 --
10 -- PURPOSE
11 -- This package is a private package used for defining constants, records,
12 -- types and procedures for metrics API.
13 --
14 -- Procedures:
15 -- Create_Metric
16 -- Update_Metric
17 -- Lock_Metric
18 -- Delete_Metric
19 -- Validate_Metric
20 --
21 -- NOTES
22 --
23 --
24 -- HISTORY
25 -- 05/26/1999 choang Created.
26 -- 06/07/1999 choang Moved validate rec types from global package to module specs.
27 -- 06/14/1999 choang Updated with changed columns and character case standards.
28 -- 07/05/1999 choang Added vertical rollup engine.
29 -- 07/19/1999 choang Added specifications for GetMetricVal, GetMetCatVal and SetCommittedVal.
30 -- 09/01/1999 choang Made the following specs public: Validate_Metric_Items, IsSeeded,
31 -- Validate_Metric_Child per request of ptendulk.
32 -- 10/11/1999 ptendulk Modified According to new Standards, Also seperated Refresh Engine from
33 -- table Handlers
34 -- 01/18/2000 bgeorge Reviewed code, made UOM non-required, removed function ISSEEDED
35 -- from the specs
36 -- 17-Apr-2000 tdonohoe@us Added columns to metric_rec_type to support 11.5.2 release.
37 -- 04-MAY-2000 khung Remove number fixed width in metric_rec_type, where causing problem when
38 -- using Rosetta.
39 -- 27-Dec-2001 dmvincen complete_metric_rec need not be exposed.
40 -- 02-Dec-2002 dmvincen Added NOCOPY.
41 -- 29-Aug-2003 dmvincen Adding display type field.
42 -- 29-Aug-2003 dmvincen Formula metric support.
43 -- Begin section added by choang - 05/26/1999
44 --
45 -- Start AMS_METRICS_ALL_VL
46 --
47 TYPE metric_rec_type
48 IS RECORD (
49 metric_id NUMBER
50 ,last_update_date DATE
51 ,last_updated_by NUMBER
52 ,creation_date DATE
53 ,created_by NUMBER
54 ,last_update_login NUMBER
55 ,object_version_number NUMBER
56 ,application_id NUMBER
57 ,arc_metric_used_for_object VARCHAR2(30)
58 ,metric_calculation_type VARCHAR2(30)
59 ,metric_category NUMBER
60 ,accrual_type VARCHAR2(30)
61 ,value_type VARCHAR2(30)
62 ,sensitive_data_flag VARCHAR2(1)
63 ,enabled_flag VARCHAR2(1)
64 ,metric_sub_category NUMBER
65 ,function_name VARCHAR2(4000)
66 ,metric_parent_id NUMBER
67 ,summary_metric_id NUMBER
68 ,compute_using_function VARCHAR2(4000)
69 ,default_uom_code VARCHAR2(3)
70 ,uom_type VARCHAR2(10)
71 ,formula VARCHAR2(4000)
72 ,metrics_name VARCHAR2(120)
73 ,description VARCHAR2(4000)
74 ,formula_display VARCHAR2(4000)
75 ,hierarchy_id NUMBER
76 ,set_function_name VARCHAR2(4000)
77 ,display_type VARCHAR2(30)
78 ,target_type VARCHAR2(30)
79 ,denorm_code VARCHAR2(30));
80 --
81 -- End AMS_METRICS_ALL_VL
82 --
83 --
84 -- End of section added by choang.
85 --
86 --
87 -- End of comments.
88 --
89
90 -- Start of comments
91 -- API Name Create_Metric
92 -- Type Private
93 -- Pre-reqs None.
94 -- Function Creates a metric in AMS_METRICS_ALL_B given the
95 -- record for the metrics.
96 -- Parameters
97 -- IN p_api_version IN NUMBER Required
98 -- p_init_msg_list IN VARCHAR2 Optional
99 -- Default := FND_API.G_FALSE
100 -- p_commit IN VARCHAR2 Optional
101 -- Default := FND_API.G_FALSE
102 -- p_validation_level IN NUMBER Optional
103 -- Default := FND_API.G_VALID_LEVEL_FULL
104 -- p_metric_rec IN metric_rec_type Required
105 -- OUT x_return_status OUT VARCHAR2
106 -- x_msg_count OUT NUMBER
107 -- x_msg_data OUT VARCHAR2
108 -- x_metrics_id OUT VARCHAR2
109 -- Version Current version: 1.0
110 -- Previous version: 1.0
111 -- Initial version: 1.0
112 -- End of comments
113
114 PROCEDURE Create_Metric (
115 p_api_version IN NUMBER,
116 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
117 p_commit IN VARCHAR2 := FND_API.G_FALSE,
118 p_validation_level IN NUMBER := FND_API.G_Valid_Level_Full,
119
120 x_return_status OUT NOCOPY VARCHAR2,
121 x_msg_count OUT NOCOPY NUMBER,
122 x_msg_data OUT NOCOPY VARCHAR2,
123
124 p_metric_rec IN metric_rec_type,
125 x_metric_id OUT NOCOPY NUMBER
126 );
127
128 -- Start of comments
129 -- API Name Update_Metric
130 -- Type Private
131 -- Pre-reqs None.
132 -- Function Updates a metric in AMS_METRICS_ALL_B given the
133 -- record for the metrics.
134 -- Parameters
135 -- IN p_api_version IN NUMBER Required
136 -- p_init_msg_list IN VARCHAR2 Optional
137 -- Default := FND_API.G_FALSE
138 -- p_commit IN VARCHAR2 Optional
139 -- Default := FND_API.G_FALSE
140 -- p_validation_level IN NUMBER Optional
141 -- Default := FND_API.G_VALID_LEVEL_FULL
142 -- p_metric_rec IN metric_rec_type Required
143 -- OUT x_return_status OUT VARCHAR2
144 -- x_msg_count OUT NUMBER
145 -- x_msg_data OUT VARCHAR2
146 -- Version Current version: 1.0
147 -- Previous version: 1.0
148 -- Initial version: 1.0
149 -- End of comments
150
151 PROCEDURE Update_Metric (
152 p_api_version IN NUMBER,
153 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
154 p_commit IN VARCHAR2 := FND_API.G_FALSE,
155 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
156
157 x_return_status OUT NOCOPY VARCHAR2,
158 x_msg_count OUT NOCOPY NUMBER,
159 x_msg_data OUT NOCOPY VARCHAR2,
160
161 p_metric_rec IN metric_rec_type
162 );
163
164 -- Start of comments
165 -- API Name Delete_Metric
166 -- Type Private
167 -- Pre-reqs None.
168 -- Function Deletes a metric in AMS_METRICS_ALL_B given the
169 -- key identifier for the metric.
170 -- Parameters
171 -- IN p_api_version IN NUMBER Required
172 -- p_init_msg_list IN VARCHAR2 Optional
173 -- Default := FND_API.G_FALSE
174 -- p_commit IN VARCHAR2 Optional
175 -- Default := FND_API.G_FALSE
176 -- p_metric_id IN NUMBER Required
177 -- p_object_version_number IN number
178 -- OUT x_return_status OUT VARCHAR2
179 -- x_msg_count OUT NUMBER
180 -- x_msg_data OUT VARCHAR2
181 -- Version Current version: 1.0
182 -- Previous version: 1.0
183 -- Initial version: 1.0
184 -- End of comments
185
186 PROCEDURE Delete_Metric (
187 p_api_version IN NUMBER,
188 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
189 p_commit IN VARCHAR2 := FND_API.G_FALSE,
190
191 x_return_status OUT NOCOPY VARCHAR2,
192 x_msg_count OUT NOCOPY NUMBER,
193 x_msg_data OUT NOCOPY VARCHAR2,
194
195 p_metric_id IN NUMBER,
196 p_object_version_number IN NUMBER
197 );
198
199 -- Start of comments
200 -- API Name Lock_Metric
201 -- Type Private
202 -- Pre-reqs None.
203 -- Function Perform a row lock of the metrics identified in the
204 -- given row.
205 -- Parameters
206 -- IN p_api_version IN NUMBER Required
207 -- p_init_msg_list IN VARCHAR2 Optional
208 -- Default := FND_API.G_FALSE
209 -- p_commit IN VARCHAR2 Optional
210 -- Default := FND_API.G_FALSE
211 -- p_metric_id IN NUMBER Required
212 -- p_object_version_number IN NUMBER
213 -- OUT x_return_status OUT VARCHAR2
214 -- x_msg_count OUT NUMBER
215 -- x_msg_data OUT VARCHAR2
216 -- Version Current version: 1.0
217 -- Previous version: 1.0
218 -- Initial version: 1.0
219 -- End of comments
220
221 PROCEDURE Lock_Metric (
222 p_api_version IN NUMBER,
223 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
224
225 x_return_status OUT NOCOPY VARCHAR2,
226 x_msg_count OUT NOCOPY NUMBER,
227 x_msg_data OUT NOCOPY VARCHAR2,
228
229 p_metric_id IN NUMBER,
230 p_object_version_number IN NUMBER
231 );
232
233 -- Start of comments
234 -- API Name Validate_Metric
235 -- Type Private
236 -- Pre-reqs None.
237 -- Function Validate Metric
238 -- Parameters
239 -- IN p_api_version IN NUMBER Required
240 -- p_init_msg_list IN VARCHAR2 Optional
241 -- Default := FND_API.G_FALSE
242 -- p_commit IN VARCHAR2 Optional
243 -- Default := FND_API.G_FALSE
244 -- p_validation_level IN NUMBER Optional
245 -- Default := FND_API.G_VALID_LEVEL_FULL
246 -- p_metric_rec IN metric_rec_type Required
247 -- OUT x_return_status OUT VARCHAR2
248 -- x_msg_count OUT NUMBER
249 -- x_msg_data OUT VARCHAR2
250 -- Version Current version: 1.0
251 -- Previous version: 1.0
252 -- Initial version: 1.0
253 -- End of comments
254
255 PROCEDURE Validate_Metric (
256 p_api_version IN NUMBER,
257 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
258 p_validation_level IN NUMBER := FND_API.G_Valid_Level_Full,
259
260 x_return_status OUT NOCOPY VARCHAR2,
261 x_msg_count OUT NOCOPY NUMBER,
262 x_msg_data OUT NOCOPY VARCHAR2,
263
264 p_metric_rec IN metric_rec_type
265 );
266
267
268 -- Start of comments
269 -- API Name Validate_Metric_Items
270 -- Type Private
271 -- Pre-reqs None.
272 -- Function Validate Metric Items
273 -- Parameters
274 -- IN p_metric_rec IN metric_rec_type Required
275 -- p_validate_mode IN VARCHAR2
276 -- OUT x_return_status OUT VARCHAR2
277 -- Version Current version: 1.0
278 -- Previous version: 1.0
279 -- Initial version: 1.0
280 -- End of comments
281
282 PROCEDURE Validate_Metric_items(
283 p_metric_rec IN metric_rec_type,
284 p_validation_mode IN VARCHAR2 := JTF_PLSQL_API.g_create,
285 x_return_status OUT NOCOPY VARCHAR2
286 ) ;
287
288 -- Start of comments
289 -- API Name Validate_Metric_Record
290 -- Type Private
291 -- Pre-reqs None.
292 -- Function Validate Metric Records
293 -- Parameters
294 -- IN p_metric_rec IN metric_rec_type Required
295 -- p_complete_rec IN metric_rec_type Required
296 -- OUT x_return_status OUT VARCHAR2
297 -- Version Current version: 1.0
298 -- Previous version: 1.0
299 -- Initial version: 1.0
300 -- End of comments
301
302 PROCEDURE Validate_Metric_Record(
303 p_metric_rec IN metric_rec_type,
304 p_complete_rec IN metric_rec_type,
305 x_return_status OUT NOCOPY VARCHAR2
306 ) ;
307
308
309 -- Start of comments
310 -- API Name Validate_Metric_Child
311 -- Type Private
312 -- Pre-reqs None.
313 -- Function Perform child entity validation for metrics
314 -- Parameters
315 -- IN p_metrics_id IN NUMBER Required
316 -- OUT x_return_status OUT VARCHAR2
317 -- Version Current version: 1.0
318 -- Previous version: 1.0
319 -- Initial version: 1.0
323 x_return_status OUT NOCOPY VARCHAR2
320 -- End of comments
321 PROCEDURE Validate_Metric_Child (
322 p_metric_id IN NUMBER,
324 );
325
326 -- Start of comments
327 -- API Name Complete_Metric_Rec
328 -- Type Private
329 -- Pre-reqs None.
330 -- Function This Process returns the details for the metric ID if
331 -- Not passed.
332 -- Parameters
333 -- IN p_metric_rec IN metric_rec_type Required
334 -- OUT x_complete_rec OUT metric_rec_type
335 -- Version Current version: 1.0
336 -- Previous version: 1.0
337 -- Initial version: 1.0
338 -- End of comments
339 -- PROCEDURE Complete_Metric_Rec(
340 -- p_metric_rec IN metric_rec_type,
341 -- x_complete_rec OUT metric_rec_type
342 -- );
343
344 END Ams_Metric_Pvt;
[Home] [Help]