DBA Data[Home] [Help]

PACKAGE: APPS.AMS_DMMODEL_PUB

Source


1 PACKAGE AMS_DMModel_PUB AUTHID CURRENT_USER AS
2 /* $Header: amspdmms.pls 115.8 2002/12/17 04:12:58 choang noship $ */
3 -- ===============================================================
4 -- Start of Comments
5 -- Package name
6 --          AMS_DMModel_PUB
7 -- Purpose
8 --
9 -- History
10 -- 02-Feb-2001 choang   Added new columns.
11 -- 16-Feb-2001 choang   Replaced top_down_flag with row_selection_type.
12 -- 20-Feb-2001 choang   Changed row_selection_type to varchar2(30).
13 -- 26-Feb-2001 choang   Added custom_setup_id, country_id, and best_subtree.
14 --
15 -- NOTE
16 --
17 -- End of Comments
18 -- ===============================================================
19 
20 -- Default number of records fetch per call
21 G_DEFAULT_NUM_REC_FETCH  NUMBER := 30;
22 --===================================================================
23 --    Start of Comments
24 --   -------------------------------------------------------
25 --    Record name
26 --             model_rec_type
27 --   -------------------------------------------------------
28 --   Parameters:
29 --    ROW_ID
30 --    MODEL_ID
31 --    LAST_UPDATE_DATE
32 --    LAST_UPDATED_BY
33 --    CREATION_DATE
34 --    CREATED_BY
35 --    LAST_UPDATE_LOGIN
36 --    OBJECT_VERSION_NUMBER
37 --    MODEL_TYPE
38 --    USER_STATUS_ID
39 --    STATUS_CODE
40 --    STATUS_DATE
41 --    LAST_BUILD_DATE
42 --    OWNER_USER_ID
43 --    SCHEDULED_DATE
44 --    SCHEDULED_TIMEZONE_ID
45 --    EXPIRATION_DATE
46 --    custom_setup_id
47 --    country_id
48 --    best_subtree
49 --    RESULTS_FLAG
50 --    LOGS_FLAG
51 --    TARGET_FIELD
52 --    TARGET_TYPE
53 --    TARGET_POSITIVE_VALUE
54 --    MIN_RECORDS
55 --    MAX_RECORDS
56 --    row_selection_type
57 --    EVERY_NTH_ROW
58 --    PCT_RANDOM
59 --    PERFORMANCE
60 --    TARGET_GROUP_TYPE
61 --    DARWIN_MODEL_REF
62 --    ATTRIBUTE_CATEGORY
63 --    ATTRIBUTE1
64 --    ATTRIBUTE2
65 --    ATTRIBUTE3
66 --    ATTRIBUTE4
67 --    ATTRIBUTE5
68 --    ATTRIBUTE6
69 --    ATTRIBUTE7
70 --    ATTRIBUTE8
71 --    ATTRIBUTE9
72 --    ATTRIBUTE10
73 --    ATTRIBUTE11
74 --    ATTRIBUTE12
75 --    ATTRIBUTE13
76 --    ATTRIBUTE14
77 --    ATTRIBUTE15
78 --    MODEL_NAME
79 --    DESCRIPTION
80 --
81 --    Required
82 --
83 --    Defaults
84 --
85 --    Note: This is automatic generated record definition, it includes all columns
86 --          defined in the table, developer must manually add or delete some of the attributes.
87 --
88 --   End of Comments
89 
90 --===================================================================
91 TYPE model_rec_type IS RECORD
92 (
93    ROW_ID                  ROWID := FND_API.G_MISS_CHAR,
94    MODEL_ID                NUMBER := FND_API.G_MISS_NUM,
95    LAST_UPDATE_DATE        DATE := FND_API.G_MISS_DATE,
96    LAST_UPDATED_BY         NUMBER := FND_API.G_MISS_NUM,
97    CREATION_DATE           DATE := FND_API.G_MISS_DATE,
98    CREATED_BY              NUMBER := FND_API.G_MISS_NUM,
99    LAST_UPDATE_LOGIN       NUMBER := FND_API.G_MISS_NUM,
100    OBJECT_VERSION_NUMBER   NUMBER := FND_API.G_MISS_NUM,
101    org_id                  NUMBER := FND_API.G_MISS_NUM,
102    MODEL_TYPE              VARCHAR2(30) := FND_API.G_MISS_CHAR,
103    USER_STATUS_ID          NUMBER := FND_API.G_MISS_NUM,
104    STATUS_CODE             VARCHAR2(30) := FND_API.G_MISS_CHAR,
105    STATUS_DATE             DATE := FND_API.G_MISS_DATE,
106    LAST_BUILD_DATE         DATE := FND_API.G_MISS_DATE,
107    OWNER_USER_ID           NUMBER := FND_API.G_MISS_NUM,
108    SCHEDULED_DATE          DATE := FND_API.G_MISS_DATE,
109    SCHEDULED_TIMEZONE_ID   NUMBER := FND_API.G_MISS_NUM,
110    EXPIRATION_DATE         DATE := FND_API.G_MISS_DATE,
111    custom_setup_id         NUMBER := FND_API.G_MISS_NUM,
112    country_id              NUMBER := FND_API.G_MISS_NUM,
113    best_subtree            NUMBER := FND_API.G_MISS_NUM,
114    RESULTS_FLAG            VARCHAR2(1) := FND_API.G_MISS_CHAR,
115    LOGS_FLAG               VARCHAR2(1) := FND_API.G_MISS_CHAR,
116    TARGET_FIELD            VARCHAR2(30) := FND_API.G_MISS_CHAR,
117    TARGET_TYPE             VARCHAR2(30) := FND_API.G_MISS_CHAR,
118    TARGET_POSITIVE_VALUE   VARCHAR2(30) := FND_API.G_MISS_CHAR,
119    MIN_RECORDS             NUMBER := FND_API.G_MISS_NUM,
120    MAX_RECORDS             NUMBER := FND_API.G_MISS_NUM,
121    row_selection_type      VARCHAR2(30) := FND_API.G_MISS_CHAR,
122    EVERY_NTH_ROW           NUMBER := FND_API.G_MISS_NUM,
123    PCT_RANDOM              NUMBER := FND_API.G_MISS_NUM,
124    PERFORMANCE             NUMBER := FND_API.G_MISS_NUM,
125    TARGET_GROUP_TYPE       VARCHAR2(30) := FND_API.G_MISS_CHAR,
126    DARWIN_MODEL_REF        VARCHAR2(4000) := FND_API.G_MISS_CHAR,
127    ATTRIBUTE_CATEGORY      VARCHAR2(30) := FND_API.G_MISS_CHAR,
128    ATTRIBUTE1              VARCHAR2(150) := FND_API.G_MISS_CHAR,
129    ATTRIBUTE2              VARCHAR2(150) := FND_API.G_MISS_CHAR,
130    ATTRIBUTE3              VARCHAR2(150) := FND_API.G_MISS_CHAR,
131    ATTRIBUTE4              VARCHAR2(150) := FND_API.G_MISS_CHAR,
132    ATTRIBUTE5              VARCHAR2(150) := FND_API.G_MISS_CHAR,
133    ATTRIBUTE6              VARCHAR2(150) := FND_API.G_MISS_CHAR,
134    ATTRIBUTE7              VARCHAR2(150) := FND_API.G_MISS_CHAR,
135    ATTRIBUTE8              VARCHAR2(150) := FND_API.G_MISS_CHAR,
136    ATTRIBUTE9              VARCHAR2(150) := FND_API.G_MISS_CHAR,
137    ATTRIBUTE10             VARCHAR2(150) := FND_API.G_MISS_CHAR,
138    ATTRIBUTE11             VARCHAR2(150) := FND_API.G_MISS_CHAR,
139    ATTRIBUTE12             VARCHAR2(150) := FND_API.G_MISS_CHAR,
140    ATTRIBUTE13             VARCHAR2(150) := FND_API.G_MISS_CHAR,
141    ATTRIBUTE14             VARCHAR2(150) := FND_API.G_MISS_CHAR,
142    ATTRIBUTE15             VARCHAR2(150) := FND_API.G_MISS_CHAR,
143    MODEL_NAME              VARCHAR2(120) := FND_API.G_MISS_CHAR,
144    DESCRIPTION             VARCHAR2(4000) := FND_API.G_MISS_CHAR
145 );
146 
147 g_miss_model_rec          model_rec_type;
148 TYPE  model_tbl_type      IS TABLE OF model_rec_type INDEX BY BINARY_INTEGER;
149 g_miss_model_tbl          model_tbl_type;
150 
151 TYPE model_sort_rec_type IS RECORD
152 (
153       -- Please define your own sort by record here.
154       model_id   NUMBER := NULL
155 );
156 
157 --   ==============================================================================
158 --    Start of Comments
159 --   ==============================================================================
160 --   API Name
161 --           Create_Model
162 --   Type
163 --           Public
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_model_rec            IN   model_rec_type  Required
173 --
174 --   OUT
175 --       x_return_status           OUT  VARCHAR2
176 --       x_msg_count               OUT  NUMBER
177 --       x_msg_data                OUT  VARCHAR2
178 --   Version : Current version 1.0
179 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
180 --         and basic operation, developer must manually add parameters and business logic as necessary.
181 --
182 --   End of Comments
183 --   ==============================================================================
184 --
185 
186 PROCEDURE Create_Model(
187     p_api_version_number   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_model_rec            IN   model_rec_type  := g_miss_model_rec,
196     x_model_id             OUT NOCOPY  NUMBER
197 );
198 
199 --   ==============================================================================
200 --    Start of Comments
201 --   ==============================================================================
202 --   API Name
203 --           Update_Model
204 --   Type
205 --           Public
206 --   Pre-Req
207 --
208 --   Parameters
209 --
210 --   IN
211 --       p_api_version_number      IN   NUMBER     Required
212 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
213 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
214 --       p_model_rec            IN   model_rec_type  Required
215 --
216 --   OUT
217 --       x_return_status           OUT  VARCHAR2
218 --       x_msg_count               OUT  NUMBER
219 --       x_msg_data                OUT  VARCHAR2
220 --   Version : Current version 1.0
221 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
222 --         and basic operation, developer must manually add parameters and business logic as necessary.
223 --
224 --   End of Comments
225 --   ==============================================================================
226 --
227 
228 PROCEDURE Update_Model(
229     p_api_version_number         IN   NUMBER,
230     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
231     p_commit                     IN   VARCHAR2     := FND_API.G_FALSE,
232 
233     x_return_status              OUT NOCOPY  VARCHAR2,
234     x_msg_count                  OUT NOCOPY  NUMBER,
235     x_msg_data                   OUT NOCOPY  VARCHAR2,
236 
237     p_model_rec               IN    model_rec_type,
238     x_object_version_number      OUT NOCOPY  NUMBER
239 );
240 
241 --   ==============================================================================
242 --    Start of Comments
243 --   ==============================================================================
244 --   API Name
245 --           Delete_Model
246 --   Type
247 --           Public
248 --   Pre-Req
249 --
250 --   Parameters
251 --
252 --   IN
253 --       p_api_version_number      IN   NUMBER     Required
254 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
255 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
256 --       p_MODEL_ID                IN   NUMBER
257 --       p_object_version_number   IN   NUMBER     Optional  Default = NULL
258 --
259 --   OUT
260 --       x_return_status           OUT  VARCHAR2
261 --       x_msg_count               OUT  NUMBER
262 --       x_msg_data                OUT  VARCHAR2
263 --   Version : Current version 1.0
264 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
265 --         and basic operation, developer must manually add parameters and business logic as necessary.
266 --
267 --   End of Comments
268 --   ==============================================================================
269 --
270 
271 PROCEDURE Delete_Model(
272     p_api_version_number         IN   NUMBER,
273     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
274     p_commit                     IN   VARCHAR2     := FND_API.G_FALSE,
275     x_return_status              OUT NOCOPY  VARCHAR2,
276     x_msg_count                  OUT NOCOPY  NUMBER,
277     x_msg_data                   OUT NOCOPY  VARCHAR2,
278     p_model_id                   IN  NUMBER,
279     p_object_version_number      IN   NUMBER
280 );
281 
282 --   ==============================================================================
283 --    Start of Comments
284 --   ==============================================================================
285 --   API Name
286 --           Lock_Model
287 --   Type
288 --           Public
289 --   Pre-Req
290 --
291 --   Parameters
292 --
293 --   IN
294 --       p_api_version_number      IN   NUMBER     Required
295 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
296 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
297 --       p_model_rec            IN   model_rec_type  Required
298 --
299 --   OUT
300 --       x_return_status           OUT  VARCHAR2
301 --       x_msg_count               OUT  NUMBER
302 --       x_msg_data                OUT  VARCHAR2
303 --   Version : Current version 1.0
304 --   Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
305 --         and basic operation, developer must manually add parameters and business logic as necessary.
306 --
307 --   End of Comments
308 --   ==============================================================================
309 --
310 
311 PROCEDURE Lock_Model(
312     p_api_version_number         IN   NUMBER,
313     p_init_msg_list              IN   VARCHAR2     := FND_API.G_FALSE,
314     x_return_status              OUT NOCOPY  VARCHAR2,
315     x_msg_count                  OUT NOCOPY  NUMBER,
316     x_msg_data                   OUT NOCOPY  VARCHAR2,
317 
318     p_model_id                   IN  NUMBER,
319     p_object_version             IN  NUMBER
320 );
321 
322 
323 --   ==============================================================================
324 --    Start of Comments
325 --   ==============================================================================
326 --   API Name
327 --           Create_Model
328 --   Type
329 --           Public
330 --   Pre-Req
331 --
332 --   Parameters
333 --
334 --   IN
335 --       p_model_type      IN VARCHAR2
336 --       p_model_name      IN VARCHAR2
337 --       p_target_group_type  IN VARCHAR2, default CONSUMER
338 --       p_target_type     IN VARCHAR2, default BINARY
339 --       p_target_field    IN VARCHAR2
340 --       p_target_value    IN VARCHAR2
341 --       p_darwin_model_ref   IN VARCHAR2, default NULL
342 --       p_description     IN VARCHAR2
343 --
344 --   OUT
345 --       x_model_id        OUT NUMBER
346 --       x_return_status           OUT  VARCHAR2
347 --
348 --   Note
349 --       Used by the ODM Accelerator to create CUSTOM models.  The ODM
350 --       Accelerator is a consulting solution provided to supplement the
351 --       out of the box functionality of OMO data mining.
352 --
353 --   End of Comments
354 --   ==============================================================================
355 --
356 PROCEDURE Create_Model (
357    p_model_type      IN VARCHAR2,
358    p_model_name      IN VARCHAR2,
359    p_target_group_type  IN VARCHAR2 := 'CONSUMER',
360    p_target_type     IN VARCHAR2 := 'BINARY',
361    p_target_field    IN VARCHAR2,
362    p_target_value    IN VARCHAR2,
363    p_darwin_model_ref   IN VARCHAR2 := NULL,
364    p_description     IN VARCHAR2,
365    x_model_id        OUT NOCOPY NUMBER,
366    x_return_status   OUT NOCOPY VARCHAR2
367 );
368 
369 
370 END AMS_DMModel_PUB;