Package wt.part

Class PartUsageInfo

java.lang.Object

wt.part.PartUsageInfo

public class PartUsageInfo
extends Object

Represents usage information identified for export by the retrieveBomInformation and retrieveBOMDifferences methods of the WTPartService.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
protected void	consolidate(PartUsageInfo info)	This method is intended to be overriden by a customizer that extends PartUsageInfo.
protected boolean	diffExpressions(PartUsageInfo info)	Compare expressions of given usages if its changed, added, or removed.
LineNumber	getLineNumber()	Gets the value of the attribute: lineNumber; The line number associated with this part usage.
WTPart	getPart()	Gets the value of the attribute: part; The part(RoleB object) associated with this part usage.
WTPartMaster	getPartMaster()	Gets the value of the attribute: partMaster; The part master associated with this part usage.
Quantity	getQuantity()	Gets the value of the attribute: quantity; The quantity associated with this part usage.
Enumeration	getRefDesAdditions()	Gets the value of the attribute: refDesAdditions; Represent the reference designators that are being added to this part usage.
Enumeration	getRefDesDeletions()	Gets the value of the attribute: refDesDeletions; Represent the reference designators that are being removed to this part usage.
HashMap	getsoftAttributes()	Gets the value of the attribute: softAttributes; Soft attributes and their values defined on the partUsageLink.
Enumeration	getSubstPartsAdditions()	Gets the value of the attribute: substPartsAdditions; Represent the substitute parts that are being added to this part usage.
Enumeration	getSubstPartsCommons()	Gets the value of the attribute: substPartsCommons; Represent the substitute parts that are common to the part usages compared.
Enumeration	getSubstPartsDeletions()	Gets the value of the attribute: substPartsDeletions; Represent the substitute parts that are being removed to this part usage.
boolean	hasSubstitutes()	Returns true if the current usage link has substitutes, false otherwise.
protected void	initialize(WTPartUsageLink partUsageLink)	This method is intended to be overridden by a customizer that extends PartUsageInfo and allows initializing the object once it has been constructed.
protected void	initialize(WTPartUsageLink partUsageLink, WTPart part, Map<String,Object> softAttributes)	This method is intended to be overridden by a customizer that extends PartUsageInfo and allows initializing the object once it has been constructed.
boolean	isDifferent(PartUsageInfo info)	This method is intended to be overriden by a customizer that extends PartUsageInfo.
void	processForAdd()	This method is intended to be overridden by a customizer that extends PartUsageInfo.
void	processForChange()	This method is intended to be overridden by a customizer that extends PartUsageInfo.
void	processForDelete()	This method is intended to be overridden by a customizer that extends PartUsageInfo.
void	processForNoChange()	This method is intended to be overridden by a customizer that extends PartUsageInfo.
void	processForReplace()	This method is intended to be overridden by a customizer that extends PartUsageInfo.
void	setPart(WTPart part)	Sets the value of the attribute: part; The part(RoleB object) associated with this part usage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getPartMaster

public WTPartMaster getPartMaster()

Gets the value of the attribute: partMaster; The part master associated with this part usage.

Supported API: true

Returns:

WTPartMaster

getPart

public WTPart getPart()

Gets the value of the attribute: part; The part(RoleB object) associated with this part usage.

Supported API: true

Returns:

WTPart

setPart

public void setPart(WTPart part)

Sets the value of the attribute: part; The part(RoleB object) associated with this part usage.

Supported API: true

getLineNumber

public LineNumber getLineNumber()

Gets the value of the attribute: lineNumber; The line number associated with this part usage. Set to null if the usage is not assigned a line number.

Supported API: true

Returns:

LineNumber

getQuantity

public Quantity getQuantity()

Gets the value of the attribute: quantity; The quantity associated with this part usage. A null quantity indicates no quantity change when used to indicate difference between two versions of a part.

Supported API: true

Returns:

Quantity

getRefDesAdditions

public Enumeration getRefDesAdditions()

Gets the value of the attribute: refDesAdditions; Represent the reference designators that are being added to this part usage. The value is null if there are no reference designators being added.

Supported API: true

