DBA Data[Home] [Help]

PACKAGE: APPS.AMS_SCORERESULT_PVT

Source


1 PACKAGE AMS_Scoreresult_PVT AS
2 /* $Header: amsvdrss.pls 120.0 2005/06/01 23:32:12 appldev noship $ */
3 -- ===============================================================
4 -- Start of Comments
5 -- Package name
6 --          AMS_Scoreresult_PVT
7 -- Purpose
8 --
9 -- History
10 -- 24-Jan-2001 choang   Created.
11 -- 26-Jan-2001 choang   Added summarize results.
12 -- 13-Apr-2001 choang   Added generate_list
13 -- 21-May-2001 choang   Added overloaded generate_list
14 -- 10-Jul-2001 choang   Replaced tree_node with decile.
15 -- 07-Jan-2002 choang   Removed security group id
16 -- 19-Mar-2003 choang   Bug 2856138 - Added return status for OSOException in JSP.
17 --
18 -- NOTE
19 --
20 -- End of Comments
21 -- ===============================================================
22 
23 -- Default number of records fetch per call
24 G_DEFAULT_NUM_REC_FETCH  NUMBER := 30;
25 --===================================================================
26 --    Start of Comments
27 --   -------------------------------------------------------
28 --    Record name
29 --             scoreresult_rec_type
30 --   -------------------------------------------------------
31 --   Parameters:
32 --       score_result_id
33 --       last_update_date
34 --       last_updated_by
35 --       creation_date
36 --       created_by
37 --       last_update_login
38 --       object_version_number
39 --       score_id
40 --       decile
41 --       num_records
42 --       score
43 --       confidence
44 --
45 --    Required
46 --
47 --    Defaults
48 --
49 --    Note: This is automatic generated record definition, it includes all columns
50 --          defined in the table, developer must manually add or delete some of the attributes.
51 --
52 --   End of Comments
53 
54 --===================================================================
55 TYPE scoreresult_rec_type IS RECORD
56 (
57        score_result_id        NUMBER := FND_API.G_MISS_NUM,
58        last_update_date       DATE := FND_API.G_MISS_DATE,
59        last_updated_by        NUMBER := FND_API.G_MISS_NUM,
60        creation_date          DATE := FND_API.G_MISS_DATE,
61        created_by             NUMBER := FND_API.G_MISS_NUM,
62        last_update_login      NUMBER := FND_API.G_MISS_NUM,
63        object_version_number  NUMBER := FND_API.G_MISS_NUM,
64        score_id               NUMBER := FND_API.G_MISS_NUM,
65        decile                 VARCHAR2(30) := FND_API.G_MISS_CHAR,
66        num_records            NUMBER := FND_API.G_MISS_NUM,
67        score                  VARCHAR2(30) := FND_API.G_MISS_CHAR,
68        confidence             NUMBER := FND_API.G_MISS_NUM
69 );
70 
71 g_miss_scoreresult_rec          scoreresult_rec_type;
72 TYPE  scoreresult_tbl_type      IS TABLE OF scoreresult_rec_type INDEX BY BINARY_INTEGER;
73 g_miss_scoreresult_tbl          scoreresult_tbl_type;
74 
75 --   ==============================================================================
76 --    Start of Comments
77 --   ==============================================================================
78 --   API Name
79 --           Create_Scoreresult
80 --   Type
81 --           Private
82 --   Pre-Req
83 --
84 --   Parameters
85 --
86 --   IN
87 --       p_api_version      IN   NUMBER     Required
88 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
89 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
90 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
91 --       p_scoreresult_rec            IN   scoreresult_rec_type  Required
92 --
93 --   OUT
94 --       x_return_status           OUT  VARCHAR2
95 --       x_msg_count               OUT  NUMBER
96 --       x_msg_data                OUT  VARCHAR2
97 --   Version : Current version 1.0
98 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
99 --         and basic operation, developer must manually add parameters and business logic as necessary.
100 --
101 --   End of Comments
102 --   ==============================================================================
103 --
104 
105 PROCEDURE Create_Scoreresult(
106     p_api_version       IN   NUMBER,
107     p_init_msg_list     IN   VARCHAR2 := FND_API.G_FALSE,
108     p_commit            IN   VARCHAR2 := FND_API.G_FALSE,
109     p_validation_level  IN   NUMBER := FND_API.G_VALID_LEVEL_FULL,
110 
111     x_return_status     OUT NOCOPY  VARCHAR2,
112     x_msg_count         OUT NOCOPY  NUMBER,
113     x_msg_data          OUT NOCOPY  VARCHAR2,
114 
115     p_scoreresult_rec   IN   scoreresult_rec_type := g_miss_scoreresult_rec,
116     x_score_result_id   OUT NOCOPY  NUMBER
117 );
118 
119 --   ==============================================================================
120 --    Start of Comments
121 --   ==============================================================================
122 --   API Name
123 --           Update_Scoreresult
124 --   Type
125 --           Private
126 --   Pre-Req
127 --
128 --   Parameters
129 --
130 --   IN
131 --       p_api_version      IN   NUMBER     Required
132 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
133 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
134 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
135 --       p_scoreresult_rec            IN   scoreresult_rec_type  Required
136 --
137 --   OUT
138 --       x_return_status           OUT  VARCHAR2
139 --       x_msg_count               OUT  NUMBER
140 --       x_msg_data                OUT  VARCHAR2
141 --   Version : Current version 1.0
142 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
143 --         and basic operation, developer must manually add parameters and business logic as necessary.
144 --
145 --   End of Comments
146 --   ==============================================================================
147 --
148 
149 PROCEDURE Update_Scoreresult(
150     p_api_version             IN   NUMBER,
151     p_init_msg_list           IN   VARCHAR2     := FND_API.G_FALSE,
152     p_commit                  IN   VARCHAR2     := FND_API.G_FALSE,
153     p_validation_level        IN  NUMBER       := FND_API.G_VALID_LEVEL_FULL,
154 
155     x_return_status           OUT NOCOPY  VARCHAR2,
156     x_msg_count               OUT NOCOPY  NUMBER,
157     x_msg_data                OUT NOCOPY  VARCHAR2,
158 
159     p_scoreresult_rec         IN    scoreresult_rec_type,
160     x_object_version_number   OUT NOCOPY  NUMBER
161 );
162 
163 --   ==============================================================================
164 --    Start of Comments
165 --   ==============================================================================
166 --   API Name
167 --           Delete_Scoreresult
168 --   Type
169 --           Private
170 --   Pre-Req
171 --
172 --   Parameters
173 --
174 --   IN
175 --       p_api_version      IN   NUMBER     Required
176 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
177 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
178 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
179 --       p_SCORE_RESULT_ID                IN   NUMBER
180 --       p_object_version_number   IN   NUMBER     Optional  Default = NULL
181 --
182 --   OUT
183 --       x_return_status           OUT  VARCHAR2
184 --       x_msg_count               OUT  NUMBER
185 --       x_msg_data                OUT  VARCHAR2
186 --   Version : Current version 1.0
187 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
188 --         and basic operation, developer must manually add parameters and business logic as necessary.
189 --
190 --   End of Comments
191 --   ==============================================================================
192 --
193 
194 PROCEDURE Delete_Scoreresult(
195     p_api_version             IN   NUMBER,
196     p_init_msg_list           IN   VARCHAR2     := FND_API.G_FALSE,
197     p_commit                  IN   VARCHAR2     := FND_API.G_FALSE,
198     p_validation_level        IN   NUMBER       := FND_API.G_VALID_LEVEL_FULL,
199     x_return_status           OUT NOCOPY  VARCHAR2,
200     x_msg_count               OUT NOCOPY  NUMBER,
201     x_msg_data                OUT NOCOPY  VARCHAR2,
202     p_score_result_id         IN  NUMBER,
203     p_object_version_number   IN   NUMBER
204 );
205 
206 --   ==============================================================================
207 --    Start of Comments
208 --   ==============================================================================
209 --   API Name
210 --           Lock_Scoreresult
211 --   Type
212 --           Private
213 --   Pre-Req
214 --
215 --   Parameters
216 --
217 --   IN
218 --       p_api_version      IN   NUMBER     Required
219 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
220 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
221 --       p_validation_level        IN   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
222 --       p_scoreresult_rec            IN   scoreresult_rec_type  Required
223 --
224 --   OUT
225 --       x_return_status           OUT  VARCHAR2
226 --       x_msg_count               OUT  NUMBER
227 --       x_msg_data                OUT  VARCHAR2
228 --   Version : Current version 1.0
229 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
230 --         and basic operation, developer must manually add parameters and business logic as necessary.
231 --
232 --   End of Comments
233 --   ==============================================================================
234 --
235 
236 PROCEDURE Lock_Scoreresult(
237     p_api_version       IN   NUMBER,
238     p_init_msg_list     IN   VARCHAR2     := FND_API.G_FALSE,
239 
240     x_return_status     OUT NOCOPY  VARCHAR2,
241     x_msg_count         OUT NOCOPY  NUMBER,
242     x_msg_data          OUT NOCOPY  VARCHAR2,
243 
244     p_score_result_id   IN  NUMBER,
245     p_object_version    IN  NUMBER
246 );
247 
248 
249 -- Start of Comments
250 --
251 --  validation procedures
252 --
253 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
254 --                  For create: G_CREATE, for update: G_UPDATE
255 -- Note: 1. This is automated generated item level validation procedure.
256 --          The actual validation detail is needed to be added.
257 --       2. We can also validate table instead of record. There will be an option for user to choose.
258 -- End of Comments
259 
260 PROCEDURE Validate_scoreresult(
261     p_api_version       IN   NUMBER,
262     p_init_msg_list     IN   VARCHAR2     := FND_API.G_FALSE,
263     p_validation_level  IN   NUMBER := FND_API.G_VALID_LEVEL_FULL,
264     p_validation_mode   IN   VARCHAR2,
265     p_scoreresult_rec   IN   scoreresult_rec_type,
266     x_return_status     OUT NOCOPY  VARCHAR2,
267     x_msg_count         OUT NOCOPY  NUMBER,
268     x_msg_data          OUT NOCOPY  VARCHAR2
269 );
270 
271 -- Start of Comments
272 --
273 --  validation procedures
274 --
275 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
276 --                  For create: G_CREATE, for update: G_UPDATE
277 -- Note: 1. This is automated generated item level validation procedure.
278 --          The actual validation detail is needed to be added.
279 --       2. Validate the unique keys, lookups here
280 -- End of Comments
281 
282 PROCEDURE Check_scoreresult_Items (
283     P_scoreresult_rec   IN    scoreresult_rec_type,
284     p_validation_mode   IN    VARCHAR2,
285     x_return_status     OUT NOCOPY   VARCHAR2
286 );
287 
288 -- Start of Comments
289 --
290 -- Record level validation procedures
291 --
292 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
293 --                  For create: G_CREATE, for update: G_UPDATE
294 -- Note: 1. This is automated generated item level validation procedure.
295 --          The actual validation detail is needed to be added.
296 --       2. Developer can manually added inter-field level validation.
297 -- End of Comments
298 
299 PROCEDURE Validate_scoreresult_rec(
300     p_api_version       IN   NUMBER,
301     p_init_msg_list     IN   VARCHAR2     := FND_API.G_FALSE,
302     x_return_status     OUT NOCOPY  VARCHAR2,
303     x_msg_count         OUT NOCOPY  NUMBER,
304     x_msg_data          OUT NOCOPY  VARCHAR2,
305     p_scoreresult_rec   IN    scoreresult_rec_type
306 );
307 
308 
309 --   ==============================================================================
310 --    Start of Comments
311 --   ==============================================================================
312 --   API Name
313 --           Summarize_Results
314 --   Type
315 --           Private
316 --   Pre-Req
317 --
318 --   Parameters
319 --
320 --   IN
321 --       p_api_version     NUMBER     Required
322 --       p_init_msg_list   VARCHAR2   Optional  Default = FND_API_G_FALSE
323 --       p_commit          VARCHAR2   Optional  Default = FND_API.G_FALSE
324 --       p_validation_level   NUMBER     Optional  Default = FND_API.G_VALID_LEVEL_FULL
325 --       p_score_id        NUMBER
326 --
327 --   OUT
328 --       x_return_status   VARCHAR2
329 --       x_msg_count       NUMBER
330 --       x_msg_data        VARCHAR2
331 --   Version : Current version 1.0
332 --
333 --   End of Comments
334 --   ==============================================================================
335 PROCEDURE summarize_results (
336     p_api_version       IN   NUMBER,
337     p_init_msg_list     IN   VARCHAR2 := FND_API.G_FALSE,
338     p_commit            IN   VARCHAR2 := FND_API.G_FALSE,
339     x_return_status     OUT NOCOPY  VARCHAR2,
340     x_msg_count         OUT NOCOPY  NUMBER,
341     x_msg_data          OUT NOCOPY  VARCHAR2,
342     p_score_id          IN   NUMBER
343 );
344 
345 
346 --
347 -- Purpose
348 --    Generate a list based on the selected nodes from scoring run
349 --    results.
350 --
351 -- Parameters
352 --    p_score_id - scoring run identifier.
353 --    p_model_type - model type used for scoring.
354 --    p_tree_node_str - string concatenated from list of deciles chosen by
355 --       the user in the screen.
356 --    p_list_name - name of list to be generated.
357 --    p_owner_user_id - owner of the list.
358 --    x_list_header_id - new list header identifier.
359 --
360 PROCEDURE generate_list (
361    p_score_id        IN NUMBER,
362    p_model_type      IN VARCHAR2,
363    p_tree_node_str   IN VARCHAR2,
364    p_list_name       IN VARCHAR2 ,
365    p_owner_user_id   IN NUMBER,
366    x_return_status   OUT NOCOPY VARCHAR2,
367    x_msg_count       OUT NOCOPY NUMBER,
368    x_msg_data        OUT NOCOPY VARCHAR2,
369    x_list_header_id  OUT NOCOPY VARCHAR2
370 );
371 
372 
373 --
374 -- Purpose
375 --    Generate a list based on the selected nodes from scoring run
376 --    results.
377 --
378 -- Parameters
379 --    p_score_id - scoring run identifier.
380 --    p_tree_node_str - string concatenated from list of deciles chosen by
381 --       the user in the screen.
382 --    p_list_name - name of list to be generated.
383 --    x_list_header_id - new list header identifier.
384 --
385 PROCEDURE generate_list (
386    p_score_id        IN NUMBER,
387    p_tree_node_str   IN VARCHAR2,
388    p_list_name       IN VARCHAR2 ,
389    x_return_status   OUT NOCOPY VARCHAR2,
390    x_msg_count       OUT NOCOPY NUMBER,
391    x_msg_data        OUT NOCOPY VARCHAR2,
392    x_list_header_id  OUT NOCOPY VARCHAR2
393 );
394 
395 --
396 -- Purpose
397 --    Insert the optimal tareting percentile results for a given score id.
398 --
399 -- Parameters
400 --    p_score_id - scoring run identifier.
401 --
402 PROCEDURE insert_percentile_results (
403     p_score_id          IN   NUMBER
404 );
405 
406 END AMS_Scoreresult_PVT;