Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

vm/vms.h File Reference

#include <unidefs.h>
#include <vm/libvm_exports.h>
#include <vm/libvm_undef.h>

Go to the source code of this file.

Defines

Functions

Define Documentation

#define VMS_external_id_size_c   32

Definition at line 37 of file vms.h.

Function Documentation

VM_API int VMS_add_bidpackage_lineitems ( tag_t  bidpackagerev,
int  no_of_lineitems,
tag_t *  lineitems 
)

ITK function to add a list of BidPackageLineItem to BidPackageRevsision

VM_API int VMS_add_lineitemcc ( tag_t  licc_tag,
tag_t  bpl_tag 
)

ITK function to add a LineItemConfigurationContext to BidPackageLineItem

VM_API int VMS_add_mfg_part_to_comm_part ( const char *  idfrid,
const char *  idfrname,
tag_t  commercialpart,
tag_t  commercialpartrev,
tag_t  manufacturerpart,
tag_t  vendor 
)

ITK function to add a ManufacturerPart to a CommercialPart

VM_API int VMS_add_Quote ( tag_t  quote,
tag_t  bpli 
)

ITK function to add a Quote to bidpackagelineitem as a "TC_part_quote_rel" relation

VM_API int VMS_add_vendor_roles ( tag_t  vrev,
int  no_of_roles,
tag_t *  vroles 
)

ITK function to add a list of VendorRoles to a VendorRevision

VM_API int VMS_change_vendor ( tag_t  old_vendor_to_change,
tag_t *  vendor_parts,
tag_t  new_vendor,
int  n_vparts_supplied,
int *  n_vparts,
char ***  old_part_ids,
char ***  new_part_ids,
char ***  notes 
)

ITK function for change Vendor

Parameters:
old_vendor_to_change  (I) Old vendor to change
vendor_parts  (I) Old vendor parts to change
new_vendor  (I) New vendor to associate
n_vparts_supplied  (I) n_vparts_supplied
n_vparts  (O) Number of values returned
old_part_ids  (OF) n_vparts of old_part_ids
new_part_ids  (OF) n_vparts of new_part_ids
notes  (OF) n_vparts of notes

VM_API int VMS_copy_bidpackage ( tag_t  old_rev,
const char *  new_bpckg_id,
const char *  new_rev_id,
tag_t *  new_bpckg,
tag_t *  new_rev 
)

ITK function to Copy a BidPackage

VM_API int VMS_copy_bidpackage_rev ( tag_t  old_rev,
const char *  new_rev_id,
tag_t *  new_rev 
)

ITK function to Copy a BidPackageRevision

VM_API int VMS_copy_vendor ( tag_t  old_rev,
const char *  new_vendor_id,
const char *  new_rev_id,
tag_t *  new_vendor,
tag_t *  new_rev 
)

ITK function to Copy a Vendor

VM_API int VMS_copy_vendor_rev ( tag_t  old_rev,
const char *  new_rev_id,
tag_t *  new_rev 
)

ITK function to Copy a VendorRevision

VM_API int VMS_create_bidpackage ( const char *  bpId,
const char *  name,
const char *  bprevId,
tag_t *  new_bp,
tag_t *  new_bp_rev 
)

ITK function to create a BidPackage

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_create_bidpackage_lineitem ( const char *  name,
const char *  desc,
tag_t  part,
tag_t  cc,
double  quantity,
tag_t *  new_bpl_tag 
)

ITK function to create a BidPackageLineItem

VM_API int VMS_create_bidpackage_lineitem_with_type ( const char *  name,
const char *  desc,
tag_t  part,
tag_t  cc,
double  quantity,
const char *  bpli_type_name,
tag_t *  new_bpl_tag 
)

ITK function to create a BidPackageLineItem of specified type.

VM_API int VMS_create_bidpackage_rev ( tag_t  bpckg_tag,
const char *  rev_id,
tag_t *  rev 
)

ITK function to create a BidPackageRevision

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_create_bidpackage_with_masters ( const char *  bpId,
const char *  name,
const char *  type_name,
const char *  bprevId,
tag_t  bp_master_tag,
tag_t  bp_rev_master_tag,
tag_t *  new_bp,
tag_t *  new_bp_rev 
)

ITK function to create a BidPackage with Masters

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_create_commercial_part ( const char *  partId,
const char *  desc,
const tag_t  uom,
const char *  partName,
const char *  typeName,
const char *  revId,
const logical  isDesignReq,
const int  makebuy,
tag_t  vendor,
tag_t *  commercialpart,
tag_t *  commercialpartrev 
)

ITK function to create a CommercialPart

VM_API int VMS_create_lineitemcc ( const char *  name,
const char *  desc,
tag_t  rev_rule,
tag_t  variant_rule,
tag_t  closure_rule,
tag_t  view_type_tag,
tag_t *  licc_tag 
)

ITK function to create a LineItemConfigurationContext

VM_API int VMS_create_manufacturer_part ( const char *  partId,
const char *  desc,
const tag_t  uom,
const char *  partName,
const char *  typeName,
const char *  revId,
const logical  isDesignReq,
const int  makebuy,
tag_t  vendor,
tag_t  commercialpart,
tag_t  commercialpartrev,
tag_t *  manufacturerpart,
tag_t *  manufacturerpartrev 
)

