com.qumasoft.clientapi
Interface FileInfo


public interface FileInfo

Interface that defines the content of the data elements returned from the ClientAPI.getFileInfoList(ClientAPIContext) method.


Method Summary
 java.lang.String getAppendedPath()
          Get the appended path of this file.
 java.lang.String getAttributes()
          Get the attributes for the file.
 java.util.Date getLastCheckInDate()
          Get the Date of the most recent checkin of the tip revision for this file.
 java.lang.String getLastEditBy()
          Get the name of the QVCS-Enterprise user who last checked in a revision to this file.
 int getLockCount()
          Get the number of revisions that are locked.
 java.lang.String getLockedByString()
          Get a String that includes the name of every user that has a revision of this file locked.
 int getRevisionCount()
          Get the number of revisions in this file.
 java.lang.String getShortWorkfileName()
          Get the short workfile name of this file.
 

Method Detail

getAttributes

java.lang.String getAttributes()
Get the attributes for the file. This is returned as a String of YES/NO values that indicate the value of the QVCS attributes for this file. The attributes appear in the following order:
  1. Check locks
  2. Delete workfile
  3. Expand keywords
  4. Protect archive file. This attribute does not have much value/meaning for the QVCS-Enterprise product, since all archive files are stored on the server machine. It is a 'legacy' attribute that was included in the product so that archive files are compatible with QVCS/QVCS-Pro archive files.
  5. Protect workfile
  6. Log actions to separate journal file.
  7. Compress revisions
  8. Binary file
  9. Auto-merge flag (not implemented)
  10. Do not compute a delta flag
  11. Store only the last revision flag (not implemented)
For example, the value returned for this might look like: YES,NO,NO,NO,YES,YES,YES,NO,NO,NO,NO which is the default attribute settings for a .java file. The meaning of this string would be:
  1. YES - lock checking is enabled for this file
  2. NO - do not delete the workfile after a checkin operation.
  3. NO - do not expand keywords.
  4. NO - do not protect the archive file.
  5. YES - write protect the workfile after checkin, or after a get operation.
  6. YES - add an entry to the server's journal file for any version control operation performed on this file.
  7. YES - compress the revisions of the archive file.
  8. NO - this is not a binary file.
  9. NO - do not perform an auto-merge on this file. This is a feature that has not yet been implemented (and may never be implemented, since merge is a tricky area).
  10. NO - compute a delta for this file. (This is a double negative type flag, so a NO value means compute a delta, and a YES value means do not compute a delta)
  11. NO - store more than just the last revision. The ability to store just a single revision has not yet been implemented.

Returns:
a String of YES/NO values that describe the QVCS-Enterprise attributes for this file.

getLastCheckInDate

java.util.Date getLastCheckInDate()
Get the Date of the most recent checkin of the tip revision for this file.

Returns:
the Date when the tip revision was created.

getLastEditBy

java.lang.String getLastEditBy()
Get the name of the QVCS-Enterprise user who last checked in a revision to this file.

Returns:
the name of the QVCS-Enterprise user who last checked in a revision to this file.

getLockCount

int getLockCount()
Get the number of revisions that are locked. This will typically be 0 or 1.

Returns:
the number of revisions that are locked.

getLockedByString

java.lang.String getLockedByString()
Get a String that includes the name of every user that has a revision of this file locked. If there are no locks on this file, then this will be an empty String.

Returns:
a String that includes the name of every user that has a revision locked.

getRevisionCount

int getRevisionCount()
Get the number of revisions in this file.

Returns:
the number of revision in this file.

getShortWorkfileName

java.lang.String getShortWorkfileName()
Get the short workfile name of this file. This will be the file name as it would appear on a client workstation, without any directory elements to the filename.

Returns:
the short workfile name of this file.

getAppendedPath

java.lang.String getAppendedPath()
Get the appended path of this file. This identifies the directory that contains this file.

Returns:
the appended path of this file; i.e. the project relative path of the the directory that contains this file.