wt.dataops.archive
Class ArchivedIterationInfo

java.lang.Object
  wt.dataops.archive.ArchivedIterationInfo

All Implemented Interfaces:

ArchivedObjectInfo, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class ArchivedIterationInfo

extends Object

implements Persistable, ArchivedObjectInfo, Externalizable

Use the newArchivedIterationInfo static factory method(s), not the ArchivedIterationInfo 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

static String	ARCHIVED_OBJECT_IDENTIFIER Label for the attribute.
private ObjectIdentifier	archivedObjectIdentifier
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	HOLDER Label for the attribute.
private ObjectReference	holderReference
static String	ITERATION_IDENTIFIER Label for the attribute.
private IterationIdentifier	iterationIdentifier
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fc.archive.ArchivedObjectInfo

HOLDER_REFERENCE

Constructor Summary

ArchivedIterationInfo()

Method Summary

private void	archivedObjectIdentifierValidate(ObjectIdentifier a_ArchivedObjectIdentifier)
void	checkAttributes() Validate the values of this Persistable object's attributes.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ObjectIdentifier	getArchivedObjectIdentifier() Gets the value of the attribute: ARCHIVED_OBJECT_IDENTIFIER.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
ArchiveInfoHolder	getHolder() Gets the object for the association that plays role: HOLDER.
ObjectReference	getHolderReference() Gets the value of the attribute: HOLDER_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().
IterationIdentifier	getIterationIdentifier() Gets the object for the association that plays role: ITERATION_IDENTIFIER.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
static SearchCondition	getSearchCondition(ControlBranch cb)
static SearchCondition	getSearchCondition(Iterated iteration)
static SearchCondition	getSearchCondition(Iterated[] iterations)
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.
private void	holderReferenceValidate(ObjectReference a_HolderReference)
protected void	initialize(ControlBranch cb, Iterated iteration)
protected void	initialize(Iterated iteration) Supports initialization, following construction of an instance.
static boolean	isArchivedIterationInfoPresent(Iterated iteration)
boolean	isEquivalent(Archiveable object) Supported API: false
private void	iterationIdentifierValidate(IterationIdentifier a_IterationIdentifier)
static ArchivedIterationInfo	newArchivedIterationInfo(ControlBranch cb, Iterated iteration)
static ArchivedIterationInfo	newArchivedIterationInfo(Iterated iteration) 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(ArchivedIterationInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setArchivedObjectIdentifier(ObjectIdentifier a_ArchivedObjectIdentifier) Sets the value of the attribute: ARCHIVED_OBJECT_IDENTIFIER.
void	setHolder(ArchiveInfoHolder a_Holder) Sets the object for the association that plays role: HOLDER.
void	setHolderReference(ObjectReference a_HolderReference) Sets the value of the attribute: HOLDER_REFERENCE.
protected void	setIterationIdentifier(IterationIdentifier a_IterationIdentifier) Sets the object for the association that plays role: ITERATION_IDENTIFIER.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
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

ARCHIVED_OBJECT_IDENTIFIER

public static final String ARCHIVED_OBJECT_IDENTIFIER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

archivedObjectIdentifier

private ObjectIdentifier archivedObjectIdentifier

ITERATION_IDENTIFIER

public static final String ITERATION_IDENTIFIER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

iterationIdentifier

private IterationIdentifier iterationIdentifier

thePersistInfo

private PersistInfo thePersistInfo

HOLDER

public static final String HOLDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

holderReference

private ObjectReference holderReference

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

ArchivedIterationInfo

public ArchivedIterationInfo()

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

getArchivedObjectIdentifier

public ObjectIdentifier getArchivedObjectIdentifier()

Gets the value of the attribute: ARCHIVED_OBJECT_IDENTIFIER.

Supported API: false

Specified by:

getArchivedObjectIdentifier in interface ArchivedObjectInfo

Returns:

ObjectIdentifier

setArchivedObjectIdentifier

public void setArchivedObjectIdentifier(ObjectIdentifier a_ArchivedObjectIdentifier)
                                 throws WTPropertyVetoException

Sets the value of the attribute: ARCHIVED_OBJECT_IDENTIFIER.

Supported API: false

Parameters:

a_ArchivedObjectIdentifier -

Throws:

WTPropertyVetoException

archivedObjectIdentifierValidate

private void archivedObjectIdentifierValidate(ObjectIdentifier a_ArchivedObjectIdentifier)
                                       throws WTPropertyVetoException

Parameters:

a_ArchivedObjectIdentifier -

Throws:

WTPropertyVetoException

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

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

Supported API: false

Returns:

IterationIdentifier

setIterationIdentifier

protected void setIterationIdentifier(IterationIdentifier a_IterationIdentifier)
                               throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_IterationIdentifier -

Throws:

WTPropertyVetoException

iterationIdentifierValidate

private void iterationIdentifierValidate(IterationIdentifier a_IterationIdentifier)
                                  throws WTPropertyVetoException

Parameters:

a_IterationIdentifier -

Throws:

WTPropertyVetoException

newArchivedIterationInfo

public static ArchivedIterationInfo newArchivedIterationInfo(Iterated iteration)
                                                      throws WTException

Supported API: false

Parameters:

iteration -

Returns:

ArchivedIterationInfo

Throws:

WTException

initialize

protected void initialize(Iterated iteration)
                   throws WTException

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

Supported API: false

Parameters:

iteration -

Throws:

WTException

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 -

isEquivalent

public boolean isEquivalent(Archiveable object)

Supported API: false

Specified by:

isEquivalent in interface ArchivedObjectInfo

Parameters:

object -

Returns:

boolean

getHolder

public ArchiveInfoHolder getHolder()

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

Supported API: false

Specified by:

getHolder in interface ArchivedObjectInfo

Returns:

ArchiveInfoHolder

setHolder

public void setHolder(ArchiveInfoHolder a_Holder)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Specified by:

setHolder in interface ArchivedObjectInfo

Parameters:

a_Holder -

Throws:

WTPropertyVetoException

WTException

getHolderReference

public ObjectReference getHolderReference()

Gets the value of the attribute: HOLDER_REFERENCE.

Supported API: false

Specified by:

getHolderReference in interface ArchivedObjectInfo

Returns:

ObjectReference

setHolderReference

public void setHolderReference(ObjectReference a_HolderReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: HOLDER_REFERENCE.

Supported API: false

Specified by:

setHolderReference in interface ArchivedObjectInfo

Parameters:

a_HolderReference -

Throws:

WTPropertyVetoException

holderReferenceValidate

private void holderReferenceValidate(ObjectReference a_HolderReference)
                              throws WTPropertyVetoException

Parameters:

a_HolderReference -

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

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

getSearchCondition

public static SearchCondition getSearchCondition(Iterated iteration)
                                          throws WTException

Throws:

WTException

getSearchCondition

public static SearchCondition getSearchCondition(Iterated[] iterations)
                                          throws WTException

Throws:

WTException

getSearchCondition

public static SearchCondition getSearchCondition(ControlBranch cb)
                                          throws WTException

Throws:

WTException

isArchivedIterationInfoPresent

public static boolean isArchivedIterationInfoPresent(Iterated iteration)
                                              throws WTException

Throws:

WTException

initialize

protected void initialize(ControlBranch cb,
                          Iterated iteration)
                   throws WTPropertyVetoException,
                          WTException

Throws:

WTPropertyVetoException

WTException

newArchivedIterationInfo

public static ArchivedIterationInfo newArchivedIterationInfo(ControlBranch cb,
                                                             Iterated iteration)
                                                      throws WTException

Throws:

WTException