wt.effectivity
Class WTProductInstance

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.effectivity.WTProductInstance

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, EffContext, Externalizable, Identified, NetFactor, Notifiable, ObjectMappable, Persistable, ProductInstance, Serializable, UniquelyIdentified

public class WTProductInstance

extends Simple

implements ProductInstance, Externalizable

Replaced by WTProductInstance2.

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

Extendable: false

See Also:

Serialized Form

Field Summary

private Timestamp	buildDate Deprecated.
private static String	CLASSNAME Deprecated.
static String	CONFIG_ITEM Deprecated.
static String	CONFIG_ITEM_REFERENCE Deprecated.
private ObjectReference	configItemReference Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
private static String	RESOURCE Deprecated.
static String	SERIAL_NUMBER Deprecated.
private static int	SERIAL_NUMBER_UPPER_LIMIT Deprecated.
private String	serialNumber Deprecated.
(package private) static long	serialVersionUID Deprecated.

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.eff.ProductInstance

BUILD_DATE, CONFIG_ITEM_DESCRIPTION, CONFIG_ITEM_NAME, SOLUTION, SOLUTION_REFERENCE

Fields inherited from interface wt.eff.EffContext

IDENTIFICATION_OBJECT

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

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.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTProductInstance()
Deprecated.

Method Summary

