wt.fv.master
Class ContReplHistory

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.scheduler.ScheduleHistory
          extended bywt.scheduler.CountedHistory
              extended bywt.fv.master.ContReplHistory
All Implemented Interfaces:
DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class ContReplHistory
extends CountedHistory
implements Externalizable

Use the newContReplHistory static factory method(s), not the ContReplHistory 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 long EXTERNALIZATION_VERSION_UID
           
static String NUM_ERROR_EXECUTED
          Label for the attribute.
private  int numErrorExecuted
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.scheduler.CountedHistory
NUMBER_EXECUTED, TOTAL_RUNS
 
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
ContReplHistory()
           
 
Method Summary
 ContReplHistory checkForCompletition()
           
 ContReplHistory decrementTotalRuns()
          Decrements total number of elements to be moved in the given Replication Session.
 boolean equals(Object obj)
          Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
 String getConceptualClassname()
          Deprecated.  
 int getNumErrorExecuted()
          Gets the value of the attribute: NUM_ERROR_EXECUTED.
 String getSessionStatus()
          

Supported API: false
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
 ContReplHistory incrementErrorRuns()
          Increments number of failed "replicate" operations.
 ContReplHistory incrementExecutedRuns()
          Increments number of successfully moved items May ONLY be used inside a Transaction!!!

Supported API: false
 boolean isReplicationInProgress()
          Checkswhether the current replication session is in progress

Supported API: false
static ContReplHistory newContReplHistory()
          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(ContReplHistory thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setNumErrorExecuted(int a_NumErrorExecuted)
          Sets the value of the attribute: NUM_ERROR_EXECUTED.
 ContReplHistory updateSessionStatus(String curStatus)
          Updates status of the given Replication Session.
 ContReplHistory updateTotalElem(int totalR)
          Sets total number of elements to be moved in the given Replication Session.
 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.CountedHistory
execScheduled, getNumberExecuted, getStatusMessage, getTotalRuns, newCountedHistory, readVersion, setNumberExecuted, setTotalRuns, toString
 
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

NUM_ERROR_EXECUTED

public static final String NUM_ERROR_EXECUTED
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

numErrorExecuted

private int numErrorExecuted

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

ContReplHistory

public ContReplHistory()
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 CountedHistory
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 CountedHistory
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(ContReplHistory 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 CountedHistory
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 CountedHistory
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 CountedHistory
Returns:
String

getNumErrorExecuted

public int getNumErrorExecuted()
Gets the value of the attribute: NUM_ERROR_EXECUTED.

Supported API: false

Returns:
int

setNumErrorExecuted

public void setNumErrorExecuted(int a_NumErrorExecuted)
Sets the value of the attribute: NUM_ERROR_EXECUTED.

Supported API: false

Parameters:
a_NumErrorExecuted -

incrementExecutedRuns

public ContReplHistory incrementExecutedRuns()
                                      throws WTException
Increments number of successfully moved items May ONLY be used inside a Transaction!!!

Supported API: false

Returns:
ContReplHistory
Throws:
WTException

incrementErrorRuns

public ContReplHistory incrementErrorRuns()
                                   throws WTException
Increments number of failed "replicate" operations. May ONLY be used inside a Transaction!!!

Supported API: false

Returns:
ContReplHistory
Throws:
WTException

decrementTotalRuns

public ContReplHistory decrementTotalRuns()
                                   throws WTException
Decrements total number of elements to be moved in the given Replication Session. May ONLY be used inside a Transaction!!!

Supported API: false

Returns:
ContReplHistory
Throws:
WTException

updateTotalElem

public ContReplHistory updateTotalElem(int totalR)
                                throws WTException
Sets total number of elements to be moved in the given Replication Session. May ONLY be used inside a Transaction!!!

Supported API: false

Parameters:
totalR -
Returns:
ContReplHistory
Throws:
WTException

updateSessionStatus

public ContReplHistory updateSessionStatus(String curStatus)
                                    throws WTException
Updates status of the given Replication Session. May ONLY be used inside a Transaction!!!

Supported API: false

Parameters:
curStatus -
Returns:
ContReplHistory
Throws:
WTException

getSessionStatus

public String getSessionStatus()
                        throws WTException


Supported API: false

Returns:
String
Throws:
WTException

isReplicationInProgress

public boolean isReplicationInProgress()
                                throws WTException
Checkswhether the current replication session is in progress

Supported API: false

Returns:
boolean
Throws:
WTException

newContReplHistory

public static ContReplHistory newContReplHistory()
                                          throws WTException
Default factory for the class.

Supported API: false

Returns:
ContReplHistory
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 CountedHistory
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 CountedHistory
Returns:
int

checkForCompletition

public ContReplHistory checkForCompletition()
                                     throws WTException
Throws:
WTException