1 PACKAGE AMS_METRIC_FORMULA_PVT AUTHID CURRENT_USER AS
2 /* $Header: amsvmtfs.pls 115.1 2003/10/01 21:07:46 dmvincen noship $ */
3 -- ===============================================================
4 -- Start of Comments
5 -- Package name
6 -- AMS_METRIC_FORMULA_PVT
7 -- Purpose
8 --
9 -- History
10 -- 09/11/2003 dmvincen Created.
11 --
12 -- NOTE
13 --
14 -- End of Comments
15 -- ===============================================================
16
17 -- Default number of records fetch per call
18 G_DEFAULT_NUM_REC_FETCH NUMBER := 30;
19 --===================================================================
20 -- Start of Comments
21 -- -------------------------------------------------------
22 -- Record name
23 -- met_formula_rec_type
24 -- -------------------------------------------------------
25 -- Parameters:
26 -- metric_formula_id
27 -- last_update_date
28 -- last_updated_by
29 -- creation_date
30 -- created_by
31 -- last_update_login
32 -- object_version_number
33 -- metric_id
34 -- source_type
35 -- source_id
36 -- source_sub_id
37 -- source_value
38 -- token
39 -- notation_type
40 -- use_sub_id_flag
41 -- sequence
42 --
43 --
44 -- Required
45 --
46 -- Defaults
47 --
48 -- Note: This is automatic generated record definition, it includes all columns
49 -- defined in the table, developer must manually add or delete some of the attributes.
50 --
51 -- End of Comments
52
53 --===================================================================
54 TYPE met_formula_rec_type IS RECORD
55 (
56 metric_formula_id NUMBER ,
57 last_update_date DATE ,
58 last_updated_by NUMBER ,
59 creation_date DATE ,
60 created_by NUMBER ,
61 last_update_login NUMBER ,
62 object_version_number NUMBER ,
63 metric_id NUMBER ,
64 source_type VARCHAR2(30) ,
65 source_id NUMBER ,
66 source_sub_id NUMBER ,
67 source_value NUMBER ,
68 token VARCHAR2(30) ,
69 notation_type VARCHAR2(30) ,
70 use_sub_id_flag VARCHAR2(1) ,
71 sequence NUMBER
72 );
73
74 g_miss_met_formula_rec met_formula_rec_type;
75 TYPE met_formula_tbl_type IS TABLE OF met_formula_rec_type INDEX BY BINARY_INTEGER;
76 g_miss_met_formula_tbl met_formula_tbl_type;
77
78 -- ==============================================================================
79 -- API Name
80 -- Create_Metric_Formula
81 -- Type
82 -- Private
83 -- Pre-Req
84 --
85 -- Parameters
86 --
87 -- IN
88 -- p_api_version_number IN NUMBER Required
89 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
90 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
91 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
92 -- p_met_formula_rec IN met_formula_rec_type Required
93 --
94 -- OUT
95 -- x_return_status OUT VARCHAR2
96 -- x_msg_count OUT NUMBER
97 -- x_msg_data OUT VARCHAR2
98 -- Version : Current version 1.0
99 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
100 -- and basic operation, developer must manually add parameters and business logic as necessary.
101 --
102 -- ==============================================================================
103
104 PROCEDURE Create_Metric_Formula(
105 p_api_version_number IN NUMBER,
106 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
107 p_commit IN VARCHAR2 := FND_API.G_FALSE,
108 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
109
110 x_return_status OUT nocopy VARCHAR2,
111 x_msg_count OUT nocopy NUMBER,
112 x_msg_data OUT nocopy VARCHAR2,
113
114 p_met_formula_rec IN met_formula_rec_type := g_miss_met_formula_rec,
115 x_metric_formula_id OUT nocopy NUMBER
116 );
117
118 -- ==============================================================================
119 -- API Name
120 -- Update_Metric_formula
121 -- Type
122 -- Private
123 -- Pre-Req
124 --
125 -- Parameters
126 --
127 -- IN
128 -- p_api_version_number IN NUMBER Required
129 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
130 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
131 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
132 -- p_met_formula_rec IN met_formula_rec_type Required
133 --
134 -- OUT
135 -- x_return_status OUT VARCHAR2
136 -- x_msg_count OUT NUMBER
137 -- x_msg_data OUT VARCHAR2
138 -- Version : Current version 1.0
139 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
140 -- and basic operation, developer must manually add parameters and business logic as necessary.
141 --
142 -- ==============================================================================
143 --
144
145 PROCEDURE Update_Metric_Formula(
146 p_api_version_number IN NUMBER,
147 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
148 p_commit IN VARCHAR2 := FND_API.G_FALSE,
149 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
150
151 x_return_status OUT nocopy VARCHAR2,
152 x_msg_count OUT nocopy NUMBER,
153 x_msg_data OUT nocopy VARCHAR2,
154
155 p_met_formula_rec IN met_formula_rec_type,
156 x_object_version_number OUT nocopy NUMBER
157 );
158
159 -- ==============================================================================
160 -- API Name
161 -- Delete_Metric_Formula
162 -- Type
163 -- Private
164 -- Pre-Req
165 --
166 -- Parameters
167 --
168 -- IN
169 -- p_api_version_number IN NUMBER Required
170 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
171 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
172 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
173 -- p_METRIC_FORMULA_ID IN NUMBER
174 -- p_object_version_number IN NUMBER Optional Default = NULL
175 --
176 -- OUT
177 -- x_return_status OUT VARCHAR2
178 -- x_msg_count OUT NUMBER
179 -- x_msg_data OUT VARCHAR2
180 -- Version : Current version 1.0
181 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
182 -- and basic operation, developer must manually add parameters and business logic as necessary.
183 --
184 -- ==============================================================================
185 --
186
187 PROCEDURE Delete_Metric_Formula(
188 p_api_version_number IN NUMBER,
189 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
190 p_commit IN VARCHAR2 := FND_API.G_FALSE,
191 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
192 x_return_status OUT nocopy VARCHAR2,
193 x_msg_count OUT nocopy NUMBER,
194 x_msg_data OUT nocopy VARCHAR2,
195 p_metric_formula_id IN NUMBER,
196 p_object_version_number IN NUMBER
197 );
198
199 -- ==============================================================================
200 -- API Name
201 -- Lock_Metric_Formula
202 -- Type
203 -- Private
204 -- Pre-Req
205 --
206 -- Parameters
207 --
208 -- IN
209 -- p_api_version_number IN NUMBER Required
210 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
211 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
212 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
213 -- p_met_formula_rec IN met_formula_rec_type Required
214 --
215 -- OUT
216 -- x_return_status OUT VARCHAR2
217 -- x_msg_count OUT NUMBER
218 -- x_msg_data OUT VARCHAR2
219 -- Version : Current version 1.0
220 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
221 -- and basic operation, developer must manually add parameters and business logic as necessary.
222 --
223 -- ==============================================================================
224
225 PROCEDURE Lock_Metric_Formula(
226 p_api_version_number IN NUMBER,
227 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
228
229 x_return_status OUT nocopy VARCHAR2,
230 x_msg_count OUT nocopy NUMBER,
231 x_msg_data OUT nocopy VARCHAR2,
232
233 p_metric_formula_id IN NUMBER,
234 p_object_version IN NUMBER
235 );
236
237
238 -- Start of Comments
239 --
240 -- validation procedures
241 --
242 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
243 -- For create: G_CREATE, for update: G_UPDATE
244 -- Note: 1. This is automated generated item level validation procedure.
245 -- The actual validation detail is needed to be added.
246 -- 2. We can also validate table instead of record. There will be an option for user to choose.
247 -- End of Comments
248
249 PROCEDURE Validate_Metric_Formula(
250 p_api_version_number IN NUMBER,
251 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
252 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
253 p_metric_formula_rec IN met_formula_rec_type,
254 p_validation_mode IN VARCHAR2,
255 x_return_status OUT NOCOPY VARCHAR2,
256 x_msg_count OUT NOCOPY NUMBER,
257 x_msg_data OUT NOCOPY VARCHAR2
258 );
259
260 --
261 -- validation procedures
262 --
263 -- p_validation_mode is a constant defined in null_UTILITY_PVT package
264 -- For create: G_CREATE, for update: G_UPDATE
265 -- Note: 1. This is automated generated item level validation procedure.
266 -- The actual validation detail is needed to be added.
267 -- 2. Validate the unique keys, lookups here
268
269 PROCEDURE Check_metric_formula_Items (
270 p_metric_formula_rec IN met_formula_rec_type,
271 p_validation_mode IN VARCHAR2,
272 x_return_status OUT NOCOPY VARCHAR2
273 );
274
275 --
276 -- Record level validation procedures
277 --
278 -- p_validation_mode is a constant defined in null_UTILITY_PVT package
279 -- For create: G_CREATE, for update: G_UPDATE
280 -- Note: 1. This is automated generated item level validation procedure.
281 -- The actual validation detail is needed to be added.
282 -- 2. Developer can manually added inter-field level validation.
283
284 PROCEDURE Validate_metric_formula_rec(
285 p_api_version_number IN NUMBER,
286 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
287 x_return_status OUT NOCOPY VARCHAR2,
288 x_msg_count OUT NOCOPY NUMBER,
289 x_msg_data OUT NOCOPY VARCHAR2,
290 p_metric_formula_rec IN met_formula_rec_type
291 );
292
293 -- Formula level validation.
294 --
295 -- Validates the formula entered for a specified metric.
296 -- The formula is written as text into ams_metrics_all_b.formula, and
297 -- is verified for correctness, and transformed into postfix notation for
298 -- refresh engine processing. This procedure is best called on the VO.create
299 -- method after all modifications have been completed.
300 --
301 PROCEDURE VALIDATE_FORMULA(
302 p_api_version_number IN NUMBER,
303 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
304 p_commit IN VARCHAR2 := FND_API.G_FALSE,
305 x_return_status OUT NOCOPY VARCHAR2,
306 x_msg_count OUT NOCOPY NUMBER,
307 x_msg_data OUT NOCOPY VARCHAR2,
308 p_metric_id IN NUMBER,
309 p_object_version_number IN NUMBER
310 );
311 END AMS_METRIC_FORMULA_PVT;