wt.part
Class WTPartMaster

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Master
          wt.part.WTPartMaster

All Implemented Interfaces:

Externalizable, Serializable, wt.build.BuildTargetMaster, ConfiguredMaster, SerialNumbered, SerialNumberedConfiguredMaster, EffContext, wt.eff.ProductSolution, Releasable, wt.fc.BusinessInformation, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.generic.GenericizableMaster, wt.iba.value.IBAHolder, DisplayIdentification, WTContained, WTContainedIdentified, PathOccurrenceMasterContext, PathOwner, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedImpl, OrganizationOwnedMaster, wt.part.Part, wt.part.PartMaster, wt.recent.RecentlyVisited, wt.representation.RepresentableMaster, wt.representation.RepresentablesAndMasters, wt.ufid.Federatable, Mastered

Direct Known Subclasses:

MPMResourceMaster, ProxyPartMaster

public class WTPartMaster
extends Master
implements wt.part.PartMaster, UniquelyIdentified, wt.iba.value.IBAHolder, wt.eff.ProductSolution, wt.ufid.Federatable, WTContained, OrganizationOwnedMaster, WTContainedIdentified, Releasable, wt.build.BuildTargetMaster, wt.representation.RepresentableMaster, EffContext, PathOccurrenceMasterContext, PathOwner, SerialNumberedConfiguredMaster, wt.generic.GenericizableMaster, Externalizable

This reference implementation of a PartMaster represents the unchanging aspects of a part, is managed by WTPartService and also has one or more associated WTParts which represent the various stages (versions or iterations) of change for the changeable aspects of this part.

It has a name and number, the latter of which must be unique and it also has a default unit of measure. Some of its version/iteration functionality comes from being a Master.

Associations:

• WTPartUsageLink links this WTPartMaster to a WTPart that uses this WTPartMaster (actually uses one of this WTPartMaster's WTParts based on a config spec)
• WTPartSubstituteLink links this WTPartMaster to a WTPartUsageLink making it a replacement part for that particular usage
• WTPartAlternateLink links this WTPartMaster to another WTPartMaster that is a replacement part for any usage

Use the newWTPartMaster static factory method(s), not the WTPartMaster constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: true

See Also:

WTPartMasterIdentity, WTPartMasterKey, "Part Abstractions" in "Application Developer's Guide", Serialized Form

Field Summary

static String	DEFAULT_UNIT Label for the attribute; The default unit of measurement assigned to the part when it is used in a structure.
static String	EFF_PROPAGATION_STOP Label for the attribute; Indicates if effectivity propagation should stop or continue through this part.
static String	END_ITEM Label for the attribute; Indicates if the part should be treated as an end item.
static String	NAME Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".
static String	NUMBER Label for the attribute; The number attribute represents the number for this part and all of its versions.

Fields inherited from interface wt.org.OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.configuration.SerialNumbered

DEFAULT_TRACE_CODE

Method Summary

TraceCode	getDefaultTraceCode() Gets the object for the association that plays role: DEFAULT_TRACE_CODE.
QuantityUnit	getDefaultUnit() Gets the object for the association that plays role: DEFAULT_UNIT.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getIdentity() Returns the number and name of the part master in the form " - ".
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
boolean	isEffPropagationStop() Gets the value of the attribute: EFF_PROPAGATION_STOP.
boolean	isEndItem() Gets the value of the attribute: END_ITEM.
void	setDefaultTraceCode(TraceCode a_DefaultTraceCode) Sets the object for the association that plays role: DEFAULT_TRACE_CODE.
void	setDefaultUnit(QuantityUnit a_DefaultUnit) Sets the object for the association that plays role: DEFAULT_UNIT.
void	setEffPropagationStop(boolean a_EffPropagationStop) Sets the value of the attribute: EFF_PROPAGATION_STOP.
void	setEndItem(boolean a_EndItem) Sets the value of the attribute: END_ITEM.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNumber(String a_Number) Sets the value of the attribute: NUMBER.
void	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NUMBER

public static final String NUMBER

Label for the attribute; The number attribute represents the number for this part and all of its versions. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

See Also:

Constant Field Values

NAME

public static final String NAME

Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

See Also:

Constant Field Values

END_ITEM

public static final String END_ITEM

Label for the attribute; Indicates if the part should be treated as an end item.

Supported API: true

See Also:

Constant Field Values

EFF_PROPAGATION_STOP

public static final String EFF_PROPAGATION_STOP

Label for the attribute; Indicates if effectivity propagation should stop or continue through this part.

Supported API: true

See Also:

Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Label for the attribute; The default unit of measurement assigned to the part when it is used in a structure.

Supported API: true

See Also:

Constant Field Values

Method Detail

getNumber

public String getNumber()

Gets the value of the attribute: NUMBER. The number attribute represents the number for this part and all of its versions. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Returns:

String

setNumber

public void setNumber(String a_Number)
               throws WTPropertyVetoException

Sets the value of the attribute: NUMBER. The number attribute represents the number for this part and all of its versions. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

isEndItem

public boolean isEndItem()

Gets the value of the attribute: END_ITEM. Indicates if the part should be treated as an end item.

Supported API: true

Returns:

boolean

setEndItem

public void setEndItem(boolean a_EndItem)
                throws WTPropertyVetoException

Sets the value of the attribute: END_ITEM. Indicates if the part should be treated as an end item.

Supported API: true

Parameters:

a_EndItem -

Throws:

WTPropertyVetoException

isEffPropagationStop

public boolean isEffPropagationStop()

Gets the value of the attribute: EFF_PROPAGATION_STOP. Indicates if effectivity propagation should stop or continue through this part.

Supported API: true

Returns:

boolean

setEffPropagationStop

public void setEffPropagationStop(boolean a_EffPropagationStop)
                           throws WTPropertyVetoException

Sets the value of the attribute: EFF_PROPAGATION_STOP. Indicates if effectivity propagation should stop or continue through this part.

Supported API: true

Parameters:

a_EffPropagationStop -

Throws:

WTPropertyVetoException

getDefaultUnit

public QuantityUnit getDefaultUnit()

Gets the object for the association that plays role: DEFAULT_UNIT. The default unit of measurement assigned to the part when it is used in a structure.

Supported API: true

Returns:

QuantityUnit

setDefaultUnit

public void setDefaultUnit(QuantityUnit a_DefaultUnit)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: DEFAULT_UNIT. The default unit of measurement assigned to the part when it is used in a structure.

Supported API: true

Parameters:

a_DefaultUnit -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Returns the number and name of the part master in the form " - ".

Supported API: true

Returns:

String

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Specified by:

getOrganizationReference in interface OrganizationOwnedImpl

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface OrganizationOwned

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException

getDefaultTraceCode

public TraceCode getDefaultTraceCode()

Gets the object for the association that plays role: DEFAULT_TRACE_CODE.

Supported API: true

Specified by:

getDefaultTraceCode in interface SerialNumbered

Returns:

TraceCode

setDefaultTraceCode

public void setDefaultTraceCode(TraceCode a_DefaultTraceCode)
                         throws WTPropertyVetoException

Sets the object for the association that plays role: DEFAULT_TRACE_CODE.

Supported API: true

Specified by:

setDefaultTraceCode in interface SerialNumbered

Parameters:

a_DefaultTraceCode -

Throws:

WTPropertyVetoException