wt.part
Class WTPart

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

All Implemented Interfaces:

_DepthLock000, _DepthLock001, _DepthLock002, _DepthLock003, _DepthLock004, _DepthLock005, _DepthLock006, _DepthLock007, AccessControlled, AccessControlList, AdHocControlled, AnnotationTarget, Archiveable, Baselineable, BuildTarget, BusinessInformation, CabinetBased, Changeable2, ChangeableIfc, ConfigurationManageable, ContentHolder, DisplayIdentification, DomainAdministered, EffectivityHolder, EffectivityManageable, EffManagedVersion, ElectronicallySignable, Externalizable, Federatable, Foldered, FolderEntry, FolderServiceManaged, IBAHolder, Indexable, Iterated, IteratedFoldered, IteratedLifeCycleManaged, IteratedSubjectOfForum, IteratedSubjectOfNotebook, LifeCycleManaged, Lockable, NetFactor, Notifiable, ObjectMappable, OneOffVersioned, OrganizationOwned, OrganizationOwnedVersion, Ownable, Part, PartVersion, Persistable, Promotable, RecentlyVisited, Releasable, RemotelyLinkable, Representable, RepresentablesAndMasters, RepresentationContributor, RequirementsManageable, Serializable, SubjectOfForum, SubjectOfNotebook, TeamManaged, Trackable, Typed, UsesOccurrenceContext, Versionable, Versioned, Viewable, ViewManageable, Workable, WorkspaceTrackable, WTContained

Direct Known Subclasses:

WTProduct, WTSerialNumberedPart

public class WTPart

extends RevisionControlled

implements PartVersion, ContentHolder, EffectivityManageable, ViewManageable, Baselineable, BuildTarget, IBAHolder, IteratedSubjectOfForum, RequirementsManageable, Federatable, Representable, Typed, ElectronicallySignable, UsesOccurrenceContext, AnnotationTarget, ConfigurationManageable, WTContained, Viewable, OrganizationOwnedVersion, Releasable, WorkspaceTrackable, Archiveable, 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

private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private Vector	contentVector
static String	DEFAULT_UNIT Label for the attribute; The default unit of measure for the part.
private Vector	effVector
static long	EXTERNALIZATION_VERSION_UID
private FederatableInfo	federatableInfo
private boolean	hasContents
private Vector	httpVector
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.
protected static long	OLD_FORMAT_VERSION_UID
private OneOffVersionInfo	oneOffVersionInfo
private HttpContentOperation	operation
static String	PART_TYPE Label for the attribute.
private static int	PART_TYPE_UPPER_LIMIT
private PartType	partType
static long	R30_EXTERNALIZATION_VERSION_UID
static long	R51_EXTERNALIZATION_VERSION_UID
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private Source	source
static String	SOURCE Label for the attribute.
private static int	SOURCE_UPPER_LIMIT
private AttributeContainer	theAttributeContainer
private TypeDefinitionReference	typeDefinitionReference
private ViewReference	view

Fields inherited from class wt.enterprise.RevisionControlled

MASTER, VERSION_DISPLAY_IDENTIFIER, VERSION_DISPLAY_IDENTITY, VERSION_DISPLAY_TYPE

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.eff.EffManagedVersion

EFF_VECTOR

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.vc.Versioned

VERSION_IDENTIFIER, VERSION_INFO

Fields inherited from interface wt.vc.views.ViewManageable

VIEW, VIEW_NAME

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.vc.OneOffVersioned

ONE_OFF_VERSION_IDENTIFIER, ONE_OFF_VERSION_INFO

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwnedVersion

MASTER, MASTER_REFERENCE, ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.lifecycle.LifeCycleManaged

LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.team.TeamManaged

TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAME

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTPart()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	federatableInfoValidate(FederatableInfo a_FederatableInfo)
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
QuantityUnit	getDefaultUnit() Gets the value of the attribute: DEFAULT_UNIT.
Vector	getEffVector() Gets the object for the association that plays role: EFF_VECTOR.
FederatableInfo	getFederatableInfo() Gets the object for the association that plays role: FEDERATABLE_INFO.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
String	getIdentity() Returns the master identity plus the version identity for this part in the form of " - , ()".
LocalizableMessage	getIterationDisplayIdentifierSansView()
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
OneOffVersionIdentifier	getOneOffVersionIdentifier() Gets the value of the attribute: ONE_OFF_VERSION_IDENTIFIER.
OneOffVersionInfo	getOneOffVersionInfo() Gets the object for the association that plays role: ONE_OFF_VERSION_INFO.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
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.
PartType	getPartType() Gets the object for the association that plays role: PART_TYPE.
Source	getSource() Gets the object for the association that plays role: SOURCE.
TypeDefinitionReference	getTypeDefinitionReference() Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
ViewReference	getView() Gets the object for the association that plays role: VIEW.
String	getViewName() Gets the value of the attribute: VIEW_NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
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	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
private void	masterReferenceValidate(ObjectReference a_MasterReference)
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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WTPart thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setDefaultUnit(QuantityUnit a_DefaultUnit) Sets the value of the attribute: DEFAULT_UNIT.
void	setEffVector(Vector a_EffVector) Sets the object for the association that plays role: EFF_VECTOR.
void	setFederatableInfo(FederatableInfo a_FederatableInfo) Sets the object for the association that plays role: FEDERATABLE_INFO.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
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	setOneOffVersionInfo(OneOffVersionInfo a_OneOffVersionInfo) Sets the object for the association that plays role: ONE_OFF_VERSION_INFO.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
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.
void	setPartType(PartType a_PartType) Sets the object for the association that plays role: PART_TYPE.
void	setSource(Source a_Source) Sets the object for the association that plays role: SOURCE.
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
void	setView(ViewReference a_View) Sets the object for the association that plays role: VIEW.
private void	typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.enterprise.RevisionControlled

getBranchIdentifier, getBusinessType, getCabinet, getCabinetName, getCabinetReference, getCheckoutInfo, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderingInfo, getFolderPath, getIndexerSet, getIterationDisplayIdentifier, getIterationIdentifier, getIterationInfo, getIterationNote, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLocation, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOwnership, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, getVersionDisplayIdentifier, getVersionDisplayIdentity, getVersionDisplayType, getVersionIdentifier, getVersionInfo, initialize, isInheritedDomain, isLatestIteration, isLifeCycleAtGate, isLifeCycleBasic, isLocked, readVersion, setCheckoutInfo, setControlBranch, setDomainRef, setEntrySet, setEventSet, setFolderingInfo, setIndexerSet, setInheritedDomain, setIterationInfo, setLock, setOwnership, setState, setTeamId, setTeamTemplateId, setVersionInfo

Methods inherited from class wt.fc.WTObject

duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.vc.Iterated

getBranchIdentifier, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationInfo, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setIterationInfo

Methods inherited from interface wt.vc.Versioned

getVersionIdentifier, getVersionInfo, setVersionInfo

Methods inherited from interface wt.org.OrganizationOwnedVersion

getMaster, getMasterReference

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

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

PART_TYPE

public static final String PART_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

PART_TYPE_UPPER_LIMIT

private static int PART_TYPE_UPPER_LIMIT

partType

private PartType partType

SOURCE

public static final String SOURCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SOURCE_UPPER_LIMIT

private static int SOURCE_UPPER_LIMIT

source

private Source source

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

effVector

private Vector effVector

view

private ViewReference view

theAttributeContainer

private AttributeContainer theAttributeContainer

federatableInfo

private FederatableInfo federatableInfo

typeDefinitionReference

private TypeDefinitionReference typeDefinitionReference

oneOffVersionInfo

private OneOffVersionInfo oneOffVersionInfo

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

R30_EXTERNALIZATION_VERSION_UID

public static final long R30_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R51_EXTERNALIZATION_VERSION_UID

public static final long R51_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

WTPart

public WTPart()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class RevisionControlled

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class RevisionControlled

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTPart thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class RevisionControlled

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class RevisionControlled

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

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

Specified by:

getName in interface CabinetBased

Overrides:

getName in class RevisionControlled

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

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 Iterated

Overrides:

setMaster in class RevisionControlled

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

setMasterReference in interface Iterated

Overrides:

setMasterReference in class RevisionControlled

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

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

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class RevisionControlled

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

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

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

getEffVector

public Vector getEffVector()

Gets the object for the association that plays role: EFF_VECTOR. Add the following code to setEffVector to facilitate the synchronization:

