ITK Function Reference
(V10000.1.0.60_20160308.00)
vms.h
Go to the documentation of this file.
1 /*=======================================================================================
2 
3  Copyright (c) 2007 UGS Corporation
4  Unpublished - All rights reserved
5 
6 =========================================================================================
7 
8 File description:
9 
10  Filename: vms.h
11  Module : Vendor Management (vm)
12  Description:
13 
14  This file contains declaration of ITK functions corresponding to Vendor,
15  BidPackage classes for Vendor Management Module.
16 
17 
18 =========================================================================================
19  Date Name Description of Change
20  23-Feb-2007 M.Ram Narsimhamurty Initial Version
21  23-Feb-2007 Ram Kishore Initial Version
22  15-Apr-2007 Ram Kishore Added prototypes for Vendor Part APIs
23  04-Apr-2008 Ram Kishore Added prototypes for Vendor,BidPackage,ManufacturerPart
24  APIs for creation with master forms
25  14-jun-2008 Srinivas Pendyala Added extra param to VMS_change_vendor to fix webitkbindings APIs for creation with master forms
26  11-Aug-2008 Srinivas Pendyala Add new API VMS_create_bidpackage_lineitem_with_type
27  23-Feb-2009 Chris Scheffer Added VMS_create_vendor_with_type
28  20-Jun-2012 godbole Changes to deprecate VMS_init_module
29 $HISTORY$
30 =======================================================================================*/
31 
32 #ifndef VMS_H
33 #define VMS_H
34 
35 #include <unidefs.h>
36 #include <vm/libvm_exports.h>
37 #define VMS_external_id_size_c 32
38 
39 #ifdef __cplusplus
40  extern "C"{
41 #endif
42 
50 extern VM_API int VMS_init_module( int* decision );
51 
57 extern VM_API int VMS_create_vendor(
58  const char *vendorId, /* <I> */
59  const char *name, /* <I> */
60  const char *revId, /* <I> */
61  int no_of_roles, /* <I> */
62  tag_t *vendor_role, /* <I> */
63  tag_t *new_vendor, /* <O> */
64  tag_t *new_vendor_rev /* <O> */
65  );
66 
67 
73 extern VM_API int VMS_create_vendor_with_type(
74  const char *vendorId, /* <I> */
75  const char *name, /* <I> */
76  const char *revId, /* <I> */
77  const char *type_name, /* <I> */
78  int no_of_roles, /* <I> */
79  tag_t *vendor_role, /* <I> */
80  tag_t *new_vendor, /* <O> */
81  tag_t *new_vendor_rev /* <O> */
82  );
83 
84 
90 extern VM_API int VMS_create_vendor_with_masters(
91  const char *vendorId, /* <I> */
92  const char *name, /* <I> */
93  const char *revId, /* <I> */
94  const char *type_name, /* <I> */
95  int no_of_roles, /* <I> */
96  tag_t *vendor_role, /* <I> */
97  tag_t vendor_master_tag, /* <I> */
98  tag_t vendor_rev_master_tag, /* <I> */
99  tag_t *new_vendor, /* <O> */
100  tag_t *new_vendor_rev /* <O> */
101  );
102 
107 extern VM_API int VMS_find_vendor(
108  const char *vendorId, /* <I> */
109  tag_t* ventag /* <O> */
110  );
111 
117 extern VM_API int VMS_create_vendor_rev(
118  tag_t vendor , /* <I> */
119  const char *rev_id, /* <I> */
120  int no_of_roles, /* <I> */
121  tag_t *vendor_role, /* <I> */
122  tag_t *rev /* <O> */
123  );
124 
129 extern VM_API int VMS_create_vendor_role(
130  const char *role_name, /* <I> */
131  const char *role_desc, /* <I> */
132  tag_t *vendor_role /* <O> */
133  );
134 
139 extern VM_API int VMS_add_vendor_roles(
140  tag_t vrev, /* <I> */
141  int no_of_roles, /* <I> */
142  tag_t* vroles /* <I> */
143  );
144 
149 extern VM_API int VMS_get_vendor_roles(
150  tag_t vrev,
151  int* no_of_roles,
152  tag_t** vroles
153  );
154 
159 extern VM_API int VMS_remove_vendor_roles(
160  tag_t vrev, /* <I> */
161  int no_of_roles, /* <I> */
162  tag_t* vroles /* <I> */
163  );
164 
168 /*-----------------------------------------------------------------------------*/
169 
170 extern VM_API int VMS_copy_vendor(
171  tag_t old_rev, /* <I> */
172  const char *new_vendor_id, /* <I> */
173  const char *new_rev_id, /* <I> */
174  tag_t *new_vendor, /* <O> */
175  tag_t *new_rev /* <O> */
176  );
177 
181 /*-----------------------------------------------------------------------------*/
182 
183 extern VM_API int VMS_copy_vendor_rev(
184  tag_t old_rev, /* <I> */
185  const char *new_rev_id, /* <I> */
186  tag_t *new_rev /* <O> */
187  );
188 
193 extern VM_API int VMS_delete_vendor(
194  tag_t vendor /* <I> */
195  );
196 
201 extern VM_API int VMS_delete_vendor_rev(
202  tag_t vrev /* <I> */
203  );
204 
210 extern VM_API int VMS_create_bidpackage(
211  const char *bpId, /* <I> */
212  const char *name, /* <I> */
213  const char *bprevId, /* <I> */
214  tag_t *new_bp, /* <O> */
215  tag_t *new_bp_rev /* <O> */
216  );
217 
218 
224 extern VM_API int VMS_create_bidpackage_with_masters(
225  const char *bpId, /* <I> */
226  const char *name, /* <I> */
227  const char *type_name, /* <I> */
228  const char *bprevId, /* <I> */
229  tag_t bp_master_tag, /* <I> */
230  tag_t bp_rev_master_tag, /* <I> */
231  tag_t *new_bp, /* <O> */
232  tag_t *new_bp_rev /* <O> */
233  );
234 
240 extern VM_API int VMS_create_bidpackage_rev(
241  tag_t bpckg_tag, /* <I> */
242  const char *rev_id, /* <I> */
243  tag_t *rev /* <O> */
244  );
245 
249 /*-----------------------------------------------------------------------------*/
250 
251 extern VM_API int VMS_copy_bidpackage(
252  tag_t old_rev, /* <I> */
253  const char *new_bpckg_id, /* <I> */
254  const char *new_rev_id, /* <I> */
255  tag_t *new_bpckg, /* <O> */
256  tag_t *new_rev /* <O> */
257  );
258 
262 /*-----------------------------------------------------------------------------*/
263 
264 extern VM_API int VMS_copy_bidpackage_rev(
265  tag_t old_rev, /* <I> */
266  const char *new_rev_id, /* <I> */
267  tag_t *new_rev /* <O> */
268  );
269 
270 
275 extern VM_API int VMS_create_bidpackage_lineitem(
276  const char *name, /* <I> */
277  const char *desc, /* <I> */
278  tag_t part, /* <I> */
279  tag_t cc, /* <I> */
280  double quantity, /* <I> */
281  tag_t *new_bpl_tag /* <O> */
282  );
283 
288 extern VM_API int VMS_create_bidpackage_lineitem_with_type(
289  const char *name, /* <I> */
290  const char *desc, /* <I> */
291  tag_t part, /* <I> */
292  tag_t cc, /* <I> */
293  double quantity, /* <I> */
294  const char* bpli_type_name, /* <I> */
295  tag_t *new_bpl_tag /* <O> */
296  );
297 
302 extern VM_API int VMS_add_bidpackage_lineitems(
303  tag_t bidpackagerev, /* <I> */
304  int no_of_lineitems, /* <I> */
305  tag_t *lineitems /* <I> */
306  );
311 extern VM_API int VMS_remove_bidpackage_lineitems(
312  tag_t bidpackagerev, /* <I> */
313  int no_of_lineitems, /* <I> */
314  tag_t* lineitem /* <I> */
315  );
316 
322 extern VM_API int VMS_get_bidpackage_lineitems(
323  tag_t bidpackagerev,
324  int* no_of_lineitems,
325  tag_t** lineitems
326  );
327 
332 extern VM_API int VMS_delete_bidpackage(
333  tag_t bidpckg /* <I> */
334  );
335 
340 extern VM_API int VMS_delete_bidpackage_rev(
341  tag_t bidpckgrev /* <I> */
342  );
343 
348 extern VM_API int VMS_create_lineitemcc(
349  const char* name, /* <I> */
350  const char* desc, /* <I> */
351  tag_t rev_rule, /* <I> */
352  tag_t variant_rule, /* <I> */
353  tag_t closure_rule, /* <I> */
354  tag_t view_type_tag, /* <I> */
355  tag_t *licc_tag /* <O> */
356  );
357 
362 extern VM_API int VMS_add_lineitemcc(
363  tag_t licc_tag, /* <I> */
364  tag_t bpl_tag /* <I> */
365  );
366 
371 extern VM_API int VMS_create_quote(
372  const char *name, /* <I> */
373  const char *desc, /* <I> */
374  tag_t *quote_tag /* <O> */
375  );
376 
381 extern VM_API int VMS_add_Quote(
382  tag_t quote, /* <I> */
383  tag_t bpli /* <I> */
384  );
385 
390 extern VM_API int VMS_create_commercial_part(
391  const char *partId, /* <I> */
392  const char *desc, /* <I> */
393  const tag_t uom, /* <I> */
394  const char *partName, /* <I> */
395  const char *typeName, /* <I> */
396  const char *revId, /* <I> */
397  const logical isDesignReq, /* <I> */
398  const int makebuy, /* <I> */
399  tag_t vendor, /* <I> */
400  tag_t *commercialpart, /* <O> */
401  tag_t *commercialpartrev /* <O> */
402  );
403 
408 extern VM_API int VMS_create_manufacturer_part(
409  const char *partId, /* <I> */
410  const char *desc, /* <I> */
411  const tag_t uom, /* <I> */
412  const char *partName, /* <I> */
413  const char *typeName, /* <I> */
414  const char *revId, /* <I> */
415  const logical isDesignReq, /* <I> */
416  const int makebuy, /* <I> */
417  tag_t vendor , /* <I> */
418  tag_t commercialpart , /* <I> */
419  tag_t commercialpartrev , /* <I> */
420  tag_t *manufacturerpart, /* <O> */
421  tag_t *manufacturerpartrev /* <O> */
422  );
423 
428 extern VM_API int VMS_create_manufacturer_part_with_masters(
429  const char *partId, /* <I> */
430  const char *desc, /* <I> */
431  const tag_t uom, /* <I> */
432  const char *partName, /* <I> */
433  const char *typeName, /* <I> */
434  const char *revId, /* <I> */
435  const logical isDesignReq, /* <I> */
436  const int makebuy, /* <I> */
437  tag_t vendor , /* <I> */
438  tag_t commercialpart , /* <I> */
439  tag_t commercialpartrev , /* <I> */
440  tag_t mfgpartmaster , /* <I> */
441  tag_t mfgpartrevmaster , /* <I> */
442  tag_t *manufacturerpart, /* <O> */
443  tag_t *manufacturerpartrev /* <O> */
444  );
445 
450 extern VM_API int VMS_add_mfg_part_to_comm_part(
451  const char *idfrid, /* <I> */
452  const char *idfrname, /* <I> */
453  tag_t commercialpart, /* <I> */
454  tag_t commercialpartrev , /* <I> */
455  tag_t manufacturerpart, /* <I> */
456  tag_t vendor /* <I> */
457  );
458 
459 
465 extern VM_API int VMS_get_ID_with_Context
466 (
467  const char *objectID, /* <I> */
468  const char *contextID, /* <I> */
469  char **itemID, /* <O> */
470  tag_t *existingObject /* <O> */
471 );
472 
473 extern VM_API int VMS_get_vpsr_condition_entries(
474  int* condCount,
475  tag_t** condTags
476  );
477 
478 
479 
480 extern VM_API int VMS_get_vendor_parts_w_sel_rule(
481  tag_t commPartRev,
482  const char *conditionName,
483  int *tagCount,
484  tag_t **vpTags,
485  tag_t **relTags
486  );
487 
491 extern VM_API int VMS_change_vendor(
492  tag_t old_vendor_to_change,
493  tag_t* vendor_parts,
494  tag_t new_vendor,
495  int n_vparts_supplied,
496  int* n_vparts,
497  char*** old_part_ids,
498  char*** new_part_ids,
499  char*** notes
500  );
501 
512 extern VM_API int VMS_relate_vendor_part_to_comm_part(
513  tag_t comm_part,
514  tag_t vendor_part,
515  const char* pref_status,
516  tag_t* representation_relation
517  );
518 
519 #ifdef __cplusplus
520 }
521 #endif
522 
523 #include <vm/libvm_undef.h>
524 
525 #endif