wt.effectivity
Class DatedEffectivity

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

All Implemented Interfaces:

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

Direct Known Subclasses:

WTDatedEffectivity

public abstract class DatedEffectivity

extends WTObject

implements Effectivity, DateEff, Externalizable

Abstract class representing a date based effectivity. All effectivity types which result from specializing this class contain a start date and end date, and represent the time span during which some item is effective.

Supported API: true

Extendable: true

See Also:

Effectivity, Serialized Form

Field Summary

private static String	CLASSNAME
static String	CREATION Label for the attribute.
private ObjectReference	creationReference
static String	DELETION Label for the attribute.
private ObjectReference	deletionReference
static String	EFF_CONTEXT Label for the attribute.
private ObjectReference	effContextReference
static String	END_DATE Label for the attribute; The effective end date.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private DateEffRange	range
static String	RANGE Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID
private ObjectReference	standardTargetReference
static String	START_DATE Label for the attribute; The effective start date.
static String	TARGET Label for the attribute.
private VersionReference	targetReference

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

DatedEffectivity()

Method Summary

private void	creationReferenceValidate(ObjectReference a_CreationReference)
private void	deletionReferenceValidate(ObjectReference a_DeletionReference)
private void	effContextReferenceValidate(ObjectReference a_EffContextReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
EffectivityType	getConfigItemEffectivityType() Gets the value of the attribute: CONFIG_ITEM_EFFECTIVITY_TYPE.
String	getConfigItemName() Gets the value of the attribute: CONFIG_ITEM_NAME.
ConfigurationItemReference	getConfigItemRef() Gets the value of the attribute: CONFIG_ITEM_REF.
EffChangeAudit	getCreation() Gets the object for the association that plays role: CREATION.
ObjectReference	getCreationReference() Gets the value of the attribute: CREATION_REFERENCE.
EffChangeAudit	getDeletion() Gets the object for the association that plays role: DELETION.
ObjectReference	getDeletionReference() Gets the value of the attribute: DELETION_REFERENCE.
EffContext	getEffContext() Gets the object for the association that plays role: EFF_CONTEXT.
ObjectReference	getEffContextReference() Gets the value of the attribute: EFF_CONTEXT_REFERENCE.
Timestamp	getEndDate() Gets the value of the attribute: END_DATE.
EffRange	getRange() Gets the object for the association that plays role: RANGE.
ObjectReference	getStandardTargetReference() Gets the value of the attribute: STANDARD_TARGET_REFERENCE.
Timestamp	getStartDate() Gets the value of the attribute: START_DATE.
EffManagedVersion	getTarget() Gets the object for the association that plays role: TARGET.
VersionReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
VersionReference	getVersionedTarget() Gets the value of the attribute: VERSIONED_TARGET.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	rangeValidate(EffRange a_Range)
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(DatedEffectivity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setConfigItemRef(ConfigurationItemReference a_ConfigItemRef) Sets the value of the attribute: CONFIG_ITEM_REF.
void	setCreation(EffChangeAudit a_Creation) Sets the object for the association that plays role: CREATION.
void	setCreationReference(ObjectReference a_CreationReference) Sets the value of the attribute: CREATION_REFERENCE.
void	setDeletion(EffChangeAudit a_Deletion) Sets the object for the association that plays role: DELETION.
void	setDeletionReference(ObjectReference a_DeletionReference) Sets the value of the attribute: DELETION_REFERENCE.
void	setEffContext(EffContext a_EffContext) Sets the object for the association that plays role: EFF_CONTEXT.
void	setEffContextReference(ObjectReference a_EffContextReference) Sets the value of the attribute: EFF_CONTEXT_REFERENCE.
void	setEndDate(Timestamp a_EndDate) Sets the value of the attribute: END_DATE.
void	setRange(EffRange a_Range) Sets the object for the association that plays role: RANGE.
void	setStandardTargetReference(ObjectReference a_StandardTargetReference) Sets the value of the attribute: STANDARD_TARGET_REFERENCE.
void	setStartDate(Timestamp a_StartDate) Sets the value of the attribute: START_DATE.
void	setTarget(EffManagedVersion a_Target) Sets the object for the association that plays role: TARGET.
void	setTargetReference(VersionReference a_TargetReference) Sets the value of the attribute: TARGET_REFERENCE.
void	setVersionedTarget(VersionReference a_VersionedTarget) Sets the value of the attribute: VERSIONED_TARGET.
private void	standardTargetReferenceValidate(ObjectReference a_StandardTargetReference)
private void	targetReferenceValidate(VersionReference a_TargetReference)
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, 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, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

START_DATE

public static final String START_DATE

Label for the attribute; The effective start date.

Supported API: false

See Also:

Constant Field Values

END_DATE

public static final String END_DATE

Label for the attribute; The effective end date.

Supported API: false

See Also:

Constant Field Values

RANGE

public static final String RANGE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

range

private DateEffRange range

standardTargetReference

private ObjectReference standardTargetReference

EFF_CONTEXT

public static final String EFF_CONTEXT

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

effContextReference

private ObjectReference effContextReference

TARGET

public static final String TARGET

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

targetReference

private VersionReference targetReference

CREATION

public static final String CREATION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

creationReference

private ObjectReference creationReference

DELETION

public static final String DELETION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

deletionReference

private ObjectReference deletionReference

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

DatedEffectivity

public DatedEffectivity()

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(DatedEffectivity 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

getStartDate

public Timestamp getStartDate()

Gets the value of the attribute: START_DATE. The effective start date.

Supported API: false

Returns:

Timestamp

setStartDate

public void setStartDate(Timestamp a_StartDate)
                  throws WTPropertyVetoException

Sets the value of the attribute: START_DATE. The effective start date.

Supported API: false

Parameters:

a_StartDate -

Throws:

WTPropertyVetoException

getEndDate

public Timestamp getEndDate()

Gets the value of the attribute: END_DATE. The effective end date.

Supported API: false

Returns:

Timestamp

setEndDate

public void setEndDate(Timestamp a_EndDate)
                throws WTPropertyVetoException

Sets the value of the attribute: END_DATE. The effective end date.

Supported API: false

Parameters:

a_EndDate -

Throws:

WTPropertyVetoException

getRange

public EffRange getRange()

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

Supported API: true

Specified by:

getRange in interface Eff

Returns:

EffRange

setRange

public void setRange(EffRange a_Range)
              throws WTPropertyVetoException

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

Supported API: true

Specified by:

setRange in interface Eff

Parameters:

a_Range -

Throws:

WTPropertyVetoException

rangeValidate

private void rangeValidate(EffRange a_Range)
                    throws WTPropertyVetoException

Parameters:

a_Range -

Throws:

WTPropertyVetoException

getConfigItemName

public String getConfigItemName()

Gets the value of the attribute: CONFIG_ITEM_NAME. The name of the associated Configuration Item. This attribute is derived from the associated Configuration Item.

Supported API: false

Specified by:

getConfigItemName in interface Effectivity

Returns:

String

getConfigItemEffectivityType

public EffectivityType getConfigItemEffectivityType()

Gets the value of the attribute: CONFIG_ITEM_EFFECTIVITY_TYPE. The Effectivity Type of the associated Configuration Item. This attribute is derived from the associated Configuration Item.

Supported API: false

Specified by:

getConfigItemEffectivityType in interface Effectivity

Returns:

EffectivityType

getVersionedTarget

public VersionReference getVersionedTarget()

Gets the value of the attribute: VERSIONED_TARGET. A versioned, persistable object which logically holds effectivity information.

Supported API: false

Specified by:

getVersionedTarget in interface Effectivity

Returns:

VersionReference

setVersionedTarget

public void setVersionedTarget(VersionReference a_VersionedTarget)
                        throws WTPropertyVetoException

Sets the value of the attribute: VERSIONED_TARGET. A versioned, persistable object which logically holds effectivity information.

Supported API: false

Specified by:

setVersionedTarget in interface Effectivity

Parameters:

a_VersionedTarget -

Throws:

WTPropertyVetoException

getConfigItemRef

public ConfigurationItemReference getConfigItemRef()

Gets the value of the attribute: CONFIG_ITEM_REF. A reference to a Configuration Item.

Supported API: false

Specified by:

getConfigItemRef in interface Effectivity

Returns:

ConfigurationItemReference

setConfigItemRef

public void setConfigItemRef(ConfigurationItemReference a_ConfigItemRef)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONFIG_ITEM_REF. A reference to a Configuration Item.

Supported API: false

Specified by:

setConfigItemRef in interface Effectivity

Parameters:

a_ConfigItemRef -

Throws:

WTPropertyVetoException

getStandardTargetReference

public ObjectReference getStandardTargetReference()

Gets the value of the attribute: STANDARD_TARGET_REFERENCE. A non-versioned, persistable object which logically holds effectivity information.

Supported API: false

Specified by:

getStandardTargetReference in interface Effectivity

Returns:

ObjectReference

setStandardTargetReference

public void setStandardTargetReference(ObjectReference a_StandardTargetReference)
                                throws WTPropertyVetoException

Sets the value of the attribute: STANDARD_TARGET_REFERENCE. A non-versioned, persistable object which logically holds effectivity information.

Supported API: false

Specified by:

setStandardTargetReference in interface Effectivity

Parameters:

a_StandardTargetReference -

Throws:

WTPropertyVetoException

standardTargetReferenceValidate

private void standardTargetReferenceValidate(ObjectReference a_StandardTargetReference)
                                      throws WTPropertyVetoException

Parameters:

a_StandardTargetReference -

Throws:

WTPropertyVetoException

getEffContext

public EffContext getEffContext()

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

Supported API: true

Specified by:

getEffContext in interface Effectivity

Returns:

EffContext

setEffContext

public void setEffContext(EffContext a_EffContext)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: true

Specified by:

setEffContext in interface Effectivity

Parameters:

a_EffContext -

Throws:

WTPropertyVetoException

WTException

getEffContextReference

public ObjectReference getEffContextReference()

Gets the value of the attribute: EFF_CONTEXT_REFERENCE.

Supported API: true

Specified by:

getEffContextReference in interface Effectivity

Returns:

ObjectReference

setEffContextReference

public void setEffContextReference(ObjectReference a_EffContextReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: EFF_CONTEXT_REFERENCE.

Supported API: true

Specified by:

setEffContextReference in interface Effectivity

Parameters:

a_EffContextReference -

Throws:

WTPropertyVetoException

effContextReferenceValidate

private void effContextReferenceValidate(ObjectReference a_EffContextReference)
                                  throws WTPropertyVetoException

Parameters:

a_EffContextReference -

Throws:

WTPropertyVetoException

getTarget

public EffManagedVersion getTarget()

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

Supported API: true

Specified by:

getTarget in interface Effectivity

Returns:

EffManagedVersion

setTarget

public void setTarget(EffManagedVersion a_Target)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: true

Specified by:

setTarget in interface Effectivity

Parameters:

a_Target -

Throws:

WTPropertyVetoException

WTException

getTargetReference

public VersionReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE.

Supported API: true

Specified by:

getTargetReference in interface Effectivity

Returns:

VersionReference

setTargetReference

public void setTargetReference(VersionReference a_TargetReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_REFERENCE.

Supported API: true

Specified by:

setTargetReference in interface Effectivity

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

targetReferenceValidate

private void targetReferenceValidate(VersionReference a_TargetReference)
                              throws WTPropertyVetoException

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

getCreation

public EffChangeAudit getCreation()

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

Supported API: false

Specified by:

getCreation in interface Eff

Returns:

EffChangeAudit

setCreation

public void setCreation(EffChangeAudit a_Creation)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Specified by:

setCreation in interface Eff

Parameters:

a_Creation -

Throws:

WTPropertyVetoException

WTException

getCreationReference

public ObjectReference getCreationReference()

Gets the value of the attribute: CREATION_REFERENCE.

Supported API: false

Specified by:

getCreationReference in interface Eff

Returns:

ObjectReference

setCreationReference

public void setCreationReference(ObjectReference a_CreationReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: CREATION_REFERENCE.

Supported API: false

Specified by:

setCreationReference in interface Eff

Parameters:

a_CreationReference -

Throws:

WTPropertyVetoException

creationReferenceValidate

private void creationReferenceValidate(ObjectReference a_CreationReference)
                                throws WTPropertyVetoException

Parameters:

a_CreationReference -

Throws:

WTPropertyVetoException

getDeletion

public EffChangeAudit getDeletion()

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

Supported API: false

Specified by:

getDeletion in interface Eff

Returns:

EffChangeAudit

setDeletion

public void setDeletion(EffChangeAudit a_Deletion)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Specified by:

setDeletion in interface Eff

Parameters:

a_Deletion -

Throws:

WTPropertyVetoException

WTException

getDeletionReference

public ObjectReference getDeletionReference()

Gets the value of the attribute: DELETION_REFERENCE.

Supported API: false

Specified by:

getDeletionReference in interface Eff

Returns:

ObjectReference

setDeletionReference

public void setDeletionReference(ObjectReference a_DeletionReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: DELETION_REFERENCE.

Supported API: false

Specified by:

setDeletionReference in interface Eff

Parameters:

a_DeletionReference -

Throws:

WTPropertyVetoException

deletionReferenceValidate

private void deletionReferenceValidate(ObjectReference a_DeletionReference)
                                throws WTPropertyVetoException

Parameters:

a_DeletionReference -

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