private void	configItemReferenceValidate(ObjectReference a_ConfigItemReference) Deprecated.
boolean	equals(Object obj) Deprecated.
Timestamp	getBuildDate() Deprecated.
String	getConceptualClassname() Deprecated.
EffConfigurationItem	getConfigItem() Deprecated.
String	getConfigItemDescription() Deprecated.
String	getConfigItemName() Deprecated.
ObjectReference	getConfigItemReference() Deprecated.
IdentificationObject	getIdentificationObject() Deprecated.
String	getIdentity() Deprecated. Gets the value of the attribute: IDENTITY.
Serializable	getSerialNumber() Deprecated.
ProductSolution	getSolution() Deprecated.
ObjectReference	getSolutionReference() Deprecated.
int	hashCode() Deprecated.
protected void	initialize(ConfigurationItem configurationItem, String serialNumber) Deprecated.
static WTProductInstance	newWTProductInstance(ConfigurationItem configurationItem, String serialNumber) Deprecated.
void	readExternal(ObjectInput input) Deprecated.
void	readExternal(PersistentRetrieveIfc input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WTProductInstance thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
private void	serialNumberValidate(Serializable a_SerialNumber) Deprecated.
void	setBuildDate(Timestamp a_BuildDate) Deprecated.
void	setConfigItem(EffConfigurationItem a_ConfigItem) Deprecated.
void	setConfigItemReference(ObjectReference a_ConfigItemReference) Deprecated.
void	setIdentificationObject(IdentificationObject a_IdentificationObject) Deprecated.
void	setSerialNumber(Serializable a_SerialNumber) Deprecated.
void	writeExternal(ObjectOutput output) Deprecated.
void	writeExternal(PersistentStoreIfc output) Deprecated.

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, 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

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

SERIAL_NUMBER

public static final String SERIAL_NUMBER

Deprecated.

Label for the attribute; Implementation of the serial number using a String.

Supported API: false

See Also:

Constant Field Values

SERIAL_NUMBER_UPPER_LIMIT

private static int SERIAL_NUMBER_UPPER_LIMIT

Deprecated.

serialNumber

private String serialNumber

Deprecated.

CONFIG_ITEM

public static final String CONFIG_ITEM

Deprecated.

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONFIG_ITEM_REFERENCE

public static final String CONFIG_ITEM_REFERENCE

Deprecated.

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

configItemReference

private ObjectReference configItemReference

Deprecated.

buildDate

private Timestamp buildDate

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

Constructor Detail

WTProductInstance

public WTProductInstance()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

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 Simple

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

Deprecated.

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

Deprecated.

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

Deprecated.

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 Simple

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Deprecated.

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 Simple

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

getSerialNumber

public Serializable getSerialNumber()

Deprecated.

Gets the value of the attribute: SERIAL_NUMBER. Implementation of the serial number using a String.

Supported API: false

Specified by:

getSerialNumber in interface ProductInstance

Returns:

Serializable

setSerialNumber

public void setSerialNumber(Serializable a_SerialNumber)
                     throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: SERIAL_NUMBER. Implementation of the serial number using a String.

Supported API: false

Specified by:

setSerialNumber in interface ProductInstance

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

serialNumberValidate

private void serialNumberValidate(Serializable a_SerialNumber)
                           throws WTPropertyVetoException

Deprecated.

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

getConfigItem

public EffConfigurationItem getConfigItem()

Deprecated.

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

Supported API: false

Specified by:

getConfigItem in interface ProductInstance

Returns:

EffConfigurationItem

setConfigItem

public void setConfigItem(EffConfigurationItem a_ConfigItem)
                   throws WTPropertyVetoException,
                          WTException

Deprecated.

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

Supported API: false

Specified by:

setConfigItem in interface ProductInstance

Parameters:

a_ConfigItem -

Throws:

WTPropertyVetoException

WTException

getConfigItemReference

public ObjectReference getConfigItemReference()

Deprecated.

Gets the value of the attribute: CONFIG_ITEM_REFERENCE.

Supported API: false

Specified by:

getConfigItemReference in interface ProductInstance

Returns:

ObjectReference

setConfigItemReference

public void setConfigItemReference(ObjectReference a_ConfigItemReference)
                            throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: CONFIG_ITEM_REFERENCE.

Supported API: false

Specified by:

setConfigItemReference in interface ProductInstance

Parameters:

a_ConfigItemReference -

Throws:

WTPropertyVetoException

configItemReferenceValidate

private void configItemReferenceValidate(ObjectReference a_ConfigItemReference)
                                  throws WTPropertyVetoException

Deprecated.

Parameters:

a_ConfigItemReference -

Throws:

WTPropertyVetoException

newWTProductInstance

public static WTProductInstance newWTProductInstance(ConfigurationItem configurationItem,
                                                     String serialNumber)
                                              throws WTException

Deprecated.

Factory for a product instance.

Supported API: false

Parameters:

configurationItem -

serialNumber -

Returns:

WTProductInstance

Throws:

WTException

initialize

protected void initialize(ConfigurationItem configurationItem,
                          String serialNumber)
                   throws WTException

Deprecated.

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

Supported API: false

Parameters:

configurationItem -

serialNumber -

Throws:

WTException

getBuildDate

public Timestamp getBuildDate()

Deprecated.

Gets the value of the attribute: BUILD_DATE. An attribute representing the date manufacture of this instance was completed. Once built, the changes to this product instance's structure -- due to maintenance, retrofits, and other activities -- can be managed using incorporation dates against the instance.

Supported API: false

Specified by:

getBuildDate in interface ProductInstance

Returns:

Timestamp

See Also:

IncorporationDate

setBuildDate

public void setBuildDate(Timestamp a_BuildDate)
                  throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: BUILD_DATE. An attribute representing the date manufacture of this instance was completed. Once built, the changes to this product instance's structure -- due to maintenance, retrofits, and other activities -- can be managed using incorporation dates against the instance.

Supported API: false

Specified by:

setBuildDate in interface ProductInstance

Parameters:

a_BuildDate -

Throws:

WTPropertyVetoException

See Also:

IncorporationDate

getConfigItemName

public String getConfigItemName()

Deprecated.

Gets the value of the attribute: CONFIG_ITEM_NAME. The name of the configuration item. It is required and must be unique.

Supported API: false

Specified by:

getConfigItemName in interface ProductInstance

Returns:

String

getConfigItemDescription

public String getConfigItemDescription()

Deprecated.

Gets the value of the attribute: CONFIG_ITEM_DESCRIPTION. A description of the configuration item.

Supported API: false

Specified by:

getConfigItemDescription in interface ProductInstance

Returns:

String

getSolution

public ProductSolution getSolution()

Deprecated.

Gets the value of the attribute: SOLUTION. The configuration item's solution.

Supported API: false

Specified by:

getSolution in interface ProductInstance

Returns:

ProductSolution

getSolutionReference

public ObjectReference getSolutionReference()

Deprecated.

Gets the value of the attribute: SOLUTION_REFERENCE. The configuration item's solution reference.

Supported API: false

Specified by:

getSolutionReference in interface ProductInstance

Returns:

ObjectReference

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Deprecated.

Gets the value of the attribute: IDENTIFICATION_OBJECT. This API must be completed by implementing classes.

The getter method should be implemented to return an IdentificationObject for use by UniquelyIdentified.

The setter method should be implemented to set the IdentificationObject back to the instance.

Supported API: false

Specified by:

getIdentificationObject in interface EffContext

Returns:

IdentificationObject

Throws:

WTException

See Also:

UniquelyIdentified, IdentificationObject

setIdentificationObject

public void setIdentificationObject(IdentificationObject a_IdentificationObject)
                             throws WTException

Deprecated.

Sets the value of the attribute: IDENTIFICATION_OBJECT. This API must be completed by implementing classes.

The getter method should be implemented to return an IdentificationObject for use by UniquelyIdentified.

The setter method should be implemented to set the IdentificationObject back to the instance.

Supported API: false

Specified by:

setIdentificationObject in interface EffContext

Parameters:

a_IdentificationObject -

Throws:

WTException

See Also:

UniquelyIdentified, IdentificationObject

equals

public boolean equals(Object obj)

Deprecated.

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 Simple

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Deprecated.

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 Simple

Returns:

int

getIdentity

public String getIdentity()

Deprecated.

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 Simple

Returns:

String