Returns:

Enumeration

getRefDesDeletions

public Enumeration getRefDesDeletions()

Gets the value of the attribute: refDesDeletions; Represent the reference designators that are being removed to this part usage. The value is null if there are no reference designators being removed.

Supported API: true

Returns:

Enumeration

getSubstPartsAdditions

public Enumeration getSubstPartsAdditions()

Gets the value of the attribute: substPartsAdditions; Represent the substitute parts that are being added to this part usage. The value is null if there are no substitute parts being added.

Supported API: true

Returns:

Enumeration

getSubstPartsDeletions

public Enumeration getSubstPartsDeletions()

Gets the value of the attribute: substPartsDeletions; Represent the substitute parts that are being removed to this part usage. The value is null if there are no substitute parts being removed.

Supported API: true

Returns:

Enumeration

getSubstPartsCommons

public Enumeration getSubstPartsCommons()

Gets the value of the attribute: substPartsCommons; Represent the substitute parts that are common to the part usages compared. The value is null if there are no substitute parts that are common.

Supported API: true

Returns:

Enumeration

getsoftAttributes

public HashMap getsoftAttributes()

Gets the value of the attribute: softAttributes; Soft attributes and their values defined on the partUsageLink. For a multi_valued soft attribute, the value of the returned hash map is a set containing all the values of the soft attribute.

Supported API: true

Returns:

HashMap

initialize

protected void initialize(WTPartUsageLink partUsageLink)
                   throws WTException

This method is intended to be overridden by a customizer that extends PartUsageInfo and allows initializing the object once it has been constructed. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

Parameters:

partUsageLink -

Throws:

WTException

initialize

protected void initialize(WTPartUsageLink partUsageLink,
 WTPart part,
 Map<String,Object> softAttributes)
                   throws WTException

This method is intended to be overridden by a customizer that extends PartUsageInfo and allows initializing the object once it has been constructed. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

Parameters:

partUsageLink - - part usage link.

part - - RoleB iteration of current part usage link.

softAttributes - - Soft attributes and their values that reside on the current usage link.

Throws:

WTException

consolidate

protected void consolidate(PartUsageInfo info)

This method is intended to be overriden by a customizer that extends PartUsageInfo. The method is used to consolidate any attributes defined for a subclass of PartUsageInfo. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

Parameters:

info -

isDifferent

public boolean isDifferent(PartUsageInfo info)

This method is intended to be overriden by a customizer that extends PartUsageInfo. The method is available to determine whether this PartUsageInfo is different when compared to the given PartUsageInfo object passed as an arguement. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

Parameters:

info -

Returns:

boolean

processForAdd

public void processForAdd()

This method is intended to be overridden by a customizer that extends PartUsageInfo. The method is available should the information stored in this object need to be processed in the event that the part usage is for a BOM item addition. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

processForReplace

public void processForReplace()

This method is intended to be overridden by a customizer that extends PartUsageInfo. The method is available should the information stored in this object need to be processed in the event that the part usage is for a BOM item replace. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

processForChange

public void processForChange()

This method is intended to be overridden by a customizer that extends PartUsageInfo. The method is available should the information stored in this object need to be processed in the event that the part usage is for a BOM item change. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

processForDelete

public void processForDelete()

This method is intended to be overridden by a customizer that extends PartUsageInfo. The method is available should the information stored in this object need to be processed in the event that the part usage is for a BOM item delete. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

processForNoChange

public void processForNoChange()

This method is intended to be overridden by a customizer that extends PartUsageInfo. The method is available should the information stored in this object need to be processed in the event that the part usage is for a BOM item without changes. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

hasSubstitutes

public boolean hasSubstitutes()

Returns true if the current usage link has substitutes, false otherwise.

Supported API: true

Returns:

diffExpressions

protected boolean diffExpressions(PartUsageInfo info)

Compare expressions of given usages if its changed, added, or removed.

Supported API: true

Parameters:

info - - The input PartUsageInfo object to compare with.

Returns:

true, if the expressions on current object and input usage info object are not identical i.e. if expressions are changed, added or removed; false otherwise .