wt.effectivity
Class WTDatedEffectivity

java.lang.Object
  wt.fc.WTObject
      wt.effectivity.DatedEffectivity
          wt.effectivity.WTDatedEffectivity

All Implemented Interfaces:

DateEff, DisplayIdentification, Eff, Effectivity, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public final class WTDatedEffectivity

extends DatedEffectivity

implements Externalizable

A WTDatedEffectivity is used to indicate that an item is effective while a configuration item is being produced during a date range. This class is represented by a table in the database. All interesting attributes are inherited from the parent class.

This description taken in part from PDM Enablers section 2.8.3.5.

Use the newWTDatedEffectivity static factory method(s), not the WTDatedEffectivity 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:

DatedEffectivity, Effectivity, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.effectivity.DatedEffectivity

CREATION, DELETION, EFF_CONTEXT, END_DATE, RANGE, START_DATE, TARGET

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.effectivity.Effectivity

CONFIG_ITEM_EFFECTIVITY_TYPE, CONFIG_ITEM_NAME, CONFIG_ITEM_REF, EFF_CONTEXT_REFERENCE, STANDARD_TARGET_REFERENCE, TARGET_REFERENCE, VERSIONED_TARGET

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.eff.Eff

CREATION_REFERENCE, DELETION_REFERENCE

Fields inherited from interface wt.eff.DateEff

EFF_CONTEXT_REFERENCE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTDatedEffectivity()

Method Summary

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.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(Timestamp startDate, Timestamp endDate) Supports initialization, following construction of an instance.
static WTDatedEffectivity	newWTDatedEffectivity() Default no argument constructor.
static WTDatedEffectivity	newWTDatedEffectivity(Timestamp startDate, Timestamp endDate) Constructs a WTDatedEffectivity object with the startDate and endDate attributes set.
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(WTDatedEffectivity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.effectivity.DatedEffectivity

getConfigItemEffectivityType, getConfigItemName, getConfigItemRef, getCreation, getCreationReference, getDeletion, getDeletionReference, getEffContext, getEffContextReference, getEndDate, getRange, getStandardTargetReference, getStartDate, getTarget, getTargetReference, getVersionedTarget, readVersion, setConfigItemRef, setCreation, setCreationReference, setDeletion, setDeletionReference, setEffContext, setEffContextReference, setEndDate, setRange, setStandardTargetReference, setStartDate, setTarget, setTargetReference, setVersionedTarget

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, 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, getIdentity, 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

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

WTDatedEffectivity

public WTDatedEffectivity()

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 DatedEffectivity

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 DatedEffectivity

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 DatedEffectivity

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

newWTDatedEffectivity

public static WTDatedEffectivity newWTDatedEffectivity(Timestamp startDate,
                                                       Timestamp endDate)
                                                throws WTException

Constructs a WTDatedEffectivity object with the startDate and endDate attributes set.

Supported API: false

Parameters:

startDate - The effective start date.

endDate - The effective end date.

Returns:

WTDatedEffectivity

Throws:

WTException

See Also:

DatedEffectivity

initialize

protected void initialize(Timestamp startDate,
                          Timestamp endDate)
                   throws WTException

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

Supported API: false

Parameters:

startDate - The effective start date.

endDate - The effective end date.

Throws:

WTException

newWTDatedEffectivity

public static WTDatedEffectivity newWTDatedEffectivity()
                                                throws WTException

Default no argument constructor.

Supported API: false

Returns:

WTDatedEffectivity

Throws:

WTException

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 DatedEffectivity

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 DatedEffectivity

Returns:

int