com.starteam.viewcomparemerge
Class Progress

java.lang.Object
  com.starteam.viewcomparemerge.Progress

public final class Progress
extends java.lang.Object

Information on the progress of a Merge operation from ViewMerger. This provides a snapshot of the progress at the time of request. The values in this class do not change again once the class is created. To retrieve the current progress, use ViewMerger.getProgress().

Method Summary

java.lang.String	getDescription() Returns a description of the current state of the session
int	getEstimatedPercentComplete() Returns a percentage estimate of how complete the current operation is.
long	getEstimatedTimeRemaining() Returns an estimate of the time that remains to complete the current operation.
int	getRemainingUnitsOfWork() Get the total number of operations yet to be completed.
long	getTotalTimeSpent() Get the total time spent so far (in milliseconds).
int	getTotalUnitsOfWorkCompleted() Get the total number of operations completed.
boolean	isInTransaction() Returns true if the Commit Transaction has begun for this session

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTotalUnitsOfWorkCompleted

public int getTotalUnitsOfWorkCompleted()

Get the total number of operations completed.

Returns:

Return the total number of operations completed.

getRemainingUnitsOfWork

public int getRemainingUnitsOfWork()

Get the total number of operations yet to be completed.

Returns:

Return the total number of operations yet to be completed..

getTotalTimeSpent

public long getTotalTimeSpent()

Get the total time spent so far (in milliseconds).

Returns:

Return the total time spent so far (in milliseconds).

getEstimatedTimeRemaining

public long getEstimatedTimeRemaining()

Returns an estimate of the time that remains to complete the current operation.

Returns:

an estimate of the time that remains to complete the current compare operation.

getEstimatedPercentComplete

public int getEstimatedPercentComplete()

Returns a percentage estimate of how complete the current operation is.

Returns:

a percentage estimate of how complete the current operation is.

getDescription

public java.lang.String getDescription()

Returns a description of the current state of the session

Returns:

String a description of the current state of the session

isInTransaction

public boolean isInTransaction()

Returns true if the Commit Transaction has begun for this session

Returns:

true if the Commit Transaction has begun for this session