ITK function to create a ManufacturerPart

VM_API int VMS_create_manufacturer_part_with_masters ( const char *  partId,
const char *  desc,
const tag_t  uom,
const char *  partName,
const char *  typeName,
const char *  revId,
const logical  isDesignReq,
const int  makebuy,
tag_t  vendor,
tag_t  commercialpart,
tag_t  commercialpartrev,
tag_t  mfgpartmaster,
tag_t  mfgpartrevmaster,
tag_t *  manufacturerpart,
tag_t *  manufacturerpartrev 
)

ITK function to create a ManufacturerPart with Master Forms

VM_API int VMS_create_quote ( const char *  name,
const char *  desc,
tag_t *  quote_tag 
)

ITK function to crete a Quote

VM_API int VMS_create_vendor ( const char *  vendorId,
const char *  name,
const char *  revId,
int  no_of_roles,
tag_t *  vendor_role,
tag_t *  new_vendor,
tag_t *  new_vendor_rev 
)

ITK function to create a new Vendor

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_create_vendor_rev ( tag_t  vendor,
const char *  rev_id,
int  no_of_roles,
tag_t *  vendor_role,
tag_t *  rev 
)

ITK function to create a VendorRevision for a Vendor

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_create_vendor_role ( const char *  role_name,
const char *  role_desc,
tag_t *  vendor_role 
)

ITK function to create a VendorRole

VM_API int VMS_create_vendor_with_masters ( const char *  vendorId,
const char *  name,
const char *  revId,
const char *  type_name,
int  no_of_roles,
tag_t *  vendor_role,
tag_t  vendor_master_tag,
tag_t  vendor_rev_master_tag,
tag_t *  new_vendor,
tag_t *  new_vendor_rev 
)

ITK function to create a new Vendor with Master forms

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_create_vendor_with_type ( const char *  vendorId,
const char *  name,
const char *  revId,
const char *  type_name,
int  no_of_roles,
tag_t *  vendor_role,
tag_t *  new_vendor,
tag_t *  new_vendor_rev 
)

ITK function to create a new Vendor with a specified type

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

VM_API int VMS_delete_bidpackage ( tag_t  bidpckg  ) 

ITK function to delete a BidPackage

VM_API int VMS_delete_bidpackage_rev ( tag_t  bidpckgrev  ) 

ITK function to delete a BidPackageRevision

VM_API int VMS_delete_vendor ( tag_t  vendor  ) 

ITK function to delete a Vendor

VM_API int VMS_delete_vendor_rev ( tag_t  vrev  ) 

ITK function to delete a VendorRevision

VM_API int VMS_find_vendor ( const char *  vendorId,
tag_t *  ventag 
)

ITK function to find a Vendor

VM_API int VMS_get_bidpackage_lineitems ( tag_t  bidpackagerev,
int *  no_of_lineitems,
tag_t **  lineitems 
)

ITK function to get a list of BidPackageLineItems for a BidPackageRevision

Parameters:
bidpackagerev  (I) Tag of the selected bidpackage revision
no_of_lineitems  (O) number of lineitems for the bidpackage revision
lineitems  (OF) no_of_lineitems Array of related lineitems

VM_API int VMS_get_ID_with_Context ( const char *  objectID,
const char *  contextID,
char **  itemID,
tag_t *  existingObject 
)

ITK function to generate an item_id based on the input IDs. It also returns an object tag if there is a pre-existing item with that ID.

VM_API int VMS_get_vendor_parts_w_sel_rule ( tag_t  commPartRev,
const char *  conditionName,
int *  tagCount,
tag_t **  vpTags,
tag_t **  relTags 
)

Parameters:
commPartRev  (I) Input commercial part revision
conditionName  (I) name of condition to use to filter vendor part (may be NULL)
tagCount  (O) number of vendor parts
vpTags  (OF) tagCount related vendor parts
relTags  (OF) tagCount relations

VM_API int VMS_get_vendor_roles ( tag_t  vrev,
int *  no_of_roles,
tag_t **  vroles 
)

ITK function to get a list of VendorRoles for a VendorRevision

Parameters:
vrev  (I) Tag of the selected vendor revision
no_of_roles  (O) number of vendor roles for the vendor revision
vroles  (OF) no_of_roles Array of related vendor roles

VM_API int VMS_get_vpsr_condition_entries ( int *  condCount,
tag_t **  condTags 
)

Parameters:
condCount  (O) number of conditions found
condTags  (OF) condCount Array of conditions

VM_API int VMS_init_module ( int *  decision  ) 

ITK function to initialize all classes of Vendor Management Module.

Deprecated:
This function is deprecated and will be removed from Tc12. Please refer to the documentation on VMS_init_module for more information.

VM_API int VMS_remove_bidpackage_lineitems ( tag_t  bidpackagerev,
int  no_of_lineitems,
tag_t *  lineitem 
)

ITK function to remove a list of BidPackageLineItems for a BidPackageRevision

VM_API int VMS_remove_vendor_roles ( tag_t  vrev,
int  no_of_roles,
tag_t *  vroles 
)

ITK function to remove a list of VendorRoles from a VendorRevision