Package wt.part

Class WTProductInstance2

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.part._WTProductInstance2

wt.part.WTProductInstance2

All Implemented Interfaces:

Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.change2._Changeable2, wt.change2._ChangeableIfc, Changeable2, ChangeableIfc, wt.configuration._SerialNumberedConfiguredInstanceVersion, _SerialNumberedInstanceImpl, _SerialNumberedInstanceVersion, SerialNumberedConfiguredInstanceVersion, SerialNumberedInstanceImpl, SerialNumberedInstanceVersion, wt.facade.persistedcollection._PersistedCollectable, PersistedCollectable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.index._Indexable, Indexable, wt.inf.container._WTContained, WTContained, wt.lifecycle._IteratedLifeCycleManaged, _LifeCycleManaged, IteratedLifeCycleManaged, LifeCycleManaged, wt.maturity._Promotable, Promotable, wt.notify._Notifiable, Notifiable, wt.occurrence._PathOccurrenceContext, PathOccurrenceContext, _OrganizationOwned, wt.org.electronicIdentity._ElectronicallySignable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, wt.part._WTProductInstance2TypeInterface, wt.part.WTProductInstance2TypeInterface, wt.recent.RecentlyVisited, _TeamManaged, TeamManaged, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, _Iterated, wt.vc._Versionable, wt.vc._Versioned, wt.vc.baseline._Baselineable, Baselineable, Iterated, _SessionEditedIteration, SessionEditedIteration, Versionable, Versioned, wt.viewmarkup._Viewable, wt.viewmarkup.Viewable, wt.workflow.forum._IteratedSubjectOfForum, wt.workflow.forum._SubjectOfForum, wt.workflow.forum.IteratedSubjectOfForum, SubjectOfForum, wt.workflow.notebook._IteratedSubjectOfNotebook, wt.workflow.notebook._SubjectOfNotebook, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook

@GenAsPersistable(superClass=WTObject.class,interfaces={SerialNumberedConfiguredInstanceVersion.class,Changeable2.class,Indexable.class,IteratedLifeCycleManaged.class,Notifiable.class,SessionEditedIteration.class,wt.org.electronicIdentity.ElectronicallySignable.class,Versioned.class,wt.type.Typed.class,WTContained.class,wt.viewmarkup.Viewable.class,OrganizationOwned.class,Promotable.class,DomainAdministered.class,wt.workflow.notebook.IteratedSubjectOfNotebook.class,wt.workflow.forum.IteratedSubjectOfForum.class,PersistedCollectable.class,wt.part.WTProductInstance2TypeInterface.class},versions={7504311446815760489L,-6991023990339776343L,80599034271733757L},foreignKeys={@GeneratedForeignKey(name="ProductInstanceMasterProductInstance",foreignKeyRole=@ForeignKeyRole(name="master",type=WTProductInstanceMaster.class,supportedAPI=PUBLIC,cascade=false,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="iteration",supportedAPI=PUBLIC,cascade=false)),@GeneratedForeignKey(name="ProductInstanceConfiguration",foreignKeyRole=@ForeignKeyRole(name="configuration",type=WTProductConfiguration.class,supportedAPI=PUBLIC,cascade=false,constraints=@PropertyConstraints(required=false)),myRole=@MyRole(name="instance",cascade=false))},derivedProperties={@DerivedProperty(name="productNumber",derivedFrom="master>instanceOf>number",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="productName",derivedFrom="master>instanceOf>name",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="productDefaultUnit",derivedFrom="master>instanceOf>defaultUnit",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="configurationName",derivedFrom="configuration>adHocStringIdentifier"),@DerivedProperty(name="organizationReference",derivedFrom="master>instanceOf>organizationReference",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="organization",derivedFrom="master>instanceOf>organization",type=WTOrganization.class,supportedAPI=PUBLIC,getBody="try { return ((wt.part.WTProductInstanceMaster) getMaster()).getOrganization(); } catch (java.lang.NullPointerException npe) { return null; }",accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="mfgCageCode",derivedFrom="master>mfgCageCode",supportedAPI=PUBLIC)},tableProperties=@TableProperties(compositeUnique1="masterReference.key.id+versionInfo.identifier.versionId+iterationInfo.identifier.iterationId+sessionOwner.key.id"),iconProperties=@IconProperties(standardIcon="wtcore/images/prod_inst.gif",openIcon="wtcore/images/prod_inst.gif"))
public class WTProductInstance2
extends _WTProductInstance2

Use the newWTProductInstance2 static factory method(s), not the WTProductInstance2 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: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.part._WTProductInstance2

MFG_CAGE_CODE, ORGANIZATION, ORGANIZATION_REFERENCE, PRODUCT_DEFAULT_UNIT, PRODUCT_NAME, PRODUCT_NUMBER

Fields inherited from interface wt.vc._Iterated

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

Fields inherited from interface wt.lifecycle._LifeCycleManaged

LIFE_CYCLE_STATE, STATE

Fields inherited from interface wt.org._OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.configuration._SerialNumberedInstanceImpl

CONFIGURATION, CONFIGURATION_REFERENCE

Fields inherited from interface wt.configuration._SerialNumberedInstanceVersion

INCORPORATED, LOT_NUMBER, PLANNED_INCORPORATION, SERIAL_NUMBER

Fields inherited from interface wt.vc.sessioniteration._SessionEditedIteration

SESSION_OWNER

Fields inherited from interface wt.team._TeamManaged

TEAM_ID, TEAM_TEMPLATE_ID

Method Summary

Modifier and Type	Method	Description
String	getIncorporatedAsString()	Gets the value of the attribute: INCORPORATED_AS_STRING.
String	getLotNumber()	Gets the value of the attribute: LOT_NUMBER.
WTPrincipalReference	getMfgCageCode()	Gets the value of the attribute: MFG_CAGE_CODE.
WTOrganization	getOrganization()	Gets the value of the attribute: ORGANIZATION.
WTPrincipalReference	getOrganizationReference()	Gets the value of the attribute: ORGANIZATION_REFERENCE.
QuantityUnit	getProductDefaultUnit()	Gets the value of the attribute: PRODUCT_DEFAULT_UNIT.
String	getProductName()	Gets the value of the attribute: PRODUCT_NAME.
String	getProductNumber()	Gets the value of the attribute: PRODUCT_NUMBER.
String	getSerialNumber()	Gets the value of the attribute: SERIAL_NUMBER.
static WTProductInstance2	newWTProductInstance2(WTPartMaster instanceOf)	Static factory method to create and initialize a new WTProductInstance2 for the given WTPartMaster.
static WTProductInstance2	newWTProductInstance2(WTPartMaster instanceOf, String serialNumber)	Static factory method to create and initialize a new WTProductInstance2 for the given WTPartMaster with the given serial number.
static WTProductInstance2	newWTProductInstance2(WTPartMaster instanceOf, String serialNumber, WTProductConfiguration configuration)	Static factory method to create and initialize a new WTProductInstance2 for the given serial number and WTProductConfiguration.
static WTProductInstance2	newWTProductInstance2(WTProductConfiguration configuration)	Static factory method to create and initialize a new WTProductInstance2 for the given WTProductConfiguration.
void	setLotNumber(String a_LotNumber)	Sets the value of the attribute: LOT_NUMBER.
void	setMfgCageCode(WTPrincipalReference a_MfgCageCode)	Sets the value of the attribute: MFG_CAGE_CODE.
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	setSerialNumber(String a_SerialNumber)	Sets the value of the attribute: SERIAL_NUMBER.

Methods inherited from class wt.part._WTProductInstance2

getConfiguration, getConfigurationReference, getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIncorporated, getIterationIdentifier, getIterationNote, getLifeCycleState, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOrganizationCodingSystem, getOrganizationName, getOrganizationUniqueIdentifier, getPlannedIncorporation, getSessionOwner, getState, getTeamId, getTeamTemplateId, isLatestIteration, setConfiguration, setConfigurationReference, setIncorporated, setMaster, setMasterReference, setPlannedIncorporation, setSessionOwner

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.fc.Persistable

checkAttributes

Method Details

getProductNumber

public String getProductNumber()

Gets the value of the attribute: PRODUCT_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

Overrides:

getProductNumber in class _WTProductInstance2

Returns:

String

See Also:

• WTProductInstance2

getProductName

public String getProductName()

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

Supported API: true

Overrides:

getProductName in class _WTProductInstance2

Returns:

String

See Also:

• WTProductInstance2

getProductDefaultUnit

public QuantityUnit getProductDefaultUnit()

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

Supported API: true

Overrides:

getProductDefaultUnit in class _WTProductInstance2

Returns:

QuantityUnit

See Also:

• WTProductInstance2

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE. The organizationReference attribute represents the reference to organization for the part. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Overrides:

getOrganizationReference in class _WTProductInstance2

Returns:

WTPrincipalReference

See Also:

• WTProductInstance2

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION. The organization attribute represents the organization for the part. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Overrides:

getOrganization in class _WTProductInstance2

Returns:

WTOrganization

See Also:

• WTProductInstance2

getMfgCageCode

public WTPrincipalReference getMfgCageCode()

Gets the value of the attribute: MFG_CAGE_CODE. The mfgCageCode attribute represents the reference to the manufacturing organization for the part instance. Used to indicate the Manufacturing ID for the company that manufactured the part instance. Conceptually on the part instance, it is actually implemented on the master. Needs to be called mfgCageCode(because it has migration implications for the Windchill A&D module)

Supported API: true

Overrides:

getMfgCageCode in class _WTProductInstance2

Returns:

WTPrincipalReference

See Also:

• WTProductInstance2

setMfgCageCode

public void setMfgCageCode(WTPrincipalReference a_MfgCageCode)
                    throws WTPropertyVetoException

Sets the value of the attribute: MFG_CAGE_CODE. The mfgCageCode attribute represents the reference to the manufacturing organization for the part instance. Used to indicate the Manufacturing ID for the company that manufactured the part instance. Conceptually on the part instance, it is actually implemented on the master. Needs to be called mfgCageCode(because it has migration implications for the Windchill A&D module)

Supported API: true

Overrides:

setMfgCageCode in class _WTProductInstance2

Parameters:

a_MfgCageCode -

Throws:

WTPropertyVetoException

See Also:

• WTProductInstance2

newWTProductInstance2

public static WTProductInstance2 newWTProductInstance2(WTPartMaster instanceOf,
 String serialNumber)
                                                throws WTException

Static factory method to create and initialize a new WTProductInstance2 for the given WTPartMaster with the given serial number.

Supported API: true

Parameters:

instanceOf -

serialNumber -

Returns:

WTProductInstance2

Throws:

WTException

newWTProductInstance2

public static WTProductInstance2 newWTProductInstance2(WTPartMaster instanceOf,
 String serialNumber,
 WTProductConfiguration configuration)
                                                throws WTException

Static factory method to create and initialize a new WTProductInstance2 for the given serial number and WTProductConfiguration.

Supported API: true

Parameters:

instanceOf -

serialNumber -

configuration -

Returns:

WTProductInstance2

Throws:

WTException

getSerialNumber

public String getSerialNumber()

Gets the value of the attribute: SERIAL_NUMBER. The serial number of the master.

Supported API: true

Specified by:

getSerialNumber in interface _SerialNumberedInstanceVersion

Specified by:

getSerialNumber in interface SerialNumberedInstanceImpl

Overrides:

getSerialNumber in class _WTProductInstance2

Returns:

String

See Also:

• SerialNumberedInstanceVersion

setSerialNumber

public void setSerialNumber(String a_SerialNumber)
                     throws WTPropertyVetoException

Sets the value of the attribute: SERIAL_NUMBER. The serial number of the master.

Supported API: true

Specified by:

setSerialNumber in interface _SerialNumberedInstanceVersion

Specified by:

setSerialNumber in interface SerialNumberedInstanceImpl

Overrides:

setSerialNumber in class _WTProductInstance2

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

See Also:

• SerialNumberedInstanceVersion

getLotNumber

public String getLotNumber()

Gets the value of the attribute: LOT_NUMBER. The serial number of the master.

Supported API: true

Specified by:

getLotNumber in interface _SerialNumberedInstanceVersion

Specified by:

getLotNumber in interface SerialNumberedInstanceImpl

Overrides:

getLotNumber in class _WTProductInstance2

Returns:

String

See Also:

• SerialNumberedInstanceVersion

setLotNumber

public void setLotNumber(String a_LotNumber)
                  throws WTPropertyVetoException

Sets the value of the attribute: LOT_NUMBER. The serial number of the master.

Supported API: true

Specified by:

setLotNumber in interface _SerialNumberedInstanceVersion

Specified by:

setLotNumber in interface SerialNumberedInstanceImpl

Overrides:

setLotNumber in class _WTProductInstance2

Parameters:

a_LotNumber -

Throws:

WTPropertyVetoException

See Also:

• SerialNumberedInstanceVersion

getIncorporatedAsString

public String getIncorporatedAsString()

Gets the value of the attribute: INCORPORATED_AS_STRING. When a successor version is incorporated, its predecessor's incorporation is effectively ended. This attribute displays the incorporation as this range, so it's easier for a user to determine the actual date range this version was incorporated. If Rev A were incorporated at time X and Rev B at time Y, this attribute would return X-Y for Rev A and Y- for Rev B.

Supported API: true

Returns:

String

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

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException

newWTProductInstance2

public static WTProductInstance2 newWTProductInstance2(WTPartMaster instanceOf)
                                                throws WTException

Static factory method to create and initialize a new WTProductInstance2 for the given WTPartMaster.

Supported API: true

Returns:

WTProductInstance2

Throws:

WTException

newWTProductInstance2

public static WTProductInstance2 newWTProductInstance2(WTProductConfiguration configuration)
                                                throws WTException

Static factory method to create and initialize a new WTProductInstance2 for the given WTProductConfiguration.

Supported API: true

Returns:

WTProductInstance2

Throws:

WTException