wt.part
Class WTPart

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.RevisionControlled
          wt.part.WTPart

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, IdentityAccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, AnnotationTarget, wt.build.BuildTarget, Changeable2, ChangeableIfc, ConfigurationManageable, ConfiguredVersion, ContentHolder, EffManagedVersion, EffRecordable, wt.effectivity.EffectivityHolder, wt.effectivity.EffectivityManageable, wt.epm.workspaces.Trackable, wt.epm.workspaces.WorkspaceTrackable, Releasable, wt.fc.archive.Archiveable, wt.fc.archive.ArchiveablePrimary, wt.fc.BusinessInformation, wt.fc.importer.ImportTrackable, NetFactor, ObjectMappable, Persistable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, IteratedFoldered, Genericizable, wt.generic.OVTemplate, wt.generic.Variant, wt.iba.value.IBAHolder, DisplayIdentification, Indexable, WTContained, IteratedLifeCycleManaged, wt.lifecycle.LifeCycleManaged, Lockable, wt.maturity.Promotable, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, wt.note.NoteHolder, Notifiable, PathOccurrenceContext, PathOwner, UsesOccurrenceContext, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedVersion, Ownable, wt.part.Part, wt.part.PartVersion, wt.recent.RecentlyVisited, wt.representation.Representable, wt.representation.RepresentablesAndMasters, wt.representation.RepresentationContributor, wt.team.TeamManaged, wt.type.FlexTyped, wt.type.Typed, wt.ufid.Federatable, wt.util.depthLock._DepthLock000, wt.util.depthLock._DepthLock001, wt.util.depthLock._DepthLock002, wt.util.depthLock._DepthLock003, wt.util.depthLock._DepthLock004, wt.util.depthLock._DepthLock005, wt.util.depthLock._DepthLock006, wt.util.depthLock._DepthLock007, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, ViewManageable, Workable, wt.viewmarkup.Viewable, wt.workflow.forum.IteratedSubjectOfForum, wt.workflow.forum.SubjectOfForum, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook, wt.workflow.requirement.RequirementsManageable

Direct Known Subclasses:

MPMResource, SupplierPart

public class WTPart
extends RevisionControlled
implements wt.part.PartVersion, ContentHolder, wt.effectivity.EffectivityManageable, ViewManageable, Baselineable, wt.build.BuildTarget, wt.iba.value.IBAHolder, wt.workflow.forum.IteratedSubjectOfForum, wt.workflow.requirement.RequirementsManageable, wt.ufid.Federatable, wt.representation.Representable, wt.type.Typed, wt.org.electronicIdentity.ElectronicallySignable, UsesOccurrenceContext, AnnotationTarget, ConfigurationManageable, WTContained, wt.viewmarkup.Viewable, OrganizationOwnedVersion, Releasable, wt.epm.workspaces.WorkspaceTrackable, PathOccurrenceContext, PathOwner, ConfiguredVersion, Genericizable, wt.fc.importer.ImportTrackable, IdentityAccessControlled, wt.generic.OVTemplate, wt.generic.Variant, wt.fc.archive.ArchiveablePrimary, wt.note.NoteHolder, Externalizable

This reference implementation of a PartVersion represents a snapshot of the changeable aspects of a part, is managed by WTPartService and has an associated WTPartMaster which represents the unchanging aspects of this part. Many of the significant associations of parts happen at the WTPartMaster level.

Associations:

• WTPartUsageLink links this WTPart to a WTPartMaster that it uses (actually it uses one of the WTParts associated with the WTPartMaster based on a config spec)
• WTPartSubstituteLink links a WTPartMaster to a WTPartUsageLink making it (actually one of its WTParts based on a config spec) a substitute part for that particular usage
• WTPartAlternateLink links one WTPartMaster to another that is an alternate part for any usage (alternates are NOT defined at this WTPart level)

By virtue of its being RevisionControlled it can be:

• checked in and checked out
• assigned to views
• baselined
• assigned to an effectivity
• hold content

The intention is that this WTPart represents one stage in the development and change of the part. A part may have many versions (and iterations, which are like sub-versions) and a large part of the implementation of parts deals with making new versions (and/or iterations) from existing ones and selecting the correct version(s) or iteration(s) that is (are) relevant in a particular situation by using a WTPartConfigSpec. Much of the version/iteration functionality comes from being RevisionControlled.

• WTPartUsageLink links to a WTPartMaster that is a component of this part
• WTPartReferenceLink links to a WTDocumentMaster
• WTPartDescribeLink links to a WTDocument

Use the newWTPart static factory method(s), not the WTPart 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:

for information on check in and check out, wt.vc.views, wt.vc.baseline, wt.effectivity, "Making Parts Content Holders" in Customizer's Guide", RevisionControlled, "Part Abstractions" in "Application Developer's Guide", Serialized Form

Field Summary

