wt.part
Class WTSerialNumberedPartInstance

java.lang.Object
  wt.part.WTSerialNumberedPartInstance

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable, SerialNumberedComponentInstance, SerialNumberedInstanceIfc, SerialNumberedInstanceImpl

public class WTSerialNumberedPartInstance

extends Object

implements SerialNumberedComponentInstance, Externalizable

Use the newWTSerialNumberedPartInstance static factory method(s), not the WTSerialNumberedPartInstance 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	CONFIGURATION Label for the attribute.
static String	CONFIGURATION_REFERENCE Label for the attribute.
private VersionReference	configurationReference
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
private static String	RESOURCE
private static int	SERIAL_NUMBER_UPPER_LIMIT
private String	serialNumber
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.configuration.SerialNumberedComponentInstance

SERIAL_NUMBER

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

WTSerialNumberedPartInstance()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	configurationReferenceValidate(VersionReference a_ConfigurationReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
Configuration	getConfiguration() Gets the object for the association that plays role: CONFIGURATION.
VersionReference	getConfigurationReference() Gets the value of the attribute: CONFIGURATION_REFERENCE.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
SerialNumbered	getInstanceOf() Gets the object for the association that plays role: INSTANCE_OF.
ObjectReference	getInstanceOfReference() Gets the value of the attribute: INSTANCE_OF_REFERENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getSerialNumber() Gets the value of the attribute: SERIAL_NUMBER.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String serialNumber, WTSerialNumberedPart configuration) Supports initialization, following construction of an instance.
protected void	initialize(String serialNumber, WTSerialNumberedPartMaster instanceOf) Supports initialization, following construction of an instance.
private void	instanceOfReferenceValidate(ObjectReference a_InstanceOfReference)
static WTSerialNumberedPartInstance	newWTSerialNumberedPartInstance(String serialNumber, WTSerialNumberedPart configuration) Supported API: false
static WTSerialNumberedPartInstance	newWTSerialNumberedPartInstance(String serialNumber, WTSerialNumberedPartMaster instanceOf) Supported API: false
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(WTSerialNumberedPartInstance 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)
void	setConfiguration(Configuration a_Configuration) Sets the object for the association that plays role: CONFIGURATION.
void	setConfigurationReference(VersionReference a_ConfigurationReference) Sets the value of the attribute: CONFIGURATION_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	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setSerialNumber(String a_SerialNumber) Sets the value of the attribute: SERIAL_NUMBER.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CONFIGURATION

public static final String CONFIGURATION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

CONFIGURATION_REFERENCE

public static final String CONFIGURATION_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

configurationReference

private VersionReference configurationReference

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

thePersistInfo

private PersistInfo thePersistInfo

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

Constructor Detail

WTSerialNumberedPartInstance

public WTSerialNumberedPartInstance()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getConfiguration

public Configuration getConfiguration()

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

Supported API: true

Specified by:

getConfiguration in interface SerialNumberedComponentInstance

Returns:

Configuration

setConfiguration

public void setConfiguration(Configuration a_Configuration)
                      throws WTPropertyVetoException,
                             WTException

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

Supported API: true

Specified by:

setConfiguration in interface SerialNumberedComponentInstance

Parameters:

a_Configuration -

Throws:

WTPropertyVetoException

WTException

getConfigurationReference

public VersionReference getConfigurationReference()

Gets the value of the attribute: CONFIGURATION_REFERENCE.

Supported API: true

Specified by:

getConfigurationReference in interface SerialNumberedComponentInstance

Returns:

VersionReference

setConfigurationReference

public void setConfigurationReference(VersionReference a_ConfigurationReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: CONFIGURATION_REFERENCE.

Supported API: true

Specified by:

setConfigurationReference in interface SerialNumberedComponentInstance

Parameters:

a_ConfigurationReference -

Throws:

WTPropertyVetoException

configurationReferenceValidate

private void configurationReferenceValidate(VersionReference a_ConfigurationReference)
                                     throws WTPropertyVetoException

Parameters:

a_ConfigurationReference -

Throws:

WTPropertyVetoException

getInstanceOf

public SerialNumbered getInstanceOf()

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

Supported API: true

Specified by:

getInstanceOf in interface SerialNumberedComponentInstance

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 SerialNumberedComponentInstance

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 SerialNumberedComponentInstance

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 SerialNumberedComponentInstance

Parameters:

a_InstanceOfReference -

Throws:

WTPropertyVetoException

instanceOfReferenceValidate

private void instanceOfReferenceValidate(ObjectReference a_InstanceOfReference)
                                  throws WTPropertyVetoException

Parameters:

a_InstanceOfReference -

Throws:

WTPropertyVetoException

newWTSerialNumberedPartInstance

public static WTSerialNumberedPartInstance newWTSerialNumberedPartInstance(String serialNumber,
                                                                           WTSerialNumberedPart configuration)
                                                                    throws WTException

Supported API: false

Parameters:

serialNumber -

configuration -

Returns:

WTSerialNumberedPartInstance

Throws:

WTException

initialize

protected void initialize(String serialNumber,
                          WTSerialNumberedPart configuration)
                   throws WTException

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

Supported API: false

Parameters:

serialNumber -

configuration -

Throws:

WTException

newWTSerialNumberedPartInstance

public static WTSerialNumberedPartInstance newWTSerialNumberedPartInstance(String serialNumber,
                                                                           WTSerialNumberedPartMaster instanceOf)
                                                                    throws WTException

Supported API: false

Parameters:

serialNumber -

instanceOf -

Returns:

WTSerialNumberedPartInstance

Throws:

WTException

initialize

protected void initialize(String serialNumber,
                          WTSerialNumberedPartMaster instanceOf)
                   throws WTException

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

Supported API: false

Parameters:

serialNumber -

instanceOf -

Throws:

WTException

getSerialNumber

public String getSerialNumber()

Gets the value of the attribute: SERIAL_NUMBER.

Supported API: false

Specified by:

getSerialNumber in interface SerialNumberedComponentInstance

Returns:

String

setSerialNumber

public void setSerialNumber(String a_SerialNumber)
                     throws WTPropertyVetoException

Sets the value of the attribute: SERIAL_NUMBER.

Supported API: false

Specified by:

setSerialNumber in interface SerialNumberedComponentInstance

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

serialNumberValidate

private void serialNumberValidate(String a_SerialNumber)
                           throws WTPropertyVetoException

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

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

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

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

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int