Package com.ptc.windchill.suma.axl

Interface AXLService

All Known Implementing Classes:
StandardAXLService
@RemoteInterface public interface AXLService
Provides a set of client APIs.

Supported API: true

Extendable: false

  • Method Details

    • addAML

      AXLEntry addAML(AXLContext context, WTPart oemPart, VendorPart vendorPart, ManufacturerPart manufacturerPart, AXLPreference amlPreference) throws WTException
      Adds an AML entry under the following two circumstances:
      1. When vendor part is not specified (null), creates a new AML entry with the context, oem part, and manufacturer part.
      2. When vendor part is specified (not null), adds manufacture part to an existing AVL entry that has the context, OEM part, and vendor part.


      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      vendorPart - an optional vendor part. If the vendor part is specified, an AVL with the context, OEM part, and vendor part must exist.
      manufacturerPart - a manufacturer part that is being added
      amlPreference - a manufacturer part preference
      Throws:
      WTException - If there is another entry with the context, OEM part, and manufacturer part.

      If the vendor part is specified but an attempt to find an existing entry with the context, OEM part, and vendor part has failed.

    • addAVL

      AXLEntry addAVL(AXLContext context, WTPart oemPart, ManufacturerPart manufacturerPart, VendorPart vendorPart, AXLPreference avlPreference) throws WTException
      Adds an AVL with the specified context, OEM part, and vendor part. The behavior of this method depends upon the optional manufacturer part argument:
      1. When no manufacturer part is specified (null), creates a new AML with the context, OEM part, and manufacturer part.
      2. When a manufacturer part is specified, either creates a new AXL with the context, OEM part, manufacturer part, and vendor part or modifies an existing AML by adding the vendor part depending on whether AXLs exist with the context, OEM part, and manufacturer part.


      Supported API: true
      Parameters:
      context - an AXLContext
      oemPart - an OEM part
      manufacturerPart - a manufacturer part to which the vendor part is being added.
      vendorPart - a vendor part to be added
      avlPreference - an AVL preference
      Throws:
      WTException - If another entry with the context, OEM part, and vendor part exists.

      If the optional manufacturer part is specified but an attempt to find AMLs with the context, OEM part, and manufacturer part has failed.

    • removeAML

      void removeAML(AXLContext context, WTPart oemPart, ManufacturerPart manufacturerPart) throws WTException
      Removes all AXL that are related to the specified OEM part, manufacturer part and context.

      Supported API: true
      Parameters:
      context - an AXL context.
      oemPart - an OEM part
      manufacturerPart - the manufacturer part being removed from AML
      Throws:
      WTException

    • removeAML

      void removeAML(AXLContext context, WTPart oemPart, com.ptc.windchill.suma.part.ManufacturerPartMaster manufacturerPartMaster) throws WTException
      Removes all AXL that are related to the specified OEM part, manufacturer part master and context.

      Supported API: true
      Parameters:
      context - an AXL context.
      oemPart - an OEM part
      manufacturerPartMaster - the manufacturer part master being removed from AML
      Throws:
      WTException

    • removeAVL

      void removeAVL(AXLContext context, WTPart oemPart, VendorPart vendorPart) throws WTException
      Removes a vendor part from the AXL for the specified OEM part and context. Checks if the matching entry contains a manufacturer part. If it does, also check if this is the only entry that mathces the OEM part and the manufacturer part - if it is, update the record otherwise remove the record.

      Supported API: true
      Parameters:
      context - an AXL context.
      oemPart - an OEM part
      vendorPart - the vendor part to be removed from AVL
      Throws:
      WTException

    • removeAXL

      void removeAXL(WTSet entries) throws WTException
      Removes a set of AXL entries. Note that the set of entries must belong to the same OEM part under the same context.

      Supported API: true
      Parameters:
      entries - A collection of AXLEntry
      Throws:
      WTException

    • getAXL

      WTCollection getAXL(WTPart oem_part, AXLContext context) throws WTException
      Retrieves all AML/AVL entries for the specified OEM part under the specified sourcing context.

      Supported API: true
      Parameters:
      oem_part - An OEM part. Cannot be null.
      context - A sourcing context. Cannot be null.
      Returns:
      WTCollection
      Throws:
      WTException

    • getAML

      WTCollection getAML(WTPart oem_part, AXLContext context) throws WTException
      Retrieves all AML entries for the specified OEM part under the specified sourcing context. This API removes duplication - for example, if there are multiple entries for the same manufacturer part, only one entry related to that manufacturer part will be returned.

      Supported API: true
      Parameters:
      oem_part - an OEM part
      context - a sourcing context
      Returns:
      WTCollection
      Throws:
      WTException

    • getAVL

      WTCollection getAVL(WTPart oem_part, AXLContext context, com.ptc.windchill.suma.part.ManufacturerPartMaster mfr_part_master) throws WTException
      Retrieves all AVL entries for the specified OEM part , sourcing context, and manufacturer part master.

      Supported API: true
      Parameters:
      oem_part - an OEM part
      context - a sourcing context
      mfr_part_master - a manufacturer part master
      Returns:
      WTCollection
      Throws:
      WTException

    • getManufacturerParts

      WTCollection getManufacturerParts(AXLContext context, WTPart oemPart) throws WTException
      Returns all manufacturer parts for the specified context and OEM part. If context is null, returns all related manufacturer parts regardless of sourcing context.

      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      Returns:
      WTCollection a collection of manufacturer parts
      Throws:
      WTException

    • getVendorParts

      WTCollection getVendorParts(AXLContext context, WTPart oemPart) throws WTException
      Returns all vendor parts for the specified context and OEM part. If context is null, returns all related vendor parts regardless of sourcing context.

      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      Returns:
      WTCollection a collection of vendor parts
      Throws:
      WTException

    • getVendorParts

      WTCollection getVendorParts(AXLContext context, WTPart oemPart, ManufacturerPart manufacturerPart) throws WTException
      Returns all vendor parts that are related to the specified context, OEM part, and manufacturer part. If context is null, returns all related vendor parts regardless of sourcing context.

      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      manufacturerPart - a manufacturer part
      Returns:
      a collection of vendor parts that meet the search criteria
      Throws:
      WTException

    • getVendorParts

      WTCollection getVendorParts(AXLEntry aml) throws WTException
      Returns all vendor parts for the combination of sourcing context, oem part, and manufacturer part as defined in the AML.

      Supported API: true
      Parameters:
      aml -
      Returns:
      WTCollection
      Throws:
      WTException

    • getSupplierParts

      WTCollection getSupplierParts(AXLContext context, WTPart oemPart) throws WTException
      Returns all supplier parts for the specified context and OEM part.

      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      Returns:
      a collection of related manufacturer parts and vendor parts
      Throws:
      WTException

    • addAVL

      AXLEntry addAVL(AXLContext context, WTPart oemPart, com.ptc.windchill.suma.part.ManufacturerPartMaster manufacturerPartMaster, com.ptc.windchill.suma.part.VendorPartMaster vendorPartMaster, AXLPreference avlPreference) throws WTException
      Adds an AVL by adding a vendor part to a manufacturer part. The assumption is that there are AML/AXL exist for the context, OEM part, and manufacturer part. Exception will be thrown otherwise. If the optional manufacturer part is specified, it will attempt to find existing AMLs. It there is one AML without vendor part, the AML will be updated with the vendor part and avl preference info. If there are multiple AXLs exist, a new AXL will be created. Exception will be thrown if nothing is found.

      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      manufacturerPartMaster - a manufacturer part master (optional)
      vendorPartMaster - a vendor part master
      avlPreference - an AVL preference
      Returns:
      AXLEntry
      Throws:
      WTException

    • addAVL

      AXLEntry addAVL(AXLContext context, WTPart oemPart, com.ptc.windchill.suma.part.ManufacturerPartMaster manufacturerPartMaster, com.ptc.windchill.suma.part.VendorPartMaster vendorPartMaster, AXLPreference avlPreference, AXLEntry sourceEntry) throws WTException
      Adds an AVL by adding a vendor part to a manufacturer part. The assumption is that there are AML/AXL exist for the context, OEM part, and manufacturer part. Exception will be thrown otherwise. If the optional manufacturer part is specified, it will attempt to find existing AMLs. It there is one AML without vendor part, the AML will be updated with the vendor part and avl preference info. If there are multiple AXLs exist, a new AXL will be created. Exception will be thrown if nothing is found. Also, client can specify source AXLEntry so that the new AXLEntry will be populated with the soft attributes information from the supplied AXLEntry.
      Specifying source AXLEntry is useful when you want to have newly created AVL with soft attributes information from already existing AVL. e.g. Saving AVL to another context using "Save As" action.

      Supported API: true
      Parameters:
      context - an AXL context
      oemPart - an OEM part
      manufacturerPartMaster - a manufacturer part master (optional)
      vendorPartMaster - a vendor part master
      avlPreference - an AVL preference
      sourceEntry - Source AXLEntry whose Soft attributes information will populated to the new AXLEntry. If null then creates brand new AXLEntry.
      Returns:
      AXLEntry
      Throws:
      WTException

    • removeAVL

      void removeAVL(AXLContext context, WTPart oemPart, com.ptc.windchill.suma.part.VendorPartMaster vendorPartMaster) throws WTException
      Removes a vendor part from the AXL for the specified OEM part and context. Checks if the matching entry contains a manufacturer part. If it does, also check if this is the only entry that matches the OEM part and the manufacturer part - if it is, update the record otherwise remove the record.

      Supported API: true
      Parameters:
      context - an AXL context.
      oemPart - an OEM part
      vendorPartMaster - the vendor part to be removed from AVL
      Throws:
      WTException