com.qumasoft.clientapi
Interface RevisionInfo

public interface RevisionInfo

This interface defines the data returned from the getRevisionInfoList method defined by the ClientAPI interface.

Method Summary

java.util.Date	getCheckInDate() Get the check in Date for this revision.
java.util.Date	getEditDate() Get the edit date for this revision.
boolean	getIsRevisionLocked() Get a boolean to indicate whether this revision is locked or not.
boolean	getIsTipRevision() Get a boolean to indicate whether this revision is a tip revision.
java.lang.String	getRevisionAuthor() Get the name of the author of this revision.
java.lang.String	getRevisionDescription() Get the revision description.
java.lang.String	getRevisionLocker() Get the name of the QVCS-Enterprise user who has locked this revision.
java.lang.String	getRevisionString() Get this revision's revision string.

Method Detail

getCheckInDate

java.util.Date getCheckInDate()

Get the check in Date for this revision. This is the time on the server when the checkin of this revision occurred.

Returns:

the server time when the checkin occurred.

getEditDate

java.util.Date getEditDate()

Get the edit date for this revision. This is the timestamp from the client workstation's copy of the file that was checked in to create this revision.

Returns:

the edit date for this revision.

getRevisionAuthor

java.lang.String getRevisionAuthor()

Get the name of the author of this revision. This is the name of the QVCS-Enterprise user who created (checked in) this revision.

Returns:

the name of the author of this revision.

getRevisionLocker

java.lang.String getRevisionLocker()

Get the name of the QVCS-Enterprise user who has locked this revision.

Returns:

the name of the QVCS-Enterprise user who has locked this revision, or an empty string if this revision is not locked.

getRevisionString

java.lang.String getRevisionString()

Get this revision's revision string. This will always be an even number of elements, like 1.5, or 1.5.1.3. A revision number is always unique for a file; i.e. there is always only one revision 1.0 in a file; there is only one revision 1.1 in a file, etc.

Returns:

the revision number of this revision.

getRevisionDescription

java.lang.String getRevisionDescription()

Get the revision description. This is the revision comment that was entered by the user as the checkin comment when they created this revision.

Returns:

the revision description.

getIsRevisionLocked

boolean getIsRevisionLocked()

Get a boolean to indicate whether this revision is locked or not.

Returns:

true if the revision is locked; false if the revision is not locked.

getIsTipRevision

boolean getIsTipRevision()

Get a boolean to indicate whether this revision is a tip revision. A tip revision is the most recent revision on a given branch.

Returns:

true if this is a tip revision; false if the revision is not the tip revision.