If the effVector was not null coming in, the EffGroups will logically become orphaned after the vector is replaced. We can't, however, set the EffGroup's target to null (it's required). So, we won't do anything here; rather, getTarget in EffGroup will return null if it's no longer synchronized. Unfortunately, we can't synchronize a call to addElement. Don't call addElement -- instead setTarget on the EffGroup side; this will cause the group to be added to the vector.

effVector = a_EffVector;

// synchronization for bidirectional association for (int i = 0; effVector != null && i < effVector.size(); i++) ((EffGroup) effVector.elementAt(i)).setTarget(this);

Supported API: true

Specified by:

getEffVector in interface EffManagedVersion

Returns:

Vector

setEffVector

public void setEffVector(Vector a_EffVector)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: EFF_VECTOR. Add the following code to setEffVector to facilitate the synchronization:

If the effVector was not null coming in, the EffGroups will logically become orphaned after the vector is replaced. We can't, however, set the EffGroup's target to null (it's required). So, we won't do anything here; rather, getTarget in EffGroup will return null if it's no longer synchronized. Unfortunately, we can't synchronize a call to addElement. Don't call addElement -- instead setTarget on the EffGroup side; this will cause the group to be added to the vector.

effVector = a_EffVector;

// synchronization for bidirectional association for (int i = 0; effVector != null && i < effVector.size(); i++) ((EffGroup) effVector.elementAt(i)).setTarget(this);

Supported API: true

Specified by:

setEffVector in interface EffManagedVersion

Parameters:

a_EffVector -

Throws:

WTPropertyVetoException

getViewName

public String getViewName()

Gets the value of the attribute: VIEW_NAME. Derived attribute for displaying the view name value in query results.

Supported API: false

Specified by:

getViewName in interface ViewManageable

Returns:

String

getView

public ViewReference getView()

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

Supported API: false

Specified by:

getView in interface ViewManageable

Returns:

ViewReference

setView

public void setView(ViewReference a_View)

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

Supported API: false

Specified by:

setView in interface ViewManageable

Parameters:

a_View -

getAttributeContainer

public AttributeContainer getAttributeContainer()

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

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

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

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

getFederatableInfo

public FederatableInfo getFederatableInfo()

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

Supported API: false

Specified by:

getFederatableInfo in interface Federatable

Returns:

FederatableInfo

setFederatableInfo

public void setFederatableInfo(FederatableInfo a_FederatableInfo)
                        throws WTPropertyVetoException

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

Supported API: false

Specified by:

setFederatableInfo in interface Federatable

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

federatableInfoValidate

private void federatableInfoValidate(FederatableInfo a_FederatableInfo)
                              throws WTPropertyVetoException

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

getTypeDefinitionReference

public TypeDefinitionReference getTypeDefinitionReference()

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

Supported API: false

Specified by:

getTypeDefinitionReference in interface Typed

Returns:

TypeDefinitionReference

setTypeDefinitionReference

public void setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference)
                                throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTypeDefinitionReference in interface Typed

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

typeDefinitionReferenceValidate

private void typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
                                      throws WTPropertyVetoException

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

getOneOffVersionIdentifier

public OneOffVersionIdentifier getOneOffVersionIdentifier()

Gets the value of the attribute: ONE_OFF_VERSION_IDENTIFIER. Derived attribute for displaying the one-off version identifier in query results.

Supported API: false

Specified by:

getOneOffVersionIdentifier in interface OneOffVersioned

Returns:

OneOffVersionIdentifier

getOneOffVersionInfo

public OneOffVersionInfo getOneOffVersionInfo()

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

Supported API: false

Specified by:

getOneOffVersionInfo in interface OneOffVersioned

Returns:

OneOffVersionInfo

setOneOffVersionInfo

public void setOneOffVersionInfo(OneOffVersionInfo a_OneOffVersionInfo)
                          throws WTPropertyVetoException

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

Supported API: false

Specified by:

setOneOffVersionInfo in interface OneOffVersioned

Parameters:

a_OneOffVersionInfo -

Throws:

WTPropertyVetoException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:

getOrganizationReference in interface OrganizationOwnedVersion

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:

setOrganizationReference in interface OrganizationOwnedVersion

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

Specified by:

setOrganization in interface OrganizationOwned

Parameters:

a_Organization -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class RevisionControlled

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class RevisionControlled

Returns:

int

getIterationDisplayIdentifierSansView

public LocalizableMessage getIterationDisplayIdentifierSansView()