Package com.ptc.windchill.enterprise.part.service

Interface ReplacementService

@RemoteInterface public interface ReplacementService
Service class used for dispatching events and provides APIs for create, find and remove operations for Alternate and Substitute links.

Supported API: true

Extendable: false

  • Method Details

    • getAllExistingSubstitutesFor

      WTCollection getAllExistingSubstitutesFor(WTPartUsageLink substituteFor) throws WTException, RemoteException
      Returns all substitutes related to the given usage link

      Supported API: true
      Parameters:
      substituteFor - usage link for which substitutes are desired
      Returns:
      WTCollection of Substitute Links
      Throws:
      WTException
      RemoteException
      See Also:

    • getExistingSubstitutes

      WTPartSubstituteLink getExistingSubstitutes(WTPartUsageLink substituteFor, WTPartMaster substitute) throws WTException, RemoteException
      Returns substitute related to the given usage link and substitute part master

      Supported API: true
      Parameters:
      substituteFor - usage link for which substitutes are desired
      Susbtitute - substitute part master
      Returns:
      SubstituteLink
      Throws:
      WTException
      RemoteException
      See Also:

    • getAllExistingAlternatesFor

      WTCollection getAllExistingAlternatesFor(WTPartMaster alternateFor) throws WTException, RemoteException
      Returns all alternates related to the given part master

      Supported API: true
      Parameters:
      alternateFor - Part Master for which alternates are desired
      Returns:
      WTCollection of Alternate Links
      Throws:
      WTException
      RemoteException
      See Also:

    • getExistingAlternates

      WTPartAlternateLink getExistingAlternates(WTPartMaster alternateFor, WTPartMaster alternate) throws WTException, RemoteException
      Returns alternate related to the given part master and given alternate part master

      Supported API: true
      Parameters:
      alternateFor - Part Master for which alternates are desired
      Alternate - Alternate Part Master
      Returns:
      WTPartAlternateLink
      Throws:
      WTException
      RemoteException
      See Also:

    • deleteAlternateLinkFor

      boolean deleteAlternateLinkFor(WTPartMaster alternateFor, WTPartMaster alternate) throws WTException
      Deletes alternate associated with given part master and alternate part master

      Supported API: true
      Parameters:
      alternateFor - Part Master for which alternate to be deleted
      alternate - Alternate Part Master
      Returns:
      true if deletion is successful
      Throws:
      WTException
      See Also:

    • deleteAllAlternateLinksFor

      boolean deleteAllAlternateLinksFor(WTPartMaster alternateFor) throws WTException
      Deletes all alternates associated with given part master.

      Supported API: true
      Parameters:
      alternateFor - PartMaster for which alternates to be deleted
      Returns:
      true if deletion is successful
      Throws:
      WTException
      See Also:

    • deleteSubstituteLinkFor

      boolean deleteSubstituteLinkFor(WTPartUsageLink substituteFor, WTPartMaster substitute) throws WTException
      Deletes substitute related to the given part usage and substitute.

      Supported API: true
      Parameters:
      substituteFor - usage link for which substitutes to be deleted
      Substitute - substitute part master
      Returns:
      true if deletion is successful
      Throws:
      WTException
      See Also:

    • deleteAllSubstituteLinksFor

      boolean deleteAllSubstituteLinksFor(WTPartUsageLink substituteFor) throws WTException
      Deletes all substitutes associated to the given part usage.

      Supported API: true
      Parameters:
      substituteFor - usage link for which substitutes to be deleted
      Returns:
      true if deletion is successful
      Throws:
      WTException
      See Also:

    • createAlternateLink

      WTCollection createAlternateLink(WTPartMaster alternateFor, WTPartMaster alternate, Boolean oneway, Map<String,Object> attributeMap) throws WTException
      Creates alternate links for given data

      Supported API: true
      Parameters:
      alternateFor - The part for which alternate needs to be created.
      alternate - The alternate part.
      attributeMap - Provide values for IBAs, where the key represents the internal name of the IBA (String), and the value represents the value of the IBA. If the one-way parameter is set to false, the IBA values will be applied to both links
      oneWay - If true, it indicates that a link will be one-way, resulting in the creation of only one link. If false, the link will be two-way, resulting in the creation of two links, with one serving as an alternate for the other and vice versa.
      Returns:
      WTCollection it will return single link if the oneway value is true otherwise it will return two links
      Throws:
      WTException
      See Also:

    • createSubstituteLink

      WTPartSubstituteLink createSubstituteLink(WTPartUsageLink substituteFor, WTPartMaster substitute, SubstituteQuantity substituteQuantity, String referenceDesignator, Map<String,Object> attributeMap) throws WTException
      Creates a substitute link for the given data. This method will set the values of the SubstituteQuantity and ReferenceDesignator if the preference named 'Enable quantity and reference designators for substitute parts' is set to true and the quantity amount is greater than zero.

      Supported API: true
      Parameters:
      substituteFor - The part for which substituteF needs to be created.
      substitute - The substitute part.
      substituteQuantity - The concept of substitute quantity as an
      invalid reference 
      #amount
      and a QuantityUnit (unit of measure).
      referenceDesignator - The Reference Designator value of the WTPartSubstituteLink
      attributeMap - Provide values for IBAs, where the key represents the internal name of the IBA (String), and the value represents the value of the IBA.
      Returns:
      WTPartSubstituteLink it will return newly created WTPartSubstituteLink
      Throws:
      WTException
      See Also:

    • modifyAlternateLink

      WTCollection modifyAlternateLink(WTPartAlternateLink alternateLink, Boolean oneWay, Map<String,Object> attributeMap) throws WTException, RemoteException
      Modifies the alternate link for given data

      Supported API: true
      Parameters:
      alternateLink - The alternate link for which the modifications are to be done.
      oneWay - If true, it indicates that a link will be one-way, resulting in the modification of only one link and other reverse alternate link will be deleted if exists. If false, the link will be two-way, resulting in the creation of new reverse alternate link.
      attributeMap - Provide values for IBAs, where the key represents the internal name of the IBA (String), and the value represents the value of the IBA. If the one-way parameter is set to false, the IBA values will not be applied to the newly created link.
      Returns:
      WTCollection It will return modified link if oneWay flag is true, else will return collection of modified link and newly created reverse alternate link.
      Throws:
      WTException
      RemoteException
      See Also:

    • modifySubstituteLink

      WTPartSubstituteLink modifySubstituteLink(WTPartSubstituteLink substituteLink, SubstituteQuantity substituteQuantity, String referenceDesignator, Map<String,Object> attributeMap) throws WTException, RemoteException
      Modifies a substitute link for the given data. This method is used to modify the values of the SubstituteQuantity and ReferenceDesignator on the substitute link if the preference named 'Enable quantity and reference designators for substitute parts' is set to true and the quantity amount is greater than zero. The data that is to be modified on the substitute link should only be passed.

      Supported API: true
      Parameters:
      substituteLink - The substitute link for which the modifications are to be done.
      substituteQuantity - The concept of substitute quantity as an
      invalid reference 
      #amount
      and a QuantityUnit (unit of measure) to be set on link.
      referenceDesignator - The Reference Designator value to be set on link.
      attributeMap - Provide values for IBAs, where the key represents the internal name of the IBA (String), and the value represents the value of the IBA.
      Returns:
      WTPartSubstituteLink It will return modified WTPartSubstituteLink
      Throws:
      WTException
      RemoteException
      See Also: