wt.part
Class WTProductInstanceMaster

java.lang.Object
  wt.fc.WTObject
      wt.part.WTProductInstanceMaster

All Implemented Interfaces:

DisplayIdentification, Externalizable, Mastered, NetFactor, ObjectMappable, OrganizationOwned, PathOccurrenceMasterContext, Persistable, RecentlyVisited, Serializable, SerialNumberedConfiguredInstanceMaster, SerialNumberedInstanceIfc, SerialNumberedInstanceMaster, WTContained

public class WTProductInstanceMaster

extends WTObject

implements SerialNumberedConfiguredInstanceMaster, WTContained, OrganizationOwned, Externalizable

Use the newWTProductInstanceMaster static factory method(s), not the WTProductInstanceMaster 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

private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
static long	EXTERNALIZATION_VERSION_UID
static String	INSTANCE_OF Label for the attribute.
static String	INSTANCE_OF_REFERENCE Label for the attribute.
private ObjectReference	instanceOfReference
protected static long	OLD_FORMAT_VERSION_UID
static String	ORGANIZATION Label for the attribute; The organization attribute represents the organization for the part.
static String	ORGANIZATION_REFERENCE Label for the attribute; The organizationReference attribute represents the reference to organization for the part.
static String	PRODUCT_DEFAULT_UNIT Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".
static String	PRODUCT_NAME Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".
static String	PRODUCT_NUMBER Label for the attribute; The number attribute represents the number for this part and all of its versions.
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
private static int	SERIAL_NUMBER_UPPER_LIMIT
private String	serialNumber
(package private) static long	serialVersionUID
private String	series
private static int	SERIES_UPPER_LIMIT

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.configuration.SerialNumberedInstanceIfc

SERIAL_NUMBER

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.Mastered

SERIES

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTProductInstanceMaster()

Method Summary

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.
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.
String	getIdentity() Gets the value of the attribute: IDENTITY.
SerialNumbered	getInstanceOf() Gets the object for the association that plays role: INSTANCE_OF.
ObjectReference	getInstanceOfReference() Gets the value of the attribute: INSTANCE_OF_REFERENCE.
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.
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.
String	getSeries() Gets the value of the attribute: SERIES.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	instanceOfReferenceValidate(ObjectReference a_InstanceOfReference)
static WTProductInstanceMaster	newWTProductInstanceMaster() Default factory for the class.
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(WTProductInstanceMaster thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	serialNumberValidate(String a_SerialNumber)
private void	seriesValidate(String a_Series)
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	setInstanceOf(SerialNumbered a_InstanceOf) Sets the object for the association that plays role: INSTANCE_OF.
void	setInstanceOfReference(ObjectReference a_InstanceOfReference) Sets the value of the attribute: INSTANCE_OF_REFERENCE.
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.
void	setSeries(String a_Series) Sets the value of the attribute: SERIES.
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.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

PRODUCT_NUMBER

public static final String PRODUCT_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

PRODUCT_NAME

public static final String PRODUCT_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

PRODUCT_DEFAULT_UNIT

public static final String PRODUCT_DEFAULT_UNIT

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

ORGANIZATION_REFERENCE

public static final String ORGANIZATION_REFERENCE

Label for the attribute; 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

See Also:

Constant Field Values

ORGANIZATION

public static final String ORGANIZATION

Label for the attribute; The organization attribute represents the organization for the part. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

See Also:

Constant Field Values

INSTANCE_OF

public static final String INSTANCE_OF

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

INSTANCE_OF_REFERENCE

public static final String INSTANCE_OF_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

instanceOfReference

private ObjectReference instanceOfReference

SERIAL_NUMBER_UPPER_LIMIT

private static int SERIAL_NUMBER_UPPER_LIMIT

serialNumber

private String serialNumber

SERIES_UPPER_LIMIT

private static int SERIES_UPPER_LIMIT

series

private String series

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

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

WTProductInstanceMaster

public WTProductInstanceMaster()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTProductInstanceMaster 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 WTObject

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 WTObject

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

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

Returns:

String

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

Returns:

String

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

Returns:

QuantityUnit

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

Returns:

WTPrincipalReference

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

Returns:

WTOrganization

getInstanceOf

public SerialNumbered getInstanceOf()

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

Supported API: true

Specified by:

getInstanceOf in interface SerialNumberedConfiguredInstanceMaster

Returns:

SerialNumbered

setInstanceOf

public void setInstanceOf(SerialNumbered a_InstanceOf)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: true

Specified by:

setInstanceOf in interface SerialNumberedConfiguredInstanceMaster

Parameters:

a_InstanceOf -

Throws:

WTPropertyVetoException

WTException

getInstanceOfReference

public ObjectReference getInstanceOfReference()

Gets the value of the attribute: INSTANCE_OF_REFERENCE.

Supported API: true

Specified by:

getInstanceOfReference in interface SerialNumberedConfiguredInstanceMaster

Returns:

ObjectReference

setInstanceOfReference

public void setInstanceOfReference(ObjectReference a_InstanceOfReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: INSTANCE_OF_REFERENCE.

Supported API: true

Specified by:

setInstanceOfReference in interface SerialNumberedConfiguredInstanceMaster

Parameters:

a_InstanceOfReference -

Throws:

WTPropertyVetoException

instanceOfReferenceValidate

private void instanceOfReferenceValidate(ObjectReference a_InstanceOfReference)
                                  throws WTPropertyVetoException

Parameters:

a_InstanceOfReference -

Throws:

WTPropertyVetoException

newWTProductInstanceMaster

public static WTProductInstanceMaster newWTProductInstanceMaster()
                                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

WTProductInstanceMaster

Throws:

WTException

getSerialNumber

public String getSerialNumber()

Gets the value of the attribute: SERIAL_NUMBER. The serial number of the object. The serial number must be unique in the context of its serial numbered object.

Supported API: true

Specified by:

getSerialNumber in interface SerialNumberedInstanceIfc

Returns:

String

See Also:

SerialNumbered

setSerialNumber

public void setSerialNumber(String a_SerialNumber)
                     throws WTPropertyVetoException

Sets the value of the attribute: SERIAL_NUMBER. The serial number of the object. The serial number must be unique in the context of its serial numbered object.

Supported API: true

Specified by:

setSerialNumber in interface SerialNumberedInstanceIfc

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

See Also:

SerialNumbered

serialNumberValidate

private void serialNumberValidate(String a_SerialNumber)
                           throws WTPropertyVetoException

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

getSeries

public String getSeries()

Gets the value of the attribute: SERIES. Attribute for storing the Series name.

Supported API: false

Specified by:

getSeries in interface Mastered

Returns:

String

setSeries

public void setSeries(String a_Series)
               throws WTPropertyVetoException

Sets the value of the attribute: SERIES. Attribute for storing the Series name.

Supported API: false

Specified by:

setSeries in interface Mastered

Parameters:

a_Series -

Throws:

WTPropertyVetoException

seriesValidate

private void seriesValidate(String a_Series)
                     throws WTPropertyVetoException

Parameters:

a_Series -

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

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

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

setOrganizationReference in interface OrganizationOwned

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

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 WTObject

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 WTObject

Returns:

int

getIdentity

public String getIdentity()

Description copied from interface: Persistable

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class WTObject

Returns:

String