wt.epm.workspaces
Class EPMCheckpoint

java.lang.Object
  wt.fc.WTObject
      wt.epm.workspaces.EPMCheckpoint

All Implemented Interfaces:

Baseline, DisplayIdentification, ElectronicallySignable, Externalizable, Iterated, Lockable, NetFactor, NonStrictBaseline, ObjectMappable, Persistable, Serializable, Trackable

public class EPMCheckpoint

extends WTObject

implements Iterated, NonStrictBaseline, Trackable, Externalizable

The EPMCheckpoint object is the Baseline representing the current set of iterations contained within the EPMWorkspace.

In the future, to perform an undo operation, a workspace will revert to a previous interation of its checkpoint.

Use the newEPMCheckpoint static factory method(s), not the EPMCheckpoint 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 static String	CLASSNAME
private ControlBranch	controlBranch
private boolean	dirty
static long	EXTERNALIZATION_VERSION_UID
private IterationInfo	iterationInfo
private Lock	lock
static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
private ObjectReference	masterReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.baseline.NonStrictBaseline

DIRTY

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

EPMCheckpoint()

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.
EPMWorkspace	getAssociatedWorkspace() return the EPMWorkspace associated with this EPMCheckpoint.
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
String	getConceptualClassname() Deprecated.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the value of the attribute: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isDirty() Gets the value of the attribute: DIRTY.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	lockValidate(Lock a_Lock)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static EPMCheckpoint	newEPMCheckpoint() Default factory for the class.
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(EPMCheckpoint thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setDirty(boolean a_Dirty) Sets the value of the attribute: DIRTY.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
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, 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

MASTER

public static final String MASTER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

masterReference

private ObjectReference masterReference

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

dirty

private boolean dirty

lock

private Lock lock

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

EPMCheckpoint

public EPMCheckpoint()

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

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getMaster

public Mastered getMaster()

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

Supported API: false

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

initialize

protected void initialize()
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

getAssociatedWorkspace

public EPMWorkspace getAssociatedWorkspace()
                                    throws WTException

return the EPMWorkspace associated with this EPMCheckpoint.

Supported API: false

Returns:

EPMWorkspace

Throws:

WTException

newEPMCheckpoint

public static EPMCheckpoint newEPMCheckpoint()
                                      throws WTException

Default factory for the class.

Supported API: false

Returns:

EPMCheckpoint

Throws:

WTException

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: false

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: false

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: false

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: false

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: false

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: false

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: false

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: false

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: false

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: false

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: CREATOR. Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: false

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: false

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

isDirty

public boolean isDirty()

Gets the value of the attribute: DIRTY. Indicates if the non-strict baseline is dirty, i.e. has had something removed since it was created. This is intended to be set only by the BaselineService.

Supported API: false

Specified by:

isDirty in interface NonStrictBaseline

Returns:

boolean

setDirty

public void setDirty(boolean a_Dirty)
              throws WTPropertyVetoException

Sets the value of the attribute: DIRTY. Indicates if the non-strict baseline is dirty, i.e. has had something removed since it was created. This is intended to be set only by the BaselineService.

Supported API: false

Specified by:

setDirty in interface NonStrictBaseline

Parameters:

a_Dirty -

Throws:

WTPropertyVetoException

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

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