wt.scheduler
Class ScheduleHistory

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

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

CountedHistory

public class ScheduleHistory

extends WTObject

implements Externalizable

This is the history of method invocations of the schedule item.

Use the newScheduleHistory static factory method(s), not the ScheduleHistory 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
static String	COMPLETION_TIME Label for the attribute; Timestamp of when processing was completed.
private Timestamp	completionTime
static String	EXECUTION_START_TIME Label for the attribute; Timestamp of when processing was begun.
private Timestamp	executionStartTime
static long	EXTERNALIZATION_VERSION_UID
static String	INSTANCE_STATUS Label for the attribute; Reports the status of the scheduled operation.
private SchedStatusInfo	instanceStatus
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static String	SCHEDULE_ITEM Label for the attribute.
static String	SCHEDULE_ITEM_REFERENCE Label for the attribute.
(package private) static long	serialVersionUID
static String	SUBMISSION_TIME Label for the attribute; Timestamp of when job was posted to the queue.
private Timestamp	submissionTime
private ObjectReference	theScheduleItemReference

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

ScheduleHistory()

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[] invokationDesc) Supported API: false
Timestamp	getCompletionTime() Gets the value of the attribute: COMPLETION_TIME.
String	getConceptualClassname() Deprecated.
Timestamp	getExecutionStartTime() Gets the value of the attribute: EXECUTION_START_TIME.
SchedStatusInfo	getInstanceStatus() Gets the value of the attribute: INSTANCE_STATUS.
ScheduleItem	getScheduleItem() Gets the object for the association that plays role: SCHEDULE_ITEM.
ObjectReference	getScheduleItemReference() Gets the value of the attribute: SCHEDULE_ITEM_REFERENCE.
WTMessage	getStatusMessage() Supported API: false
Timestamp	getSubmissionTime() Gets the value of the attribute: SUBMISSION_TIME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static ScheduleHistory	newScheduleHistory() 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(ScheduleHistory thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCompletionTime(Timestamp a_CompletionTime) Sets the value of the attribute: COMPLETION_TIME.
void	setExecutionStartTime(Timestamp a_ExecutionStartTime) Sets the value of the attribute: EXECUTION_START_TIME.
void	setInstanceStatus(SchedStatusInfo a_InstanceStatus) Sets the value of the attribute: INSTANCE_STATUS.
void	setScheduleItem(ScheduleItem a_ScheduleItem) Sets the object for the association that plays role: SCHEDULE_ITEM.
void	setScheduleItemReference(ObjectReference a_ScheduleItemReference) Sets the value of the attribute: SCHEDULE_ITEM_REFERENCE.
void	setSubmissionTime(Timestamp a_SubmissionTime) Sets the value of the attribute: SUBMISSION_TIME.
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.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

INSTANCE_STATUS

public static final String INSTANCE_STATUS

Label for the attribute; Reports the status of the scheduled operation. In addition to the statuses possible for a regular queued object, the execution may be aborted.

Supported API: false

See Also:

Constant Field Values

instanceStatus

private SchedStatusInfo instanceStatus

SUBMISSION_TIME

public static final String SUBMISSION_TIME

Label for the attribute; Timestamp of when job was posted to the queue.

Supported API: false

See Also:

Constant Field Values

submissionTime

private Timestamp submissionTime

COMPLETION_TIME

public static final String COMPLETION_TIME

Label for the attribute; Timestamp of when processing was completed.

Supported API: false

See Also:

Constant Field Values

completionTime

private Timestamp completionTime

EXECUTION_START_TIME

public static final String EXECUTION_START_TIME

Label for the attribute; Timestamp of when processing was begun.

Supported API: false

See Also:

Constant Field Values

executionStartTime

private Timestamp executionStartTime

SCHEDULE_ITEM

public static final String SCHEDULE_ITEM

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SCHEDULE_ITEM_REFERENCE

public static final String SCHEDULE_ITEM_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theScheduleItemReference

private ObjectReference theScheduleItemReference

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

ScheduleHistory

public ScheduleHistory()

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

getInstanceStatus

public SchedStatusInfo getInstanceStatus()

Gets the value of the attribute: INSTANCE_STATUS. Reports the status of the scheduled operation. In addition to the statuses possible for a regular queued object, the execution may be aborted.

Supported API: false

Returns:

SchedStatusInfo

setInstanceStatus

public void setInstanceStatus(SchedStatusInfo a_InstanceStatus)

Sets the value of the attribute: INSTANCE_STATUS. Reports the status of the scheduled operation. In addition to the statuses possible for a regular queued object, the execution may be aborted.

Supported API: false

Parameters:

a_InstanceStatus -

getSubmissionTime

public Timestamp getSubmissionTime()

Gets the value of the attribute: SUBMISSION_TIME. Timestamp of when job was posted to the queue.

Supported API: false

Returns:

Timestamp

setSubmissionTime

public void setSubmissionTime(Timestamp a_SubmissionTime)

Sets the value of the attribute: SUBMISSION_TIME. Timestamp of when job was posted to the queue.

Supported API: false

Parameters:

a_SubmissionTime -

getCompletionTime

public Timestamp getCompletionTime()

Gets the value of the attribute: COMPLETION_TIME. Timestamp of when processing was completed.

Supported API: false

Returns:

Timestamp

setCompletionTime

public void setCompletionTime(Timestamp a_CompletionTime)

Sets the value of the attribute: COMPLETION_TIME. Timestamp of when processing was completed.

Supported API: false

Parameters:

a_CompletionTime -

getExecutionStartTime

public Timestamp getExecutionStartTime()

Gets the value of the attribute: EXECUTION_START_TIME. Timestamp of when processing was begun.

Supported API: false

Returns:

Timestamp

setExecutionStartTime

public void setExecutionStartTime(Timestamp a_ExecutionStartTime)

Sets the value of the attribute: EXECUTION_START_TIME. Timestamp of when processing was begun.

Supported API: false

Parameters:

a_ExecutionStartTime -

getScheduleItem

public ScheduleItem getScheduleItem()

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

Supported API: false

Returns:

ScheduleItem

setScheduleItem

public void setScheduleItem(ScheduleItem a_ScheduleItem)
                     throws WTException

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

Supported API: false

Parameters:

a_ScheduleItem -

Throws:

WTException

getScheduleItemReference

public ObjectReference getScheduleItemReference()

Gets the value of the attribute: SCHEDULE_ITEM_REFERENCE.

Supported API: false

Returns:

ObjectReference

setScheduleItemReference

public void setScheduleItemReference(ObjectReference a_ScheduleItemReference)

Sets the value of the attribute: SCHEDULE_ITEM_REFERENCE.

Supported API: false

Parameters:

a_ScheduleItemReference -

toString

public String toString()

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

execScheduled

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

Supported API: false

Parameters:

eventTarget -

invokationDesc -

getStatusMessage

public WTMessage getStatusMessage()

Supported API: false

Returns:

WTMessage

newScheduleHistory

public static ScheduleHistory newScheduleHistory()
                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

ScheduleHistory

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