wt.part
Class ProductDateEffectivity

java.lang.Object
  wt.part.ProductDateEffectivity

All Implemented Interfaces:

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

public class ProductDateEffectivity

extends Object

implements DateEff, Externalizable

Use the newProductDateEffectivity static factory method(s), not the ProductDateEffectivity 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	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.
static String	EFF_CONTEXT_REFERENCE Label for the attribute.
private ObjectReference	effContextReference
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private DateEffRange	range
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET Label for the attribute; The target for an Eff.
private VersionReference	targetReference
private PersistInfo	thePersistInfo

Fields inherited from interface wt.eff.DateEff

RANGE

Fields inherited from interface wt.eff.Eff

CREATION_REFERENCE, DELETION_REFERENCE, TARGET_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

ProductDateEffectivity()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
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.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
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.
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().
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
EffRange	getRange() Gets the object for the association that plays role: RANGE.
EffManagedVersion	getTarget() Gets the object for the association that plays role: TARGET.
VersionReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
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() Supports initialization, following construction of an instance.
static ProductDateEffectivity	newProductDateEffectivity() Default factory for the class.
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(ProductDateEffectivity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setRange(EffRange a_Range) Sets the object for the association that plays role: RANGE.
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.
private void	targetReferenceValidate(VersionReference a_TargetReference)
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

EFF_CONTEXT

public static final String EFF_CONTEXT

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

EFF_CONTEXT_REFERENCE

public static final String EFF_CONTEXT_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

effContextReference

private ObjectReference effContextReference

range

private DateEffRange range

TARGET

public static final String TARGET

Label for the attribute; The target for an Eff.

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

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

ProductDateEffectivity

public ProductDateEffectivity()

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

getEffContext

public EffContext getEffContext()

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

Supported API: true

Specified by:

getEffContext in interface DateEff

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 DateEff

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 DateEff

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 DateEff

Parameters:

a_EffContextReference -

Throws:

WTPropertyVetoException

effContextReferenceValidate

private void effContextReferenceValidate(ObjectReference a_EffContextReference)
                                  throws WTPropertyVetoException

Parameters:

a_EffContextReference -

Throws:

WTPropertyVetoException

newProductDateEffectivity

public static ProductDateEffectivity newProductDateEffectivity()
                                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

ProductDateEffectivity

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

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

Supported API: false

Throws:

WTException

getRange

public EffRange getRange()

Gets the object for the association that plays role: RANGE. The DateEffRange for this DateEff.

Supported API: true

Specified by:

getRange in interface DateEff

Returns:

EffRange

setRange

public void setRange(EffRange a_Range)
              throws WTPropertyVetoException

Sets the object for the association that plays role: RANGE. The DateEffRange for this DateEff.

Supported API: true

Specified by:

setRange in interface DateEff

Parameters:

a_Range -

Throws:

WTPropertyVetoException

rangeValidate

private void rangeValidate(EffRange a_Range)
                    throws WTPropertyVetoException

Parameters:

a_Range -

Throws:

WTPropertyVetoException

getTarget

public EffManagedVersion getTarget()

Gets the object for the association that plays role: TARGET. The target for an Eff.

Supported API: true

Specified by:

getTarget in interface Eff

Returns:

EffManagedVersion

setTarget

public void setTarget(EffManagedVersion a_Target)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: TARGET. The target for an Eff.

Supported API: true

Specified by:

setTarget in interface Eff

Parameters:

a_Target -

Throws:

WTPropertyVetoException

WTException

getTargetReference

public VersionReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE. The target for an Eff.

Supported API: true

Specified by:

getTargetReference in interface Eff

Returns:

VersionReference

setTargetReference

public void setTargetReference(VersionReference a_TargetReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_REFERENCE. The target for an Eff.

Supported API: true

Specified by:

setTargetReference in interface Eff

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

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