static String	CONTRACT_NUMBER Label for the attribute; Attribute specific to the Windchill A&D module Supported API: true
static String	DEFAULT_TRACE_CODE Label for the attribute; The default unit of measure for the part.
static String	DEFAULT_UNIT Label for the attribute; The default unit of measure for the part.
static String	END_ITEM Label for the attribute; Indicates if the part should be treated as an end item.
static String	GENERIC_TYPE Label for the attribute; Indicates if this is a Generic Type WTPart.
static String	JOB_AUTHORIZATION_NUMBER Label for the attribute; Attribute specific to the Windchill A&D module Supported API: true
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.
static String	PART_TYPE Label for the attribute.
static String	PHASE Label for the attribute; Attribute specific to the Windchill A&D module Supported API: true
static String	SOURCE Label for the attribute.

Fields inherited from class wt.enterprise.RevisionControlled

MASTER

Fields inherited from interface wt.org.OrganizationOwnedVersion

MASTER, MASTER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.configuration.ConfiguredVersion

MASTER, MASTER_REFERENCE

Fields inherited from interface wt.generic.Genericizable

MASTER, MASTER_REFERENCE

Method Summary

String	getContractNumber() Gets the value of the attribute: CONTRACT_NUMBER.
TraceCode	getDefaultTraceCode() Gets the value of the attribute: DEFAULT_TRACE_CODE.
QuantityUnit	getDefaultUnit() Gets the value of the attribute: DEFAULT_UNIT.
wt.generic.GenericType	getGenericType() Gets the value of the attribute: GENERIC_TYPE.
String	getIdentity() Returns the master identity plus the version identity for this part in the form of " - , ()".
String	getJobAuthorizationNumber() Gets the value of the attribute: JOB_AUTHORIZATION_NUMBER.
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.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
PartType	getPartType() Gets the object for the association that plays role: PART_TYPE.
String	getPhase() Gets the value of the attribute: PHASE.
Source	getSource() Gets the object for the association that plays role: SOURCE.
protected void	initialize(String number, String name) Supports initialization, following construction of an instance.
protected void	initialize(String number, String name, QuantityUnit defaultUnit) Supports initialization, following construction of an instance.
boolean	isEndItem() Gets the value of the attribute: END_ITEM.
static WTPart	newWTPart() Construct a new WTPart (and its WTPartMaster).
static WTPart	newWTPart(String number, String name) Constructs a new WTPart and sets the WTPartMaster's name and number to the passed-in values.
static WTPart	newWTPart(String number, String name, QuantityUnit defaultUnit) Constructs a new WTPart and sets the WTPartMaster's name and number to the passed-in values.
void	setContractNumber(String a_ContractNumber) Sets the value of the attribute: CONTRACT_NUMBER.
void	setDefaultTraceCode(TraceCode a_DefaultTraceCode) Sets the value of the attribute: DEFAULT_TRACE_CODE.
void	setDefaultUnit(QuantityUnit a_DefaultUnit) Sets the value of the attribute: DEFAULT_UNIT.
void	setEndItem(boolean a_EndItem) Sets the value of the attribute: END_ITEM.
void	setGenericType(wt.generic.GenericType a_GenericType) Sets the value of the attribute: GENERIC_TYPE.
void	setJobAuthorizationNumber(String a_JobAuthorizationNumber) Sets the value of the attribute: JOB_AUTHORIZATION_NUMBER.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
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	setPartType(PartType a_PartType) Sets the object for the association that plays role: PART_TYPE.
void	setPhase(String a_Phase) Sets the value of the attribute: PHASE.
void	setSource(Source a_Source) Sets the object for the association that plays role: SOURCE.

Methods inherited from class wt.enterprise.RevisionControlled

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setMasterReference

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

Methods inherited from interface wt.org.OrganizationOwnedVersion

getMaster, getMasterReference

Methods inherited from interface wt.configuration.ConfiguredVersion

getMaster, getMasterReference, setMasterReference

Methods inherited from interface wt.generic.Genericizable

getMaster, getMasterReference, setMasterReference

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

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Label for the attribute; The default unit of measure for the part.

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

DEFAULT_TRACE_CODE

public static final String DEFAULT_TRACE_CODE

Label for the attribute; The default unit of measure for the part.

Supported API: true

See Also:

Constant Field Values

GENERIC_TYPE

public static final String GENERIC_TYPE

Label for the attribute; Indicates if this is a Generic Type WTPart.

Supported API: true

See Also:

Constant Field Values

JOB_AUTHORIZATION_NUMBER

public static final String JOB_AUTHORIZATION_NUMBER

Label for the attribute; Attribute specific to the Windchill A&D module

Supported API: true

See Also:

Constant Field Values

CONTRACT_NUMBER

public static final String CONTRACT_NUMBER

Label for the attribute; Attribute specific to the Windchill A&D module

Supported API: true

See Also:

Constant Field Values

PHASE

public static final String PHASE

Label for the attribute; Attribute specific to the Windchill A&D module

Supported API: true

See Also:

Constant Field Values

