com.ptc.windchill.esi.bom
Class AlternateItemGroupMgr

java.lang.Object
  extended by com.ptc.windchill.esi.bom.AlternateItemGroupMgr
All Implemented Interfaces:
Externalizable, Serializable

public final class AlternateItemGroupMgr
extends Object
implements Externalizable

Provides generally useful methods to create, delete, and.or access AlternateItemGroup objects.

Supported API: true

Extendable: false

See Also:
Serialized Form

Method Summary
 AlternateItemGroup createAlternateItemGroup(WTPart assembly, PartUsageInfo partUsageInfo)
          Create an AlternateItemGroup object in database based upon the given part usage info.
 int getAIGNumber(AlternateItemGroup aig)
          Returns an AlternateItemGroup id.
 AlternateItemGroup getAlternateItemGroup(WTPart assembly, PartUsageInfo partUsageInfo)
          Returns an alternate item group, if one exists in the database.
 AlternateItemGroup getAlternateItemGroup(WTPart assembly, WTPartMaster component, LineNumber lineNumber)
          Returns an alternate item group , if with line number , based upon an assembly part and line number, otherwise considering as consolidated usage links, means that only one association between an assembly and more than one same components

Supported API: true
 Collection getAlternateItemGroups(WTPart assembly)
          Returns a collection of alternate item groups for an assembly.
 boolean hasSubstitutes(WTPart assembly, PartUsageInfo partUsageInfo)
          Checks if substitutes exist on a part usage link.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createAlternateItemGroup

public AlternateItemGroup createAlternateItemGroup(WTPart assembly,
                                                   PartUsageInfo partUsageInfo)
Create an AlternateItemGroup object in database based upon the given part usage info.

Supported API: true

Parameters:
assembly - The assembly part which defines the product structure (BOM) to which the AIG is to be associated.
partUsageInfo - The PartUsageInfo object that contains the part usage link information necessary to create an AIG.
Returns:
AlternateItemGroup

getAlternateItemGroups

public Collection getAlternateItemGroups(WTPart assembly)
Returns a collection of alternate item groups for an assembly.

Supported API: true

Parameters:
assembly - The assembly part.
Returns:
Collection

getAlternateItemGroup

public AlternateItemGroup getAlternateItemGroup(WTPart assembly,
                                                PartUsageInfo partUsageInfo)
Returns an alternate item group, if one exists in the database. Uses a WTPart to identify the assembly. Uses a PartUsageInfo to identify the line number and component on the assembly.

Supported API: true

Parameters:
assembly - The assmbly part.
partUsageInfo - The PartUsageInfo object that contains the part usage link information necessary to identify an existing AIG.
Returns:
AlternateItemGroup

getAlternateItemGroup

public AlternateItemGroup getAlternateItemGroup(WTPart assembly,
                                                WTPartMaster component,
                                                LineNumber lineNumber)
Returns an alternate item group , if with line number , based upon an assembly part and line number, otherwise considering as consolidated usage links, means that only one association between an assembly and more than one same components

Supported API: true

Parameters:
assembly - The assembly part.
component - The component part.
lineNumber - The line number for a WTPartUsageLink.
Returns:
AlternateItemGroup

hasSubstitutes

public boolean hasSubstitutes(WTPart assembly,
                              PartUsageInfo partUsageInfo)
Checks if substitutes exist on a part usage link.

Supported API: true

Parameters:
assembly - The assemblly part object.
partUsageInfo - The part usage info for the assembly.
Returns:
boolean

getAIGNumber

public int getAIGNumber(AlternateItemGroup aig)
Returns an AlternateItemGroup id.

Supported API: true

Parameters:
aig -
Returns:
int