wt.scheduler
Class CountedHistory

java.lang.Object
  wt.fc.WTObject
      wt.scheduler.ScheduleHistory
          wt.scheduler.CountedHistory

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

ContReplHistory, RevaultingSession, RevaultUrlSession

public class CountedHistory

extends ScheduleHistory

implements Externalizable

A counted history is used for history items which may spawn multiple agents. The number of agents is specified by totalRuns and the number of agents who have completed their work is the numberExecuted.

Use the newCountedHistory static factory method(s), not the CountedHistory 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 static boolean	DEBUG
static long	EXTERNALIZATION_VERSION_UID
static String	NUMBER_EXECUTED Label for the attribute.
private int	numberExecuted
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TOTAL_RUNS Label for the attribute.
private int	totalRuns

Fields inherited from class wt.scheduler.ScheduleHistory

COMPLETION_TIME, EXECUTION_START_TIME, INSTANCE_STATUS, SCHEDULE_ITEM, SCHEDULE_ITEM_REFERENCE, SUBMISSION_TIME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

CountedHistory()

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.
static void	execScheduled(Serializable eventTarget, Serializable[] invocationDesc) Supported API: false
String	getConceptualClassname() Deprecated.
int	getNumberExecuted() Gets the value of the attribute: NUMBER_EXECUTED.
WTMessage	getStatusMessage() Supported API: false
int	getTotalRuns() Gets the value of the attribute: TOTAL_RUNS.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static CountedHistory	newCountedHistory() 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(CountedHistory thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setNumberExecuted(int a_NumberExecuted) Sets the value of the attribute: NUMBER_EXECUTED.
void	setTotalRuns(int a_TotalRuns) Sets the value of the attribute: TOTAL_RUNS.
String	toString() Supported API: false
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.scheduler.ScheduleHistory

getCompletionTime, getExecutionStartTime, getInstanceStatus, getScheduleItem, getScheduleItemReference, getSubmissionTime, newScheduleHistory, readVersion, setCompletionTime, setExecutionStartTime, setInstanceStatus, setScheduleItem, setScheduleItemReference, setSubmissionTime

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, 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

TOTAL_RUNS

public static final String TOTAL_RUNS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

totalRuns

private int totalRuns

NUMBER_EXECUTED

public static final String NUMBER_EXECUTED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

numberExecuted

private int numberExecuted

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

DEBUG

private static final boolean DEBUG

See Also:

Constant Field Values

Constructor Detail

CountedHistory

public CountedHistory()

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 ScheduleHistory

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 ScheduleHistory

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(CountedHistory 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 ScheduleHistory

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 ScheduleHistory

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

Overrides:

getConceptualClassname in class ScheduleHistory

Returns:

String

getTotalRuns

public int getTotalRuns()

Gets the value of the attribute: TOTAL_RUNS.

Supported API: false

Returns:

int

setTotalRuns

public void setTotalRuns(int a_TotalRuns)

Sets the value of the attribute: TOTAL_RUNS.

Supported API: false

Parameters:

a_TotalRuns -

getNumberExecuted

public int getNumberExecuted()

Gets the value of the attribute: NUMBER_EXECUTED.

Supported API: false

Returns:

int

setNumberExecuted

public void setNumberExecuted(int a_NumberExecuted)

Sets the value of the attribute: NUMBER_EXECUTED.

Supported API: false

Parameters:

a_NumberExecuted -

execScheduled

public static void execScheduled(Serializable eventTarget,
                                 Serializable[] invocationDesc)

Supported API: false

Parameters:

eventTarget -

invocationDesc -

getStatusMessage

public WTMessage getStatusMessage()

Supported API: false

Overrides:

getStatusMessage in class ScheduleHistory

Returns:

WTMessage

newCountedHistory

public static CountedHistory newCountedHistory()
                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

CountedHistory

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 ScheduleHistory

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 ScheduleHistory

Returns:

int

toString

public String toString()

Description copied from class: ScheduleHistory

Supported API: false

Overrides:

toString in class ScheduleHistory

Returns:

String