PART_TYPE

public static final String PART_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SOURCE

public static final String SOURCE

Label for the attribute.

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

getDefaultUnit

public QuantityUnit getDefaultUnit()

Gets the value of the attribute: DEFAULT_UNIT. The default unit of measure for the part.

Supported API: true

Returns:

QuantityUnit

setDefaultUnit

public void setDefaultUnit(QuantityUnit a_DefaultUnit)
                    throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_UNIT. The default unit of measure for the part.

Supported API: true

Parameters:

a_DefaultUnit -

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

getDefaultTraceCode

public TraceCode getDefaultTraceCode()

Gets the value of the attribute: DEFAULT_TRACE_CODE. The default unit of measure for the part.

Supported API: true

Returns:

TraceCode

setDefaultTraceCode

public void setDefaultTraceCode(TraceCode a_DefaultTraceCode)
                         throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_TRACE_CODE. The default unit of measure for the part.

Supported API: true

Parameters:

a_DefaultTraceCode -

Throws:

WTPropertyVetoException

getGenericType

public wt.generic.GenericType getGenericType()

Gets the value of the attribute: GENERIC_TYPE. Indicates if this is a Generic Type WTPart.

Supported API: true

Returns:

GenericType

setGenericType

public void setGenericType(wt.generic.GenericType a_GenericType)
                    throws WTPropertyVetoException

Sets the value of the attribute: GENERIC_TYPE. Indicates if this is a Generic Type WTPart.

Supported API: true

Parameters:

a_GenericType -

Throws:

WTPropertyVetoException

getJobAuthorizationNumber

public String getJobAuthorizationNumber()

Gets the value of the attribute: JOB_AUTHORIZATION_NUMBER. Attribute specific to the Windchill A&D module

Supported API: true

Returns:

String

setJobAuthorizationNumber

public void setJobAuthorizationNumber(String a_JobAuthorizationNumber)
                               throws WTPropertyVetoException

Sets the value of the attribute: JOB_AUTHORIZATION_NUMBER. Attribute specific to the Windchill A&D module

Supported API: true

Parameters:

a_JobAuthorizationNumber -

Throws:

WTPropertyVetoException

getContractNumber

public String getContractNumber()

Gets the value of the attribute: CONTRACT_NUMBER. Attribute specific to the Windchill A&D module

Supported API: true

Returns:

String

setContractNumber

public void setContractNumber(String a_ContractNumber)
                       throws WTPropertyVetoException

Sets the value of the attribute: CONTRACT_NUMBER. Attribute specific to the Windchill A&D module

Supported API: true

Parameters:

a_ContractNumber -

Throws:

WTPropertyVetoException

getPhase

public String getPhase()

Gets the value of the attribute: PHASE. Attribute specific to the Windchill A&D module

Supported API: true

Returns:

String

setPhase

public void setPhase(String a_Phase)
              throws WTPropertyVetoException

Sets the value of the attribute: PHASE. Attribute specific to the Windchill A&D module

Supported API: true

Parameters:

a_Phase -

Throws:

WTPropertyVetoException

getPartType

public PartType getPartType()

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

Supported API: true

Returns:

PartType

setPartType

public void setPartType(PartType a_PartType)

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

Supported API: true

Parameters:

a_PartType -

getSource

public Source getSource()

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

Supported API: true

Returns:

Source

setSource

public void setSource(Source a_Source)

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

Supported API: true

Parameters:

a_Source -

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: true

Specified by:

setMaster in interface ConfiguredVersion

Specified by:

setMaster in interface Genericizable

Specified by:

setMaster in interface Iterated

Overrides:

setMaster in class RevisionControlled

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

newWTPart

public static WTPart newWTPart()
                        throws WTException

Construct a new WTPart (and its WTPartMaster).

Supported API: true

Returns:

WTPart

Throws:

WTException

newWTPart

public static WTPart newWTPart(String number,
                               String name)
                        throws WTException

Constructs a new WTPart and sets the WTPartMaster's name and number to the passed-in values.

Supported API: true

Parameters:

number -

name -

Returns:

WTPart

Throws:

WTException

initialize

protected void initialize(String number,
                          String name)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

number -

name -

Throws:

WTException

getIdentity

public String getIdentity()

Returns the master identity plus the version identity for this part in the form of " - , ()". For example "100 - engine, A.1 (Engineering)". If the WTPart is view-independent, the parenthesis are not included.

Supported API: true

Returns:

String

newWTPart

public static WTPart newWTPart(String number,
                               String name,
                               QuantityUnit defaultUnit)
                        throws WTException

Constructs a new WTPart and sets the WTPartMaster's name and number to the passed-in values.

Supported API: true

Parameters:

number -

name -

defaultUnit -

Returns:

WTPart

Throws:

WTException

initialize

protected void initialize(String number,
                          String name,
                          QuantityUnit defaultUnit)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

number -

name -

defaultUnit -

Throws:

WTException

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