C F G R S

C

ClientAPI - Interface in com.qumasoft.clientapi

Define the QVCS-Enterprise client API interface.

ClientAPIContext - Interface in com.qumasoft.clientapi

Interface that defines the context for QVCS-Enterprise Client API requests.

ClientAPIException - Exception in com.qumasoft.clientapi

Exception used to report errors within the client API.

ClientAPIException() - Constructor for exception com.qumasoft.clientapi.ClientAPIException

ClientAPIException(String) - Constructor for exception com.qumasoft.clientapi.ClientAPIException

ClientAPIFactory - Class in com.qumasoft.clientapi

A factory class used to create classes that provide implementations for the ClientAPI interface and the ClientAPIContext interface.

ClientAPIFactory() - Constructor for class com.qumasoft.clientapi.ClientAPIFactory

com.qumasoft.clientapi - package com.qumasoft.clientapi

createClientAPI() - Static method in class com.qumasoft.clientapi.ClientAPIFactory

Create a class that implements the ClientAPI interface.

createClientAPIContext() - Static method in class com.qumasoft.clientapi.ClientAPIFactory

Create a class that implements the ClientAPIContext interface.

F

FileInfo - Interface in com.qumasoft.clientapi

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

G

getAppendedPath() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the appendedPath.

getAppendedPath() - Method in interface com.qumasoft.clientapi.FileInfo

Get the appended path of this file.

getAttributes() - Method in interface com.qumasoft.clientapi.FileInfo

Get the attributes for the file.

getCheckInDate() - Method in interface com.qumasoft.clientapi.RevisionInfo

Get the check in Date for this revision.

getEditDate() - Method in interface com.qumasoft.clientapi.RevisionInfo

Get the edit date for this revision.

getFileInfoList(ClientAPIContext) - Method in interface com.qumasoft.clientapi.ClientAPI

Get the list of FileInfo objects for the directory specified via the ClientAPIContext.setAppendedPath(java.lang.String) attribute on the clientAPIContext object.

getFileName() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the file name.

getIsRevisionLocked() - Method in interface com.qumasoft.clientapi.RevisionInfo

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

getIsTipRevision() - Method in interface com.qumasoft.clientapi.RevisionInfo

Get a boolean to indicate whether this revision is a tip revision.

getLastCheckInDate() - Method in interface com.qumasoft.clientapi.FileInfo

Get the Date of the most recent checkin of the tip revision for this file.

getLastEditBy() - Method in interface com.qumasoft.clientapi.FileInfo

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

getLockCount() - Method in interface com.qumasoft.clientapi.FileInfo

Get the number of revisions that are locked.

getLockedByString() - Method in interface com.qumasoft.clientapi.FileInfo

Get a String that includes the name of every user that has a revision of this file locked.

getPassword() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the password.

getPort() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the port number where the QVCS-Enterprise server is listening for connections from QVCS-Enterprise clients.

getPreserveStateFlag() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the preserveState flag.

getProjectDirectoryList(ClientAPIContext) - Method in interface com.qumasoft.clientapi.ClientAPI

Get the list of directories for the given project/view.

getProjectList(ClientAPIContext) - Method in interface com.qumasoft.clientapi.ClientAPI

Get the list of projects from the QVCS-Enterprise server.

getProjectName() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the project name.

getRecurseFlag() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the recurse flag.

getRevisionAuthor() - Method in interface com.qumasoft.clientapi.RevisionInfo

Get the name of the author of this revision.

getRevisionCount() - Method in interface com.qumasoft.clientapi.FileInfo

Get the number of revisions in this file.

getRevisionDescription() - Method in interface com.qumasoft.clientapi.RevisionInfo

Get the revision description.

getRevisionInfoList(ClientAPIContext) - Method in interface com.qumasoft.clientapi.ClientAPI

Get the list of RevisionInfo objects for the file specified by the clientAPIContext.

getRevisionLocker() - Method in interface com.qumasoft.clientapi.RevisionInfo

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

getRevisionString() - Method in interface com.qumasoft.clientapi.RevisionInfo

Get this revision's revision string.

getServerIPAddress() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the QVCS-Enterprise server IP address.

getShortWorkfileName() - Method in interface com.qumasoft.clientapi.FileInfo

Get the short workfile name of this file.

getUserName() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the user name.

getViewList(ClientAPIContext) - Method in interface com.qumasoft.clientapi.ClientAPI

Get the list of views for a given project.

getViewName() - Method in interface com.qumasoft.clientapi.ClientAPIContext

Get the view name.

R

RevisionInfo - Interface in com.qumasoft.clientapi

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

S

setAppendedPath(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the appended path.

setFileName(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the file name.

setPassword(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the password.

setPort(Integer) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the port number that the QVCS-Enterprise client API will use when attempting to establish a connection to the QVCS-Enterprise server.

setPreserveStateFlag(boolean) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the preserveState flag.

setProjectName(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the project name.

setRecurseFlag(boolean) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the recurse flag.

setServerIPAddress(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the QVCS-Enterprise server IP address.

setUserName(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the user name.

setViewName(String) - Method in interface com.qumasoft.clientapi.ClientAPIContext

Set the view name.

C F G R S