1 PACKAGE CZ_modelOperations_pub AUTHID CURRENT_USER AS
2 /* $Header: czmodops.pls 120.4.12010000.3 2008/09/12 09:59:10 jonatara ship $ */
3 /*#
4 * This is the public interface to operations on configuration models and configuration UIs.
5 * @rep:scope public
6 * @rep:product CZ
7 * @rep:displayname Model Operations API
8 * @rep:lifecycle active
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
11 * @rep:category BUSINESS_ENTITY CZ_RP_FOLDER
12 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
13 */
14
15 ------------------------------------------------------------------------------------------
16 -- CONSTANTS
17 --integer constant for object_id of the ROOT folder in Repository
18 RP_ROOT_FOLDER CONSTANT PLS_INTEGER:=0;
19
20 ------------------------------------------------------------------------------------------
21 -- Start of comments
22 -- API name : Generate_Logic
23 -- Type : Public.
24 -- Function : Generates logic for a model
25 -- Pre-reqs : None.
26 -- Parameters :
27 -- IN : p_api_version IN NUMBER Required
28 -- p_devl_project_id IN NUMBER Required
29 -- Devl_project_id of the model
30 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Required
31 -- CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
32 -- x_status OUT NOCOPY NUMBER Required
33 -- G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
34 -- Version : Current version 1.0
35 -- Initial version 1.0
36 -- Notes :
37 --
38 -- End of comments
39 /*#
40 * Generate Logic
41 * @param p_api_version api version
42 * @param p_devl_project_id devl_project_id of the model
43 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
44 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
45 * @rep:scope public
46 * @rep:lifecycle active
47 * @rep:displayname Generate Logic
48 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
49 */
50 PROCEDURE generate_logic(p_api_version IN NUMBER,
51 p_devl_project_id IN NUMBER,
52 x_run_id OUT NOCOPY NUMBER,
53 x_status OUT NOCOPY NUMBER);
54
55 --------------------------------------------------------------------------------------------
56
57 -- Start of comments
58 -- API name : Generate_Logic
59 -- Type : Public.
60 -- Function : Generates logic for a model
61 -- Pre-reqs : None.
62 -- Parameters :
63 -- IN : p_api_version IN NUMBER Required
64 -- p_devl_project_id IN NUMBER Required
65 -- devl_project_id of the model
66 -- p_user_id IN NUMBER Required
67 -- user id
68 -- p_resp_id IN NUMBER Required
69 -- responsibility id
70 -- p_appl_id IN NUMBER Required
71 -- application id
72 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Required
73 -- CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
74 -- x_status OUT NOCOPY NUMBER Required
75 -- G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
76 -- Version : Current version 1.0
77 -- Initial version 1.0
81 /*#
78 -- Notes :
79 --
80 -- End of comments
82 * Generate Logic
83 * @param p_api_version api version
84 * @param p_devl_project_id devl_project_id of the model
85 * @param p_user_id user id
86 * @param p_resp_id responsibility id
87 * @param p_appl_id application id
88 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
89 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:displayname Generate Logic
93 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
94 */
95 PROCEDURE generate_logic(p_api_version IN NUMBER,
96 p_devl_project_id IN NUMBER,
97 p_user_id IN NUMBER,
98 p_resp_id IN NUMBER,
99 p_appl_id IN NUMBER,
100 x_run_id OUT NOCOPY NUMBER,
101 x_status OUT NOCOPY NUMBER);
102
103 -----------------------------------------
104 -- Start of comments
105 -- API name : Create_UI
106 -- Type : Public.
107 -- Function : Generates a new user interface for a model
108 -- Pre-reqs : None.
109 -- Parameters :
110 -- IN : p_api_version IN NUMBER Required
111 -- p_devl_project_id IN NUMBER Optional
112 -- Devl_project_id of the model
113 -- p_ui_style IN VARCHAR2 Optional
114 -- DEFAULT 'COMPONENTS'
115 -- '0' or 'COMPONENTS' for DHTML UI, '3' or 'APPLET' for Applet UI. Default is 'COMPONENTS'.
116 -- p_frame_allocation IN NUMBER Optional
117 -- DEFAULT 30
118 -- left frame allocation in %
119 -- p_width IN NUMBER Optional
120 -- DEFAULT 640
121 -- width in pixels of UI screens
122 -- p_height IN NUMBER Optional
123 -- DEFAULT 480
124 -- height in pixels of UI screens.
125 -- p_show_all_nodes IN VARCHAR2 Optional
126 -- DEFAULT '0'
127 -- If '1' then UI will be created for all nodes including do not display in UI' nodes,
128 -- if '0' then display in UI flag is respected.
129 -- p_look_and_feel IN VARCHAR2 Optional
130 -- DEFAULT 'BLAF'
131 -- Other possibilities are: 'APPLET' and 'FORMS'
132 -- p_wizard_style IN VARCHAR2 Optional
133 -- DEFAULT '0'
134 -- wizard style navigation, default is '0' (means 'No'), another option is '1' (means 'Yes')
135 -- p_max_bom_per_page IN NUMBER Optional
136 -- DEFAULT 10
137 -- maximum number of BOM option class children per screen
138 -- p_use_labels IN VARCHAR2 Optional
139 -- DEFAULT '1'
140 -- Generate caption from (Description, Name or Description,name)
141 -- OUT NOCOPY : x_ui_def_id OUT NOCOPY NUMBER Optional
142 -- ui_def_id of new UI
143 -- x_run_id OUT NOCOPY NUMBER Optional
144 -- CZ_DB_LOGS.run_id if there are errors, 0 if not
145 -- x_status OUT NOCOPY NUMBER Optional
146 -- G_ERROR or G_SUCCESS (constants from this package)
147 -- Version : Current version 1.0
148 -- Initial version 1.0
149 -- Notes : If referenced models are present, the behavior is the following:
150 -- 1. If a referenced model has one or more user interfaces of the input style (DHTML or Applet),
151 -- the root UI will refer to the last created UI with this style.
152 -- 2. If a referenced model has no user interface, the procedure will generate a new UI for that model.
153 --
154 -- End of comments
155 /*#
156 * Create new UI
157 * @param p_api_version api version
158 * @param p_devl_project_id devl_project_id of the model.
159 * @param x_ui_def_id ui_def_id of generated UI.
160 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
161 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
162 * @param p_ui_style '0' or 'COMPONENTS' for DHTML UI, '3' or 'APPLET' for Applet UI. Default is 'COMPONENTS'.
163 * @param p_frame_allocation left frame allocation in %.
164 * @param p_width width in pixels of UI screens.
165 * @param p_height height in pixels of UI screens.
166 * @param p_show_all_nodes If '1' then UI will be created for all nodes including do not display in UI' nodes,if '0' then display in UI flag is respected.
167 * @param p_look_and_feel Other possibilities are: 'APPLET' and 'FORMS'
168 * @param p_wizard_style wizard style navigation, default is '0' (means 'No'), another option is '1' (means 'Yes')
169 * @param p_max_bom_per_page maximum number of BOM option class children per screen
170 * @param p_use_labels Generate caption from (Description, Name or Description,name)
171 * @rep:scope public
172 * @rep:lifecycle active
173 * @rep:displayname Create new UI
174 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
175 */
176 PROCEDURE create_ui(p_api_version IN NUMBER,
177 p_devl_project_id IN NUMBER,
178 x_ui_def_id OUT NOCOPY NUMBER,
179 x_run_id OUT NOCOPY NUMBER,
183 p_width IN NUMBER ,
180 x_status OUT NOCOPY NUMBER,
181 p_ui_style IN VARCHAR2 ,
182 p_frame_allocation IN NUMBER ,
184 p_height IN NUMBER ,
185 p_show_all_nodes IN VARCHAR2 ,
186 p_look_and_feel IN VARCHAR2 ,
187 p_wizard_style IN VARCHAR2 ,
188 p_max_bom_per_page IN NUMBER ,
189 p_use_labels IN VARCHAR2);
190
191 -- Start of comments
192 -- API name : Create_UI
193 -- Type : Public.
194 -- Function : Generates a new user interface for a model
195 -- Pre-reqs : None.
196 -- Parameters :
197 -- IN : p_api_version IN NUMBER Required
198 -- p_devl_project_id IN NUMBER Required
199 -- Devl_project_id of the model
200 -- p_user_id IN NUMBER Required
201 -- user is
202 -- p_resp_id IN NUMBER Required
203 -- responsibility id
204 -- p_appl_id IN NUMBER Required
205 -- application id
206 -- x_ui_def_id OUT NOCOPY NUMBER Required
207 -- id of newly generated UI
208 -- p_ui_style IN VARCHAR2 Optional
209 -- DEFAULT 'COMPONENTS'
210 -- '0' or 'COMPONENTS' for DHTML UI, '3' or 'APPLET' for Applet UI. Default is 'COMPONENTS'.
211 -- p_frame_allocation IN NUMBER Optional
212 -- DEFAULT 30
213 -- left frame allocation in %
214 -- p_width IN NUMBER Optional
215 -- DEFAULT 640
216 -- width in pixels of UI screens
217 -- p_height IN NUMBER Optional
218 -- DEFAULT 480
219 -- height in pixels of UI screens.
220 -- p_show_all_nodes IN VARCHAR2 Optional
221 -- DEFAULT '0'
222 -- If '1' then UI will be created for all nodes including do not display in UI' nodes,
223 -- if '0' then display in UI flag is respected.
224 -- p_look_and_feel IN VARCHAR2 Optional
225 -- DEFAULT 'BLAF'
226 -- Other possibilities are: 'APPLET' and 'FORMS'
227 -- p_wizard_style IN VARCHAR2 Optional
228 -- DEFAULT '0'
229 -- wizard style navigation, default is '0' (means 'No'), another option is '1' (means 'Yes')
230 -- p_max_bom_per_page IN NUMBER Optional
231 -- DEFAULT 10
232 -- maximum number of BOM option class children per screen
233 -- p_use_labels IN VARCHAR2 Optional
234 -- DEFAULT '1'
235 -- Generate caption from (Description, Name or Description,name)
236 -- OUT NOCOPY : x_ui_def_id OUT NOCOPY NUMBER Optional
237 -- ui_def_id of new UI
238 -- x_run_id OUT NOCOPY NUMBER Optional
239 -- CZ_DB_LOGS.run_id if there are errors, 0 if not
240 -- x_status OUT NOCOPY NUMBER Optional
241 -- G_ERROR or G_SUCCESS (constants from this package)
242 -- Version : Current version 1.0
243 -- Initial version 1.0
244 -- Notes : If referenced models are present, the behavior is the following:
245 -- 1. If a referenced model has one or more user interfaces of the input style (DHTML or Applet),
246 -- the root UI will refer to the last created UI with this style.
247 -- 2. If a referenced model has no user interface, the procedure will generate a new UI for that model.
248 --
249 -- End of comments
250 /*#
251 * Create new UI
252 * @param p_api_version api version
253 * @param p_devl_project_id devl_project_id of the model.
254 * @param p_user_id user id
255 * @param p_resp_id responsibility id
256 * @param p_appl_id application id
257 * @param x_ui_def_id ui_def_id of generated UI.
258 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
259 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
260 * @param p_ui_style '0' or 'COMPONENTS' for DHTML UI, '3' or 'APPLET' for Applet UI. Default is 'COMPONENTS'.
261 * @param p_frame_allocation left frame allocation in %.
262 * @param p_width width in pixels of UI screens.
263 * @param p_height height in pixels of UI screens.
264 * @param p_show_all_nodes If '1' then UI will be created for all nodes including do not display in UI' nodes,if '0' then display in UI flag is respected.
265 * @param p_look_and_feel Other possibilities are: 'APPLET' and 'FORMS'
266 * @param p_wizard_style wizard style navigation, default is '0' (means 'No'), another option is '1' (means 'Yes')
267 * @param p_max_bom_per_page maximum number of BOM option class children per screen
268 * @param p_use_labels Generate caption from (Description, Name or Description,name)
269 * @rep:scope public
270 * @rep:lifecycle active
271 * @rep:displayname Create new UI
272 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
273 */
274 PROCEDURE create_ui(p_api_version IN NUMBER,
275 p_devl_project_id IN NUMBER,
276 p_user_id IN NUMBER,
280 x_run_id OUT NOCOPY NUMBER,
277 p_resp_id IN NUMBER,
278 p_appl_id IN NUMBER,
279 x_ui_def_id OUT NOCOPY NUMBER,
281 x_status OUT NOCOPY NUMBER,
282 p_ui_style IN VARCHAR2 ,
283 p_frame_allocation IN NUMBER ,
284 p_width IN NUMBER ,
285 p_height IN NUMBER ,
286 p_show_all_nodes IN VARCHAR2 ,
287 p_look_and_feel IN VARCHAR2 ,
288 p_wizard_style IN VARCHAR2 ,
289 p_max_bom_per_page IN NUMBER ,
290 p_use_labels IN VARCHAR2 );
291
292
293
294 --------------------------------------------------------------------------------------------
295 -- Start of comments
296 -- API name : create_JRAD_UI
297 -- Type : Public.
298 -- Function : Generates a new JRAD style user interface for a model
299 -- Pre-reqs : None.
300 -- Parameters :
301 -- IN :
302 -- p_api_version -- identifies version of API
303 -- p_devl_project_id -- identifies Model for which UI will be generated
304 -- p_show_all_nodes -- '1' - ignore ps node property "DO NOT SHOW IN UI"
305 -- p_master_template_id -- identifies UI Master Template
306 -- p_create_empty_ui -- '1' - create empty UI ( which contains only one record in CZ_UI_DEFS )
307 -- x_ui_def_id -- ui_def_id of UI that has been generated
308 -- OUT :
309 -- x_return_status -- status string
310 -- x_msg_count -- number of error messages
311 -- x_msg_data -- string which contains error messages
312 --
313 -- Version : Current version 1.0
314 -- Initial version 1.0
315 -- Notes :
316 --
317 -- End of comments
318 --
319 /*#
320 * Create new JRAD style UI
321 * @param p_api_version api version
322 * @param p_devl_project_id devl_project_id of the model.
323 * @param p_show_all_nodes '1' - ignore ps node property "DO NOT SHOW IN UI"
324 * @param p_master_template_id identifies UI Master Template
325 * @param p_create_empty_ui '1' - create empty UI ( which contains only one record in CZ_UI_DEFS )
326 * @param x_ui_def_id ui_def_id of generated UI.
327 * @param x_return_status status string
328 * @param x_msg_count number of error messages
329 * @param x_msg_data string which contains error messages
330 * @rep:scope public
331 * @rep:lifecycle active
332 * @rep:displayname Create new JRAD style UI
333 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
334 */
335 PROCEDURE create_jrad_ui(p_api_version IN NUMBER,
336 p_devl_project_id IN NUMBER,
337 p_show_all_nodes IN VARCHAR2,
338 p_master_template_id IN NUMBER,
339 p_create_empty_ui IN VARCHAR2,
340 x_ui_def_id OUT NOCOPY NUMBER,
341 x_return_status OUT NOCOPY VARCHAR2,
342 x_msg_count OUT NOCOPY NUMBER,
343 x_msg_data OUT NOCOPY VARCHAR2);
344
345 /*#
346 * Create new JRAD style UI
347 * @param p_api_version api version
348 * @param p_user_id user id
349 * @param p_resp_id responsibility id
350 * @param p_appl_id application id
351 * @param p_devl_project_id devl_project_id of the model.
352 * @param p_show_all_nodes '1' - ignore ps node property "DO NOT SHOW IN UI"
353 * @param p_master_template_id identifies UI Master Template
354 * @param p_create_empty_ui '1' - create empty UI ( which contains only one record in CZ_UI_DEFS )
355 * @param x_ui_def_id ui_def_id of generated UI.
356 * @param x_return_status status string
357 * @param x_msg_count number of error messages
358 * @param x_msg_data string which contains error messages
359 * @rep:scope public
360 * @rep:lifecycle active
361 * @rep:displayname Create new JRAD style UI
362 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
363 */
364 PROCEDURE create_jrad_ui(p_api_version IN NUMBER,
365 p_user_id IN NUMBER,
366 p_resp_id IN NUMBER,
367 p_appl_id IN NUMBER,
368 p_devl_project_id IN NUMBER,
369 p_show_all_nodes IN VARCHAR2,
370 p_master_template_id IN NUMBER,
371 p_create_empty_ui IN VARCHAR2,
372 x_ui_def_id OUT NOCOPY NUMBER,
373 x_return_status OUT NOCOPY VARCHAR2,
374 x_msg_count OUT NOCOPY NUMBER,
375 x_msg_data OUT NOCOPY VARCHAR2);
376
377
378 --------------------------------------------------------------------------------------------
379 -- Start of comments
380 -- API name : Refresh_UI
381 -- Type : Public.
382 -- Function : Refresh an existing user interface based on the current model data.
383 -- Pre-reqs : None.
384 -- Parameters :
385 -- IN : p_api_version IN NUMBER Required
386 -- IN OUT NOCOPY : p_ui_def_id IN OUT NOCOPY NUMBER Optional
387 -- ID of user interface to be refreshed.
388 -- If user interface is Applet style, a new ui_def_id is returned through this parameter.
389 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Optional
390 -- CZ_DB_LOGS.run_id if there are warnings or errors, 0 if not
394 -- Initial version 1.0
391 -- x_status OUT NOCOPY NUMBER Optional
392 -- G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
393 -- Version : Current version 1.0
395 -- Notes : It does not refresh referenced user interfaces
396 --
397 -- End of comments
398 /*#
399 * refresh UI
400 * @param p_api_version api version
401 * @param p_ui_def_id ui_def_id of UI
402 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
403 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
404 * @rep:scope public
405 * @rep:lifecycle active
406 * @rep:displayname Refresh UI
407 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
408 */
409 PROCEDURE refresh_ui(p_api_version IN NUMBER,
410 p_ui_def_id IN OUT NOCOPY NUMBER,
411 x_run_id OUT NOCOPY NUMBER,
412 x_status OUT NOCOPY NUMBER);
413
414 -- Start of comments
415 -- API name : Refresh_UI
416 -- Type : Public.
417 -- Function : Refresh an existing user interface based on the current model data.
418 -- Pre-reqs : None.
419 -- Parameters :
420 -- IN : p_api_version IN NUMBER Required
421 -- IN OUT NOCOPY : p_ui_def_id IN OUT NOCOPY NUMBER Required
422 -- ID of user interface to be refreshed.
423 -- If user interface is Applet style, a new ui_def_id is returned through this parameter.
424 -- p_user_id IN NUMBER Required
425 -- user is
426 -- p_resp_id IN NUMBER Required
427 -- responsibility id
428 -- p_appl_id IN NUMBER Required
429 -- application id
430 --
431 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Required
432 -- CZ_DB_LOGS.run_id if there are warnings or errors, 0 if not
433 -- x_status OUT NOCOPY NUMBER Required
434 -- G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
435 -- Version : Current version 1.0
436 -- Initial version 1.0
437 -- Notes : It does not refresh referenced user interfaces
438 --
439 -- End of comments
440 /*#
441 * refresh UI
442 * @param p_api_version api version
443 * @param p_ui_def_id ui_def_id of UI
444 * @param p_user_id user id
445 * @param p_resp_id responsibility id
446 * @param p_appl_id application id
447 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
448 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
449 * @rep:scope public
450 * @rep:lifecycle active
451 * @rep:displayname Refresh UI
452 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
453 */
454 PROCEDURE refresh_ui(p_api_version IN NUMBER,
455 p_ui_def_id IN OUT NOCOPY NUMBER,
456 p_user_id IN NUMBER,
457 p_resp_id IN NUMBER,
458 p_appl_id IN NUMBER,
459 x_run_id OUT NOCOPY NUMBER,
460 x_status OUT NOCOPY NUMBER);
461
462 --------------------------------------------------------------------------------------------
463 -- Start of comments
464 -- API name : refresh_Jrad_UI
465 -- Type : Public.
466 -- Function : Refresh an existing JRAD style user interface based on the current model data.
467 -- Pre-reqs : None.
468 -- Parameters :
469 -- IN : p_api_version - identifies version of API
470 -- p_ui_def_id - identifies UI to refresh
471 -- OUT :
472 -- x_return_status -- status string
473 -- x_msg_count -- number of error messages
474 -- x_msg_data -- string which contains error messages
475 --
476 -- Version : Current version 1.0
477 -- Initial version 1.0
478 -- Notes :
479 --
480 -- End of comments
481 --
482 /*#
483 * refresh JRAD style UI
484 * @param p_api_version api version
485 * @param p_ui_def_id ui_def_id of UI - identifies UI to refresh
486 * @param x_return_status status string
487 * @param x_msg_count number of error messages
488 * @param x_msg_data string which contains error messages
489 * @rep:scope public
490 * @rep:lifecycle active
491 * @rep:displayname Refresh JRAD style UI
492 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
493 */
494 PROCEDURE refresh_jrad_ui(p_api_version IN NUMBER,
495 p_ui_def_id IN OUT NOCOPY NUMBER,
496 x_return_status OUT NOCOPY VARCHAR2,
497 x_msg_count OUT NOCOPY NUMBER,
498 x_msg_data OUT NOCOPY VARCHAR2);
499
500 /*#
501 * refresh JRAD style UI
502 * @param p_api_version api version
503 * @param p_user_id user id
504 * @param p_resp_id responsibility id
505 * @param p_appl_id application id
506 * @param p_ui_def_id ui_def_id of UI - identifies UI to refresh
507 * @param x_return_status status string
508 * @param x_msg_count number of error messages
509 * @param x_msg_data string which contains error messages
510 * @rep:scope public
511 * @rep:lifecycle active
512 * @rep:displayname Refresh JRAD style UI
513 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
514 */
515 PROCEDURE refresh_jrad_ui(p_api_version IN NUMBER,
519 p_ui_def_id IN OUT NOCOPY NUMBER,
516 p_user_id IN NUMBER,
517 p_resp_id IN NUMBER,
518 p_appl_id IN NUMBER,
520 x_return_status OUT NOCOPY VARCHAR2,
521 x_msg_count OUT NOCOPY NUMBER,
522 x_msg_data OUT NOCOPY VARCHAR2);
523
524 --------------------------------------------------------------------------------------------
525 -- Start of comments
526 -- API name : Import_Single_Bill
527 -- Type : Public.
528 -- Function : Import a Bill
529 -- Pre-reqs : None.
530 -- Parameters :
531 -- IN : p_api_version IN NUMBER Required
532 -- p_org_id IN NUMBER Required
533 -- organization ID of the bill to be imported
534 -- p_top_inv_item_id IN NUMBER Required
535 -- inventory item ID of the top item to be imported
536 --
537 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Required
538 -- CZ_DB_LOGS.run_id if there are warnings or errors
539 -- x_status OUT NOCOPY NUMBER Required
540 -- G_ERROR or G_SUCCESS (constants from this package)
541 -- Version : Current version 1.0
542 -- Initial version 1.0
543 -- Notes :
544 --
545 -- End of comments
546 /*#
547 * import Single Bill
548 * @param p_api_version api version
549 * @param p_org_id organization ID of the bill to be imported
550 * @param p_top_inv_item_id inventory item ID of the top item to be imported
551 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
552 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
553 * @rep:scope public
554 * @rep:lifecycle active
555 * @rep:displayname Import Single Bill
556 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
557 */
558 PROCEDURE import_single_bill(p_api_version IN NUMBER,
559 p_org_id IN NUMBER,
560 p_top_inv_item_id IN NUMBER,
561 x_run_id OUT NOCOPY NUMBER,
562 x_status OUT NOCOPY NUMBER);
563
564 /*#
565 * import Single Bill
566 * @param p_api_version api version
567 * @param p_org_id organization ID of the bill to be imported
568 * @param p_top_inv_item_id inventory item ID of the top item to be imported
569 * @param p_user_id user id
570 * @param p_resp_id responsibility id
571 * @param p_appl_id application id
572 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
573 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
574 * @rep:scope public
575 * @rep:lifecycle active
576 * @rep:displayname Import Single Bill
577 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
578 */
579 PROCEDURE import_single_bill(p_api_version IN NUMBER,
580 p_org_id IN NUMBER,
581 p_top_inv_item_id IN NUMBER,
582 p_user_id IN NUMBER,
583 p_resp_id IN NUMBER,
584 p_appl_id IN NUMBER,
585 x_run_id OUT NOCOPY NUMBER,
586 x_status OUT NOCOPY NUMBER);
587
588 --------------------------------------------------------------------------------------------
589 -- Start of comments
590 -- API name : Refresh_Single_Model
591 -- Type : Public.
592 -- Function : Import Refresh of a Model
593 -- Pre-reqs : None.
594 -- Parameters :
595 -- IN : p_api_version IN NUMBER Required
596 -- p_devl_project_id IN NUMBER Required
597 -- Devl_project_id of the model
598 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Required
599 -- CZ_DB_LOGS.run_id if there are warnings or errors
600 -- x_status OUT NOCOPY NUMBER Required
601 -- G_ERROR or G_SUCCESS (constants from this package)
602 -- Version : Current version 1.0
603 -- Initial version 1.0
604 -- Notes :
605 --
606 -- End of comments
607 /*#
608 * refresh Single Bill
609 * @param p_api_version api version
610 * @param p_devl_project_id devl_project_id of the model
611 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
612 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
613 * @rep:scope public
614 * @rep:lifecycle active
615 * @rep:displayname Refresh Single Bill
616 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
617 */
618 PROCEDURE refresh_single_model(p_api_version IN NUMBER,
619 p_devl_project_id IN VARCHAR2,
620 x_run_id OUT NOCOPY NUMBER,
621 x_status OUT NOCOPY NUMBER);
622
623 /*#
624 * refresh Single Bill
625 * @param p_api_version api version
626 * @param p_devl_project_id devl_project_id of the model
627 * @param p_user_id user id
628 * @param p_resp_id responsibility id
629 * @param p_appl_id application id
630 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
631 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
632 * @rep:scope public
633 * @rep:lifecycle active
637 PROCEDURE refresh_single_model(p_api_version IN NUMBER,
634 * @rep:displayname Refresh Single Bill
635 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
636 */
638 p_devl_project_id IN VARCHAR2,
639 p_user_id IN NUMBER,
640 p_resp_id IN NUMBER,
641 p_appl_id IN NUMBER,
642 x_run_id OUT NOCOPY NUMBER,
643 x_status OUT NOCOPY NUMBER) ;
644
645
646 --------------------------------------------------------------------------------------------
647 -- Start of comments
648 -- API name : Publish_Model
649 -- Type : Public.
650 -- Function : Publish a model
651 -- Pre-reqs : None.
652 -- Parameters :
653 -- IN : p_api_version IN NUMBER Required
654 -- p_publication_id IN NUMBER Optional
655 -- Model publication Id
656 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Optional
657 -- CZ_DB_LOGS.run_id
658 -- x_status OUT NOCOPY NUMBER Optional
659 -- G_ERROR or G_SUCCESS (constants from this package)
660 -- Version : Current version 1.0
661 -- Initial version 1.0
662 -- Notes : It should only be run on publications with a status of 'Pending'
663 --
664 -- End of comments
665 /*#
666 * publish model
667 * @param p_api_version api version
668 * @param p_publication_id Model publication Id
669 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
670 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
671 * @rep:scope public
672 * @rep:lifecycle active
673 * @rep:displayname Publish Model
674 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
675 */
676 PROCEDURE publish_model(p_api_version IN NUMBER,
677 p_publication_id IN NUMBER,
678 x_run_id OUT NOCOPY NUMBER,
679 x_status OUT NOCOPY NUMBER);
680
681 /*#
682 * publish model
683 * @param p_api_version api version
684 * @param p_publication_id Model publication Id
685 * @param p_user_id user id
686 * @param p_resp_id responsibility id
687 * @param p_appl_id application id
688 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
689 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
690 * @rep:scope public
691 * @rep:lifecycle active
692 * @rep:displayname Publish Model
693 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
694 */
695 PROCEDURE publish_model(p_api_version IN NUMBER,
696 p_publication_id IN NUMBER,
697 p_user_id IN NUMBER,
698 p_resp_id IN NUMBER,
699 p_appl_id IN NUMBER,
700 x_run_id OUT NOCOPY NUMBER,
701 x_status OUT NOCOPY NUMBER);
702
703 --------------------------------------------------------------------------------------------
704 -- Start of comments
705 -- API name : Deep_Model_Copy
706 -- Type : Public.
707 -- Function : deep model copy
708 -- Pre-reqs : None.
709 -- Parameters :
710 -- IN : p_api_version IN NUMBER Required
711 -- p_devl_project_id IN NUMBER Optional
712 -- Devl_project_id of the model
713 -- p_folder IN NUMBER Optional
714 -- Folder to which the copy is made
715 -- p_copy_rules IN NUMBER Optional
716 -- flag 1 implies copy rules, else 0
717 -- p_copy_uis IN NUMBER Optional
718 -- flag 1 implies copy uis, else 0
719 -- p_copy_root IN NUMBER Optional
720 -- flag 1 implies that only root model would be copied, else 0
721 -- OUT NOCOPY : x_devl_project_id OUT NOCOPY NUMBER Optional
722 -- Devl_project_id of the copy
723 -- x_run_id OUT NOCOPY NUMBER Optional
724 -- CZ_DB_LOGS.run_id
725 -- x_status OUT NOCOPY NUMBER Optional
726 -- G_ERROR or G_SUCCESS (constants from this package)
727 -- Version : Current version 1.0
728 -- Initial version 1.0
729 -- Notes : The referenced models are also copied
730 --
731 -- End of comments
732 /*#
733 * deep model copy
734 * @param p_api_version api version
735 * @param p_devl_project_id devl_project_id of the model
736 * @param p_folder Folder to which the copy is made
737 * @param p_copy_rules flag 1 implies copy rules, else 0
738 * @param p_copy_uis flag 1 implies copy uis, else 0
739 * @param p_copy_root flag 1 implies that only root model would be copied, else 0
740 * @param x_devl_project_id devl_project_id of the copy
741 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
742 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
743 * @rep:scope public
744 * @rep:lifecycle active
745 * @rep:displayname Deep Model Copy
746 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
747 */
748 PROCEDURE deep_model_copy(p_api_version IN NUMBER,
749 p_devl_project_id IN NUMBER,
753 p_copy_root IN NUMBER,
750 p_folder IN NUMBER,
751 p_copy_rules IN NUMBER,
752 p_copy_uis IN NUMBER,
754 x_devl_project_id OUT NOCOPY NUMBER,
755 x_run_id OUT NOCOPY NUMBER,
756 x_status OUT NOCOPY NUMBER);
757
758 /*#
759 * deep model copy
760 * @param p_api_version api version
761 * @param p_user_id user id
762 * @param p_resp_id responsibility id
763 * @param p_appl_id application id
764 * @param p_devl_project_id devl_project_id of the model
765 * @param p_folder Folder to which the copy is made
766 * @param p_copy_rules flag 1 implies copy rules, else 0
767 * @param p_copy_uis flag 1 implies copy uis, else 0
768 * @param p_copy_root flag 1 implies that only root model would be copied, else 0
769 * @param x_devl_project_id devl_project_id of the copy
770 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
771 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
772 * @rep:scope public
773 * @rep:lifecycle active
774 * @rep:displayname Deep Model Copy
775 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
776 */
777 PROCEDURE deep_model_copy(p_api_version IN NUMBER,
778 p_user_id IN NUMBER,
779 p_resp_id IN NUMBER,
780 p_appl_id IN NUMBER,
781 p_devl_project_id IN NUMBER,
782 p_folder IN NUMBER,
783 p_copy_rules IN NUMBER,
784 p_copy_uis IN NUMBER,
785 p_copy_root IN NUMBER,
786 x_devl_project_id OUT NOCOPY NUMBER,
787 x_run_id OUT NOCOPY NUMBER,
788 x_status OUT NOCOPY NUMBER);
789
790 --------------------------------------------------------------------------------------------
791 -- Start of comments
792 -- API name : Execute_Populator
793 -- Type : Public.
794 -- Function : Refresh CZ_PS_NODES by executing a populator
795 -- Pre-reqs : None.
796 -- Parameters :
797 -- IN : p_api_version IN NUMBER Required
798 -- p_populator_id IN NUMBER Optional
799 -- CZ_POPULATORS.populator_id of populator to be executed
800 -- IN OUT NOCOPY : p_imp_run_id IN OUT NOCOPY VARCHAR2 Optional
801 -- CZ_IMP_PS_NODES.run_id
802 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Optional
803 -- CZ_DB_LOGS.run_id
804 -- x_status OUT NOCOPY NUMBER Optional
805 -- G_ERROR or G_SUCCESS (constants from this package)
806 -- Version : Current version 1.0
807 -- Initial version 1.0
808 -- Notes :
809 --
810 -- End of comments
811 /*#
812 * execute populator
813 * @param p_api_version api version
814 * @param p_populator_id CZ_POPULATORS.populator_id of populator to be executed
815 * @param p_imp_run_id IN OUT value - CZ_IMP_PS_NODES.run_id
816 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
817 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
818 * @rep:scope public
819 * @rep:lifecycle active
820 * @rep:displayname Execute Populator
821 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
822 */
823 PROCEDURE execute_populator(p_api_version IN NUMBER,
824 p_populator_id IN NUMBER,
825 p_imp_run_id IN OUT NOCOPY VARCHAR2,
826 x_run_id OUT NOCOPY NUMBER,
827 x_status OUT NOCOPY NUMBER);
828
829 /*#
830 * execute populator
831 * @param p_api_version api version
832 * @param p_user_id user id
833 * @param p_resp_id responsibility id
834 * @param p_appl_id application id
835 * @param p_populator_id CZ_POPULATORS.populator_id of populator to be executed
836 * @param p_imp_run_id IN OUT value - CZ_IMP_PS_NODES.run_id
837 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
838 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
839 * @rep:scope public
840 * @rep:lifecycle active
841 * @rep:displayname Execute Populator
842 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
843 */
844 PROCEDURE execute_populator(p_api_version IN NUMBER,
845 p_user_id IN NUMBER,
846 p_resp_id IN NUMBER,
847 p_appl_id IN NUMBER,
848 p_populator_id IN NUMBER,
849 p_imp_run_id IN OUT NOCOPY VARCHAR2,
850 x_run_id OUT NOCOPY NUMBER,
851 x_status OUT NOCOPY NUMBER);
852
853 --------------------------------------------------------------------------------------------
854 -- Start of comments
855 -- API name : Repopulate
856 -- Type : Public.
857 -- Function : Generates logic for a model
858 -- Pre-reqs : None.
859 -- Parameters :
860 -- IN : p_api_version IN NUMBER Required
861 -- p_devl_project_id IN NUMBER Optional
862 -- Devl_project_id of the model
863 -- p_regenerate_all IN VARCHAR2 Optional
864 -- DEFAULT '1'
868 -- DEFAULT '1'
865 -- '0' if all populators should be regenerated unconditionally before execution,
866 -- '1' only modified ones
867 -- p_handle_invalid IN VARCHAR2 Optional
869 -- Allows caller to specify how to handle invalid populators
870 -- skip('0') or regenerate ('1')
871 -- p_handle_broken IN VARCHAR2 Optional
872 -- DEFAULT '1'
873 -- Allows caller to specify whether to continue ('1') or not ('0')
874 -- when a populator cannot be regenerated successfully
875 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Optional
876 -- CZ_DB_LOGS.run_id
877 -- x_status OUT NOCOPY NUMBER Optional
878 -- G_ERROR or G_SUCCESS (constants from this package)
879 -- Version : Current version 1.0
880 -- Initial version 1.0
881 -- Notes :
882 --
883 -- End of comments
884 /*#
885 * repopulate populators
886 * @param p_api_version api version
887 * @param p_devl_project_id devl_project_id of the model
888 * @param p_regenerate_all 0' if all populators should be regenerated unconditionally before execution,'1' only modified ones.
889 * @param p_handle_invalid Allows caller to specify how to handle invalid populators skip('0') or regenerate ('1').
890 * @param p_handle_broken Allows caller to specify whether to continue ('1') or not ('0') when a populator cannot be regenerated successfully.
891 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
892 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
893 * @rep:scope public
894 * @rep:lifecycle active
895 * @rep:displayname Repopulate Populators
896 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
897 */
898 PROCEDURE repopulate(p_api_version IN NUMBER,
899 p_devl_project_id IN NUMBER,
900 p_regenerate_all IN VARCHAR2 , -- DEFAULT '1',
901 p_handle_invalid IN VARCHAR2 , -- DEFAULT '1',
902 p_handle_broken IN VARCHAR2 , -- DEFAULT '1',
903 x_run_id OUT NOCOPY NUMBER,
904 x_status OUT NOCOPY NUMBER);
905
906 /*#
907 * repopulate populators
908 * @param p_api_version api version
909 * @param p_devl_project_id devl_project_id of the model
910 * @param p_user_id user id
911 * @param p_resp_id responsibility id
912 * @param p_appl_id application id
913 * @param p_regenerate_all 0' if all populators should be regenerated unconditionally before execution,'1' only modified ones.
914 * @param p_handle_invalid Allows caller to specify how to handle invalid populators skip('0') or regenerate ('1').
915 * @param p_handle_broken Allows caller to specify whether to continue ('1') or not ('0') when a populator cannot be regenerated successfully.
916 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
917 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
918 * @rep:scope public
919 * @rep:lifecycle active
920 * @rep:displayname Repopulate Populators
921 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
922 */
923 PROCEDURE repopulate(p_api_version IN NUMBER,
924 p_devl_project_id IN NUMBER,
925 p_user_id IN NUMBER,
926 p_resp_id IN NUMBER,
927 p_appl_id IN NUMBER,
928 p_regenerate_all IN VARCHAR2 , -- DEFAULT '1',
929 p_handle_invalid IN VARCHAR2 , -- DEFAULT '1',
930 p_handle_broken IN VARCHAR2 , -- DEFAULT '1',
931 x_run_id OUT NOCOPY NUMBER,
932 x_status OUT NOCOPY NUMBER);
933
934 -----------------------------------------------------
935 -- Start of comments
936 -- API name : Republish_Model
937 -- Type : Public.
938 -- Function : Republishes an existing publication
939 -- Pre-reqs : None.
940 -- Parameters :
941 -- IN : p_api_version IN NUMBER Required
942 -- p_publication_id IN NUMBER Required
943 -- Model publication Id
944 -- IN : p_start_date IN DATE Optional
945 -- Default applicable_from
946 -- IN : p_end_date IN DATE Optional
947 -- Default value applicable_until
948 -- OUT NOCOPY : x_run_id OUT NOCOPY NUMBER Optional
949 -- CZ_DB_LOGS.run_id
950 -- x_status OUT NOCOPY NUMBER Optional
951 -- G_ERROR or G_SUCCESS (constants from this package)
952 -- Version : Current version 1.0
953 -- Initial version 1.0
954 -- Notes : It should only be run on publications with a status of 'Complete'
955 --
956 -- End of comments
957 /*#
958 * republish model
959 * @param p_api_version api version
960 * @param p_publication_id Model publication Id
961 * @param p_start_date Default applicable_from
962 * @param p_end_date Default value applicable_until
963 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
964 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
965 * @rep:scope public
966 * @rep:lifecycle active
967 * @rep:displayname Republish Model
968 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
969 */
970 PROCEDURE republish_model(p_api_version IN NUMBER,
974 x_run_id OUT NOCOPY NUMBER,
971 p_publication_id IN NUMBER,
972 p_start_date IN DATE ,
973 p_end_date IN DATE ,
975 x_status OUT NOCOPY NUMBER);
976
977 /*#
978 * republish model
979 * @param p_api_version api version
980 * @param p_publication_id Model publication Id
981 * @param p_user_id user id
982 * @param p_resp_id responsibility id
983 * @param p_appl_id application id
984 * @param p_start_date Default applicable_from
985 * @param p_end_date Default value applicable_until
986 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not
987 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package)
988 * @rep:scope public
989 * @rep:lifecycle active
990 * @rep:displayname Republish Model
991 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
992 */
993 PROCEDURE republish_model(p_api_version IN NUMBER,
994 p_publication_id IN NUMBER,
995 p_user_id IN NUMBER,
996 p_resp_id IN NUMBER,
997 p_appl_id IN NUMBER,
998 p_start_date IN DATE,
999 p_end_date IN DATE,
1000 x_run_id OUT NOCOPY NUMBER,
1001 x_status OUT NOCOPY NUMBER);
1002 -----------------------------------------------------
1003 -- Start of comments
1004 -- API name : rp_folder_exists
1005 -- Type : Public.
1006 -- Function : check if a repository folder exists
1007 -- Pre-reqs : None.
1008 -- Parameters :
1009 -- IN : p_api_version IN NUMBER Required
1010 -- : p_rp_folder_id IN NUMBER Required
1011 -- the folder id (object_id) of the RP folder to check
1012 -- : p_encl_folder_id IN NUMBER Required
1013 -- The parent folder in which the p_rp_folder_id
1014 -- will be checked for existance
1015 -- Use RP_ROOT_FOLDER for folder id of the root folder
1016 -- Pass NULL to check the folder anywhere in the repository
1017 -- RETURNS : Boolean
1018 -- TRUE when encl folder is null and
1019 -- p_rp_folder exists anywhere in repository
1020 -- TRUE when encl folder is not null and
1021 -- it exists anywhere in repository and
1022 -- p_rp_folder exists in it
1023 -- FALSE when encl folder is null and
1024 -- p_rp_folder doesn't exists anywhere in repository
1025 -- FALSE when encl folder is not null and
1026 -- it doesn't exists anywhere in repository
1027 -- FALSE when encl folder is not null and
1028 -- p_rp_folder is not in it
1029 -- Version : Current version 1.0
1030 -- Initial version 1.0
1031 -- Notes :
1032 --
1033 -- End of comments
1034 /*#
1035 * check if a repository folder exists
1036 * @param p_api_version api version
1037 * @param p_encl_folder_id The folder id (object_id) of the RP folder to check.
1038 * @param p_rp_folder_id The parent folder in which the p_rp_folder_id will be checked for existance
1039 * @return TRUE when encl folder is null and p_rp_folder exists anywhere in repository
1040 * TRUE when encl folder is not null and it exists anywhere in repository and p_rp_folder exists in it
1041 * FALSE when encl folder is null and p_rp_folder doesn't exists anywhere in repository
1042 * FALSE when encl folder is not null and it doesn't exists anywhere in repository
1043 * FALSE when encl folder is not null and p_rp_folder is not in it
1044 * @rep:scope public
1045 * @rep:lifecycle active
1046 * @rep:displayname check if a Repository folder exists
1047 * @rep:category BUSINESS_ENTITY CZ_RP_FOLDER
1048 */
1049 FUNCTION rp_folder_exists (p_api_version IN NUMBER
1050 ,p_encl_folder_id IN NUMBER
1051 ,p_rp_folder_id IN NUMBER) RETURN BOOLEAN;
1052
1053 -----------------------------------------------------
1054 -- Start of comments
1055 -- API name : rp_folder_exists
1056 -- Type : Public.
1057 -- Function : check if a repository folder exists
1058 -- Pre-reqs : None.
1059 -- Parameters :
1060 -- IN : p_api_version IN NUMBER Required
1061 -- : p_rp_folder_id IN NUMBER Required
1062 -- the folder id (object_id) of the RP folder to check
1063 -- : p_encl_folder_id IN NUMBER Required
1064 -- The parent folder in which the p_rp_folder_id
1065 -- will be checked for existance
1066 -- Use RP_ROOT_FOLDER for folder id of the root folder
1067 -- Pass NULL to check the folder anywhere in the repository
1068 -- p_user_id IN NUMBER Required
1069 -- user id
1070 -- p_resp_id IN NUMBER Required
1071 -- responsibility id
1075 -- TRUE when encl folder is null and
1072 -- p_appl_id IN NUMBER Required
1073 -- application id
1074 -- RETURNS : Boolean
1076 -- p_rp_folder exists anywhere in repository
1077 -- TRUE when encl folder is not null and
1078 -- it exists anywhere in repository and
1079 -- p_rp_folder exists in it
1080 -- FALSE when encl folder is null and
1081 -- p_rp_folder doesn't exists anywhere in repository
1082 -- FALSE when encl folder is not null and
1083 -- it doesn't exists anywhere in repository
1084 -- FALSE when encl folder is not null and
1085 -- p_rp_folder is not in it
1086 -- Version : Current version 1.0
1087 -- Initial version 1.0
1088 -- Notes :
1089 --
1090 -- End of comments
1091 /*#
1092 * check if a repository folder exists
1093 * @param p_api_version api version
1094 * @param p_encl_folder_id The folder id (object_id) of the RP folder to check.
1095 * @param p_rp_folder_id The parent folder in which the p_rp_folder_id will be checked for existance
1096 * @param p_user_id user id
1097 * @param p_resp_id responsibility id
1098 * @param p_appl_id application id
1099 * @return TRUE when encl folder is null and p_rp_folder exists anywhere in repository
1100 * TRUE when encl folder is not null and it exists anywhere in repository and p_rp_folder exists in it
1101 * FALSE when encl folder is null and p_rp_folder doesn't exists anywhere in repository
1102 * FALSE when encl folder is not null and it doesn't exists anywhere in repository
1103 * FALSE when encl folder is not null and p_rp_folder is not in it
1104 * @rep:scope public
1105 * @rep:lifecycle active
1106 * @rep:displayname check if a Repository folder exists
1107 * @rep:category BUSINESS_ENTITY CZ_RP_FOLDER
1108 */
1109 FUNCTION rp_folder_exists (
1110 p_api_version IN NUMBER,
1111 p_encl_folder_id IN NUMBER,
1112 p_rp_folder_id IN NUMBER,
1113 p_user_id IN NUMBER,
1114 p_resp_id IN NUMBER,
1115 p_appl_id IN NUMBER
1116 ) RETURN BOOLEAN;
1117
1118 -----------------------------------------------------
1119 -- Start of comments
1120 -- API name : create_rp_folder
1121 -- Type : Public.
1122 --
1123 -- Function : Creates a Repository folder in the specified enclosing folder.
1124 -- If a folder with the same name exists in the enclosing folder
1125 -- then its id is returned in x_new_folder_id OUT paramater
1126 --
1127 -- Pre-reqs : None.
1128 -- Parameters :
1129 -- IN : p_api_version IN NUMBER Required
1130 -- p_encl_folder_id IN NUMBER Required
1131 -- The parent folder to create new folder
1132 -- use RP_ROOT_FOLDER constant for root folder
1133 -- p_new_folder_name IN VARCHAR2 Required
1134 -- The new folder name
1135 -- p_folder_desc IN VARCHAR2 DEFAULT NULL
1136 -- p_folder_notes IN VARCHAR2 DEFAULT NULL
1137 -- OUT :
1138 -- x_new_folder_id OUT NOCOPY NUMBER Required
1139 -- the new folder id created, or the
1140 -- folder id of the folder with the same name
1141 -- in the same enclosing folder
1142 -- x_return_status OUT NOCOPY VARCHAR2 Required
1143 -- x_msg_count OUT NOCOPY NUMBER Required
1144 -- x_msg_data OUT NOCOPY VARCHAR2 Required
1145 --
1146 -- Version : Current version 1.0
1147 -- Initial version 1.0
1148 -- Notes : if a folder with the same name exists in the enclosing folder
1149 -- then its id is returned in x_new_folder_id OUT paramater
1150 --
1151 -- End of comments
1152 -----------------------------------------------------
1153 /*#
1154 * create repository folder
1155 * @param p_api_version api version
1156 * @param p_encl_folder_id The parent folder to create new folder use RP_ROOT_FOLDER constant for root folder.
1157 * @param p_new_folder_name The new folder name
1158 * @param p_folder_desc The new folder description
1159 * @param p_folder_notes The new folder notes
1160 * @param x_new_folder_id The new folder id created, or the folder id of the folder with the same name in the same enclosing folder
1161 * @param x_return_status status string
1162 * @param x_msg_count number of error messages
1163 * @param x_msg_data string which contains error messages
1164 * @rep:scope public
1165 * @rep:lifecycle active
1166 * @rep:displayname create Repository Folder
1167 * @rep:category BUSINESS_ENTITY CZ_RP_FOLDER
1168 */
1169 PROCEDURE create_rp_folder(p_api_version IN NUMBER
1170 ,p_encl_folder_id IN CZ_RP_ENTRIES.OBJECT_ID%TYPE
1171 ,p_new_folder_name IN CZ_RP_ENTRIES.NAME%TYPE
1172 ,p_folder_desc IN CZ_RP_ENTRIES.DESCRIPTION%TYPE
1173 ,p_folder_notes IN CZ_RP_ENTRIES.NOTES%TYPE
1174 ,x_new_folder_id OUT NOCOPY CZ_RP_ENTRIES.OBJECT_ID%TYPE
1175 ,x_return_status OUT NOCOPY VARCHAR2
1179 -----------------------------------------------------
1176 ,x_msg_count OUT NOCOPY NUMBER
1177 ,x_msg_data OUT NOCOPY VARCHAR2
1178 );
1180 -- Start of comments
1181 -- API name : create_rp_folder
1182 -- Type : Public.
1183 --
1184 -- Function : Creates a Repository folder in the specified enclosing folder.
1185 -- If a folder with the same name exists in the enclosing folder
1186 -- then its id is returned in x_new_folder_id OUT paramater
1187 --
1188 -- Pre-reqs : None.
1189 -- Parameters :
1190 -- IN : p_api_version IN NUMBER Required
1191 -- p_encl_folder_id IN NUMBER Required
1192 -- The parent folder to create new folder
1193 -- use RP_ROOT_FOLDER constant for root folder
1194 -- p_new_folder_name IN VARCHAR2 Required
1195 -- The new folder name
1196 -- p_folder_desc IN VARCHAR2 DEFAULT NULL
1197 -- p_folder_notes IN VARCHAR2 DEFAULT NULL
1198 -- p_user_id IN NUMBER Required
1199 -- user id
1200 -- p_resp_id IN NUMBER Required
1201 -- responsibility id
1202 -- p_appl_id IN NUMBER Required
1203 -- application id
1204 -- OUT :
1205 -- x_new_folder_id OUT NOCOPY NUMBER Required
1206 -- the new folder id created, or the
1207 -- folder id of the folder with the same name
1208 -- in the same enclosing folder
1209 -- x_return_status OUT NOCOPY VARCHAR2 Required
1210 -- x_msg_count OUT NOCOPY NUMBER Required
1211 -- x_msg_data OUT NOCOPY VARCHAR2 Required
1212 --
1213 -- Version : Current version 1.0
1214 -- Initial version 1.0
1215 -- Notes : if a folder with the same name exists in the enclosing folder
1216 -- then its id is returned in x_new_folder_id OUT paramater
1217 --
1218 -- End of comments
1219 -----------------------------------------------------
1220 /*#
1221 * create repository folder
1222 * @param p_api_version api version
1223 * @param p_encl_folder_id The parent folder to create new folder use RP_ROOT_FOLDER constant for root folder.
1224 * @param p_new_folder_name The new folder name
1225 * @param p_folder_desc The new folder description
1226 * @param p_folder_notes The new folder notes
1227 * @param p_user_id user id
1228 * @param p_resp_id responsibility id
1229 * @param p_appl_id application id
1230 * @param x_new_folder_id The new folder id created, or the folder id of the folder with the same name in the same enclosing folder
1231 * @param x_return_status status string
1232 * @param x_msg_count number of error messages
1233 * @param x_msg_data string which contains error messages
1234 * @rep:scope public
1235 * @rep:lifecycle active
1236 * @rep:displayname create Repository Folder
1237 * @rep:category BUSINESS_ENTITY CZ_RP_FOLDER
1238 */
1239 PROCEDURE create_rp_folder(p_api_version IN NUMBER
1240 ,p_encl_folder_id IN CZ_RP_ENTRIES.OBJECT_ID%TYPE
1241 ,p_new_folder_name IN CZ_RP_ENTRIES.NAME%TYPE
1242 ,p_folder_desc IN CZ_RP_ENTRIES.DESCRIPTION%TYPE
1243 ,p_folder_notes IN CZ_RP_ENTRIES.NOTES%TYPE
1244 ,p_user_id IN NUMBER
1245 ,p_resp_id IN NUMBER
1246 ,p_appl_id IN NUMBER
1247 ,x_new_folder_id OUT NOCOPY CZ_RP_ENTRIES.OBJECT_ID%TYPE
1248 ,x_return_status OUT NOCOPY VARCHAR2
1249 ,x_msg_count OUT NOCOPY NUMBER
1250 ,x_msg_data OUT NOCOPY VARCHAR2
1251 );
1252 -----------------------------------------------------
1253 -- Start of comments
1254 -- API name : import_generic
1255 -- Type : Public.
1256 -- Function : process and import data in CZ interface tables
1257 -- Pre-reqs : None.
1258 -- Parameters :
1259 -- IN : p_api_version IN NUMBER Required
1260 -- IN : p_run_id IN NUMBER Required
1261 -- Specify the run_id to process. If NULL, all records
1262 -- in interface tables where run_id is NULL will be processed.
1263 -- IN : p_rp_folder_id IN NUMBER Required
1264 -- The repository folder to import the model into,
1265 -- use RP_ROOT_FOLDER constant for the root folder id
1266 -- OUT : x_run_id OUT NOCOPY NUMBER Required
1267 -- Used to get results from cz_xfr_run_infos and cz_xfr_run_results
1268 -- Also CZ_DB_LOGS.run_id, if there are warnings or errors
1272 -- Initial version 1.0
1269 -- OUT : x_status OUT NOCOPY NUMBER Required
1270 -- G_ERROR or G_SUCCESS (constants from this package)
1271 -- Version : Current version 1.0
1273 -- Notes :
1274 --
1275 -- End of comments
1276 /*#
1277 * generic Import
1278 * @param p_api_version api version
1279 * @param p_run_id Specify the run_id to process. If NULL, all records in interface tables where run_id is NULL will be processed.
1280 * @param p_rp_folder_id The repository folder to import the model into, use RP_ROOT_FOLDER constant for the root folder id.
1281 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not.
1282 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package).
1283 * @rep:scope public
1284 * @rep:lifecycle active
1285 * @rep:displayname Generic Import
1286 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1287 */
1288 PROCEDURE import_generic(p_api_version IN NUMBER
1289 ,p_run_id IN NUMBER
1290 ,p_rp_folder_id IN NUMBER
1291 ,x_run_id OUT NOCOPY NUMBER
1292 ,x_status OUT NOCOPY NUMBER);
1293
1294 -----------------------------------------------------
1295 -- Start of comments
1296 -- API name : import_generic
1297 -- Type : Public.
1298 -- Function : process and import data in CZ interface tables
1299 -- Pre-reqs : None.
1300 -- Parameters :
1301 -- IN : p_api_version IN NUMBER Required
1302 -- IN : p_run_id IN NUMBER Required
1303 -- Specify the run_id to process. If NULL, all records
1304 -- in interface tables where run_id is NULL will be processed.
1305 -- IN : p_rp_folder_id IN NUMBER Required
1306 -- The repository folder to import the model into,
1307 -- use RP_ROOT_FOLDER constant for the root folder id
1308 -- p_user_id IN NUMBER Required
1309 -- user id
1310 -- p_resp_id IN NUMBER Required
1311 -- responsibility id
1312 -- p_appl_id IN NUMBER Required
1313 -- application id
1314 -- OUT : x_run_id OUT NOCOPY NUMBER Required
1315 -- Used to get results from cz_xfr_run_infos and cz_xfr_run_results
1316 -- Also CZ_DB_LOGS.run_id, if there are warnings or errors
1317 -- OUT : x_status OUT NOCOPY NUMBER Required
1318 -- G_ERROR or G_SUCCESS (constants from this package)
1319 -- Version : Current version 1.0
1320 -- Initial version 1.0
1321 -- Notes :
1322 --
1323 -- End of comments
1324 /*#
1325 * generic Import
1326 * @param p_api_version api version
1327 * @param p_run_id Specify the run_id to process. If NULL, all records in interface tables where run_id is NULL will be processed.
1328 * @param p_rp_folder_id The repository folder to import the model into, use RP_ROOT_FOLDER constant for the root folder id.
1329 * @param p_user_id user id
1330 * @param p_resp_id responsibility id
1331 * @param p_appl_id application id
1332 * @param x_run_id CZ_DB_LOGS.run_id if there are warnings and/or errors, 0 if not.
1333 * @param x_status G_ERROR, G_WARNING or G_SUCCESS (constants from this package).
1334 * @rep:scope public
1335 * @rep:lifecycle active
1336 * @rep:displayname Generic Import
1337 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1338 */
1339 PROCEDURE import_generic(p_api_version IN NUMBER
1340 ,p_run_id IN NUMBER
1341 ,p_rp_folder_id IN NUMBER
1342 ,p_user_id IN NUMBER
1343 ,p_resp_id IN NUMBER
1344 ,p_appl_id IN NUMBER
1345 ,x_run_id OUT NOCOPY NUMBER
1346 ,x_status OUT NOCOPY NUMBER);
1347
1348 -----------------------------------------
1349 /*#
1350 * This is the public interface for force unlock operations on a model in Oracle Configurator
1351 * @param p_api_version Current version of the API is 1.0
1352 * @param p_model_id devl_project_id of the model from cz_devl_projects table
1353 * @param p_unlock_references A value of FND_API.G_TRUE indicates that the child models if any should be
1354 * force unlocked. A value of FND_API.G_FALSE indicates that only the root model
1355 * will be unlocked
1356 * @param p_init_msg_list FND_API.G_TRUE if the API should initialize the FND stack, FND_API.G_FALSE if not.
1357 * @param x_return_status standard FND status. (ex:FND_API.G_RET_STS_SUCCESS )
1358 * @param x_msg_count number of messages on the stack.
1362 * @rep:lifecycle active
1359 * @param x_msg_data standard FND OUT parameter for message. Messages are written to the FND error stack
1360 * @rep:scope public
1361 * @rep:displayname API for working with force unlock operations on a model
1363 * @rep:compatibility S
1364 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1365 */
1366
1367 PROCEDURE force_unlock_model (p_api_version IN NUMBER,
1368 p_model_id IN NUMBER,
1369 p_unlock_references IN VARCHAR2,
1370 p_init_msg_list IN VARCHAR2,
1371 x_return_status OUT NOCOPY VARCHAR2,
1372 x_msg_count OUT NOCOPY NUMBER,
1373 x_msg_data OUT NOCOPY VARCHAR2);
1374
1375 -----------------------------------------
1376 /*#
1377 * This is the public interface for force unlock operations on a model in Oracle Configurator
1378 * @param p_api_version Current version of the API is 1.0
1379 * @param p_model_id devl_project_id of the model from cz_devl_projects table
1380 * @param p_unlock_references A value of FND_API.G_TRUE indicates that the child models if any should be
1381 * force unlocked. A value of FND_API.G_FALSE indicates that only the root model
1382 * will be unlocked
1383 * @param p_init_msg_list FND_API.G_TRUE if the API should initialize the FND stack, FND_API.G_FALSE if not.
1384 * @param p_user_id user id
1385 * @param p_resp_id responsibility id
1386 * @param p_appl_id application id
1387 * @param x_return_status standard FND status. (ex:FND_API.G_RET_STS_SUCCESS )
1388 * @param x_msg_count number of messages on the stack.
1389 * @param x_msg_data standard FND OUT parameter for message. Messages are written to the FND error stack
1390 * @rep:scope public
1391 * @rep:displayname API for working with force unlock operations on a model
1392 * @rep:lifecycle active
1393 * @rep:compatibility S
1394 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1395 */
1396
1397 PROCEDURE force_unlock_model (p_api_version IN NUMBER,
1398 p_model_id IN NUMBER,
1399 p_unlock_references IN VARCHAR2,
1400 p_init_msg_list IN VARCHAR2,
1401 p_user_id IN NUMBER,
1402 p_resp_id IN NUMBER,
1403 p_appl_id IN NUMBER,
1404 x_return_status OUT NOCOPY VARCHAR2,
1405 x_msg_count OUT NOCOPY NUMBER,
1406 x_msg_data OUT NOCOPY VARCHAR2);
1407
1408 ---------------------------------------------------
1409 /*#
1410 * This is the public interface for force unlock operations on a UI content template in Oracle Configurator
1411 * @param p_api_version Current version of the API is 1.0
1412 * @param p_template_id Template_id of the template from cz_ui_templates table
1413 * @param p_init_msg_list FND_API.G_TRUE if the API should initialize the FND stack, FND_API.G_FALSE if not.
1414 * @param x_return_status standard FND status. (ex:FND_API.G_RET_STS_SUCCESS )
1415 * @param x_msg_count number of messages on the stack.
1416 * @param x_msg_data standard FND OUT parameter for message. Messages are written to the FND error stack
1417 * @rep:scope public
1418 * @rep:displayname API for working with force unlock operations on a UI content template
1419 * @rep:lifecycle active
1420 * @rep:compatibility S
1421 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
1422 */
1423
1424 PROCEDURE force_unlock_template (p_api_version IN NUMBER,
1425 p_template_id IN NUMBER,
1426 p_init_msg_list IN VARCHAR2,
1427 x_return_status OUT NOCOPY VARCHAR2,
1428 x_msg_count OUT NOCOPY NUMBER,
1429 x_msg_data OUT NOCOPY VARCHAR2);
1430
1431 ---------------------------------------------------
1432 /*#
1433 * This is the public interface for force unlock operations on a UI content template in Oracle Configurator
1434 * @param p_api_version Current version of the API is 1.0
1435 * @param p_template_id Template_id of the template from cz_ui_templates table
1436 * @param p_init_msg_list FND_API.G_TRUE if the API should initialize the FND stack, FND_API.G_FALSE if not.
1437 * @param p_user_id user id
1438 * @param p_resp_id responsibility id
1439 * @param p_appl_id application id
1440 * @param x_return_status standard FND status. (ex:FND_API.G_RET_STS_SUCCESS )
1441 * @param x_msg_count number of messages on the stack.
1442 * @param x_msg_data standard FND OUT parameter for message. Messages are written to the FND error stack
1443 * @rep:scope public
1444 * @rep:displayname API for working with force unlock operations on a UI content template
1445 * @rep:lifecycle active
1446 * @rep:compatibility S
1447 * @rep:category BUSINESS_ENTITY CZ_USER_INTERFACE
1448 */
1449
1450 PROCEDURE force_unlock_template (p_api_version IN NUMBER,
1451 p_template_id IN NUMBER,
1452 p_init_msg_list IN VARCHAR2,
1453 p_user_id IN NUMBER,
1454 p_resp_id IN NUMBER,
1455 p_appl_id IN NUMBER,
1456 x_return_status OUT NOCOPY VARCHAR2,
1457 x_msg_count OUT NOCOPY NUMBER,
1458 x_msg_data OUT NOCOPY VARCHAR2);
1459
1460 -----------------------------------------------------
1461 -- Start of comments
1462 -- API name : usage_id_from_usage_name
1463 -- Type : Public.
1464 --
1468 -- Parameters :
1465 -- Function : Returns the MODEL_USAGE_ID for a given NAME(usage name).
1466 --
1467 -- Pre-reqs : None.
1469 -- IN : p_api_version IN NUMBER Required
1470 -- p_usage_name IN VARCHAR2 Required
1471 -- CZ_MODEL_USAGES.NAME
1472 -- OUT :
1473 -- x_return_status OUT NOCOPY VARCHAR2 Required
1474 -- x_msg_count OUT NOCOPY NUMBER Required
1475 -- x_msg_data OUT NOCOPY VARCHAR2 Required
1476 -- RETURNS : NUMBER
1477 -- MODEL_USAGE_ID is there exists a matching usage for the given p_usage_name.
1478 -- NULL, if either there is no match for the given p_usage_name
1479 -- or if p_usage_name is null;
1480 --
1481 -- Version : Current version 1.0
1482 -- Initial version 1.0
1483 --
1484 -- End of comments
1485 -----------------------------------------------------
1486 /*#
1487 * This API retrieves the model_usage_id for a specified usage name
1488 * @param p_api_version Current version of the API is 1.0
1489 * @param p_usage_name usage for which model_usage_id is to retrieved.
1490 * @param x_return_status status string
1491 * @param x_msg_count number of error messages
1492 * @param x_msg_data string which contains error messages
1493 * @return MODEL_USAGE_ID if there exists a matching usage for the given p_usage_name.
1494 * NULL if either there is no match for the given p_usage_name or if p_usage_name is null
1495 * @rep:scope public
1496 * @rep:compatibility S
1497 * @rep:lifecycle active
1498 * @rep:displayname Get model_usage_id from usage name
1499 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1500 */
1501
1502 FUNCTION usage_id_from_usage_name (p_api_version IN NUMBER
1503 ,p_usage_name IN VARCHAR2
1504 ,x_return_status OUT NOCOPY VARCHAR2
1505 ,x_msg_count OUT NOCOPY NUMBER
1506 ,x_msg_data OUT NOCOPY VARCHAR2)
1507 RETURN NUMBER;
1508
1509 -----------------------------------------------------
1510 -- Start of comments
1511 -- API name : usage_id_from_usage_name
1512 -- Type : Public.
1513 --
1514 -- Function : Returns the MODEL_USAGE_ID for a given NAME(usage name).
1515 --
1516 -- Pre-reqs : None.
1517 -- Parameters :
1518 -- IN : p_api_version IN NUMBER Required
1522 -- user id
1519 -- p_usage_name IN VARCHAR2 Required
1520 -- CZ_MODEL_USAGES.NAME
1521 -- p_user_id IN NUMBER Required
1523 -- p_resp_id IN NUMBER Required
1524 -- responsibility id
1525 -- p_appl_id IN NUMBER Required
1526 -- application id
1527 -- OUT :
1528 -- x_return_status OUT NOCOPY VARCHAR2 Required
1529 -- x_msg_count OUT NOCOPY NUMBER Required
1530 -- x_msg_data OUT NOCOPY VARCHAR2 Required
1531 -- RETURNS : NUMBER
1532 -- MODEL_USAGE_ID is there exists a matching usage for the given p_usage_name.
1533 -- NULL, if either there is no match for the given p_usage_name
1534 -- or if p_usage_name is null;
1535 --
1536 -- Version : Current version 1.0
1537 -- Initial version 1.0
1538 --
1539 -- End of comments
1540 -----------------------------------------------------
1541 /*#
1542 * This API retrieves the model_usage_id for a specified usage name
1543 * @param p_api_version Current version of the API is 1.0
1544 * @param p_usage_name usage for which model_usage_id is to retrieved
1545 * @param x_return_status status string
1546 * @param x_msg_count number of error messages
1547 * @param x_msg_data string which contains error messages
1548 * @param p_user_id user id
1549 * @param p_resp_id responsibility id
1550 * @param p_appl_id application id
1551 * @return MODEL_USAGE_ID if there exists a matching usage for the given p_usage_name.
1552 * NULL if either there is no match for the given p_usage_name or if p_usage_name is null
1553 * @rep:scope public
1554 * @rep:compatibility S
1555 * @rep:lifecycle active
1556 * @rep:displayname Get model_usage_id from usage name
1557 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1558 */
1559
1560 Function usage_id_from_usage_name (
1561 p_api_version IN NUMBER,
1562 p_user_id IN NUMBER,
1563 p_resp_id IN NUMBER,
1564 p_appl_id IN NUMBER,
1565 p_usage_name IN VARCHAR2,
1566 x_return_status OUT NOCOPY VARCHAR2,
1567 x_msg_count OUT NOCOPY NUMBER,
1568 x_msg_data OUT NOCOPY VARCHAR2
1569 )
1570 RETURN NUMBER;
1571
1572 -----------------------------------------------------
1573 /*
1574 * Public API for Model Migration.
1575 * @param p_request_id This is the CZ_MODEL_PUBLICATIONS, MIGRATION_GROUP_ID of the migration request.
1576 * Migration request is created by Developer and contains the list of all models selected
1577 * for Migration from the source's Configurator Repository, target Instance name and
1578 * target Repository Folder.
1579 * @param p_userid Standard parameters required for locking. Represent calling user.
1580 * @param p_respid Standard parameters required for locking. Represent calling responsibility.
1581 * @param p_applid Standard parameters required for locking. Represent calling application.
1582 * @param p_run_id Number identifying the session. If left NULL, the API will generate the number and
1583 * return it in x_run_id.
1584 * @param x_run_id Output parameter containing internally generated session identifier if p_run_id
1585 * was NULL, otherwise equal to p_run_id.
1586 */
1587
1588 PROCEDURE migrate_models(p_api_version IN NUMBER,
1589 p_request_id IN NUMBER,
1590 p_user_id IN NUMBER,
1591 p_resp_id IN NUMBER,
1592 p_appl_id IN NUMBER,
1593 p_run_id IN NUMBER,
1594 x_run_id OUT NOCOPY NUMBER,
1595 x_status OUT NOCOPY VARCHAR2
1596 );
1597 --------------------------API status return codes-----------------------------------------
1598
1599 G_STATUS_SUCCESS constant NUMBER :=0;
1600 G_STATUS_ERROR constant NUMBER :=1;
1601 G_STATUS_WARNING constant NUMBER :=2;
1602
1603 ------------------------------------------------------------------------------------------
1604 -- added by jonatara:bug6375827
1605 -- Start of comments
1606 -- API name : create_publication_request
1607 -- Type : Public
1608 -- Function : Create model publication request
1609 -- Pre-reqs : None.
1610 -- Parameters :
1611 -- IN : p_api_version NUMBER
1612 -- p_model_id NUMBER
1613 -- p_ui_def_id NUMBER
1614 -- p_publication_mode VARCHAR2 Default 'P'
1615 -- p_server_id NUMBER
1616 -- p_appl_id_tbl CZ_PB_MGR.t_ref
1617 -- p_usg_id_tbl CZ_PB_MGR.t_ref - Default -1 ('Any Usage')
1618 -- p_lang_tbl CZ_PB_MGR.t_lang_code - Default 'US'
1619 -- p_start_date DATE - Default cz_utils.epoch_begin
1620 -- p_end_date DATE - Default cz_utils.epoch_end
1621 -- OUT NOCOPY : x_publication_id NUMBER
1622 -- x_return_status VARCHAR2
1623 -- x_msg_count NUMBER
1624 -- x_msg_data VARCHAR2
1625 -- Version : Current version 1.0
1626 -- Initial version 1.0
1627 -- Notes :
1628 --
1629 -- End of comments
1630 /*#
1631 * Create model publication request
1635 * @param p_publication_mode publication mode ( 't' or 'p' ) DEFAULT 'P'
1632 * @param p_api_version api version
1633 * @param p_model_id devl_project_id of model
1634 * @param p_ui_def_id ui_def_id of the UI
1636 * @param p_server_id publication target server id
1637 * @param p_appl_id_tbl Table of application ids
1638 * @param p_usg_id_tbl Table of usage ids DEFAULT -1 (ie., 'Any Usage')
1639 * @param p_lang_tbl Table of language codes DEFAULT 'US'
1640 * @param p_start_date Effective start date Default cz_utils.epoch_begin
1641 * @param p_end_date Effective end date DEFAULT CZ_UTILS.CZ_UTILS.epoch_end
1642 * @param x_publication_id Publication Id created
1643 * @param x_return_status Return status
1644 * @param x_msg_count Message count
1645 * @param x_msg_data (Error) Message
1646 * @rep:scope public
1647 * @rep:lifecycle active
1648 * @rep:displayname Create model publication request
1649 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1650 */
1651 PROCEDURE create_publication_request (
1652 p_api_version IN NUMBER,
1653 p_model_id IN NUMBER,
1654 p_ui_def_id IN NUMBER,
1655 p_publication_mode IN VARCHAR2, -- DEFAULT 'P'
1656 p_server_id IN NUMBER,
1657 p_appl_id_tbl IN CZ_PB_MGR.t_ref,
1658 p_usg_id_tbl IN CZ_PB_MGR.t_ref, -- DEFAULT -1 (ie., 'Any Usage')
1659 p_lang_tbl IN CZ_PB_MGR.t_lang_code, -- DEFAULT 'US'
1660 p_start_date IN DATE, -- DEFAULT CZ_UTILS.epoch_begin
1661 p_end_date IN DATE, -- DEFAULT CZ_UTILS.CZ_UTILS.epoch_end
1662 x_publication_id OUT NOCOPY NUMBER,
1663 x_return_status OUT NOCOPY VARCHAR2,
1664 x_msg_count OUT NOCOPY NUMBER,
1665 x_msg_data OUT NOCOPY VARCHAR2
1666 );
1667
1668 -----------------------------------------------------------------------------
1669 -- Start of comments
1670 -- API name : create_publication_request
1671 -- Type : Public
1672 -- Function : Create model publication request
1673 -- Pre-reqs : None.
1674 -- Parameters :
1675 -- IN : p_api_version NUMBER
1676 -- p_model_id NUMBER
1677 -- p_ui_def_id NUMBER
1678 -- p_publication_mode VARCHAR2 DEFAULT 'P'
1679 -- p_server_id NUMBER
1680 -- p_appl_id_tbl CZ_PB_MGR.t_ref
1681 -- p_usg_id_tbl CZ_PB_MGR.t_ref - Default -1 ( "Any Usage" )
1682 -- p_lang_tbl CZ_PB_MGR.t_lang_code - Default 'US'
1683 -- p_start_date DATE - Default cz_utils.epoch_begin
1684 -- p_end_date DATE - Default cz_utils.epoch_end
1685 -- p_user_id NUMBER
1686 -- p_resp_id NUMBER
1687 -- p_appl_id NUMBER
1688 -- OUT NOCOPY : x_publication_id NUMBER
1689 -- x_return_status VARCHAR2
1690 -- x_msg_count NUMBER
1691 -- x_msg_data VARCHAR2
1692 -- Version : Current version 1.0
1693 -- Initial version 1.0
1694 -- Notes :
1695 --
1696 -- End of comments
1697 /*#
1698 * Create model publication request
1699 * @param p_api_version api version
1700 * @param p_model_id devl_project_id of model
1701 * @param p_ui_def_id ui_def_id of the UI
1702 * @param p_publication_mode publication mode ( 't' or 'p' ) DEFAULT 'P'
1703 * @param p_server_id publication target server id
1704 * @param p_appl_id_tbl Table of application ids
1705 * @param p_usg_id_tbl Table of usage ids DEFAULT -1 (ie., 'Any Usage')
1706 * @param p_lang_tbl Table of language codes DEFAULT 'US'
1707 * @param p_start_date Effective start date Default cz_utils.epoch_begin
1708 * @param p_end_date Effective end date DEFAULT CZ_UTILS.CZ_UTILS.epoch_end
1709 * @param p_user_id Application user id
1710 * @param p_resp_id Responsibility id
1711 * @param p_appl_id Application id
1712 * @param x_publication_id Publication Id created
1713 * @param x_return_status Return status
1714 * @param x_msg_count Message count
1715 * @param x_msg_data (Error) Message
1716 * @rep:scope public
1717 * @rep:lifecycle active
1718 * @rep:displayname Create model publication request
1719 * @rep:category BUSINESS_ENTITY CZ_CONFIG_MODEL
1720 */
1721 PROCEDURE create_publication_request (
1722 p_api_version IN NUMBER,
1723 p_model_id IN NUMBER,
1724 p_ui_def_id IN NUMBER,
1725 p_publication_mode IN VARCHAR2, -- DEFAULT 'P'
1726 p_server_id IN NUMBER,
1727 p_appl_id_tbl IN CZ_PB_MGR.t_ref,
1728 p_usg_id_tbl IN CZ_PB_MGR.t_ref, -- DEFAULT -1 (ie., 'Any Usage')
1729 p_lang_tbl IN CZ_PB_MGR.t_lang_code, -- DEFAULT 'US'
1730 p_start_date IN DATE, -- DEFAULT CZ_UTILS.epoch_begin
1731 p_end_date IN DATE, -- DEFAULT CZ_UTILS.CZ_UTILS.epoch_end
1732 p_user_id IN NUMBER,
1733 p_resp_id IN NUMBER,
1734 p_appl_id IN NUMBER,
1735 x_publication_id OUT NOCOPY NUMBER,
1736 x_return_status OUT NOCOPY VARCHAR2,
1737 x_msg_count OUT NOCOPY NUMBER,
1738 x_msg_data OUT NOCOPY VARCHAR2
1739 );
1740 -----------------------------------------------------------------------------
1741 END CZ_modelOperations_pub;
[Home] [Help]