com.webmethods.vcs

Interface VCSClient

All Known Implementing Classes:

AbstractClient

public interface VCSClient

This class defines a set of contracts that any VCS should implement.

Method Summary

Modifier and Type	Method and Description
void	checkin(java.util.List fileNames, java.lang.String description) Checks the files into the VCS.
void	checkout(java.util.List fileNames) Checks out the files from the VCS along with a list of file names referring to the elements in the VCS that should be checked out.
void	delete(boolean isPredelete, java.util.List fileNames, java.lang.String comment) Deletes a list of files from the VCS.
java.util.List	getInfo() Returns general VCS information.
java.util.List	getLog(java.lang.String fileName) Returns the log for the given file from the version control system.
boolean	isCheckedOut(java.lang.String fileName) Indicates whether the given file is checked out of the VCS.
void	load(java.util.List dirNames, java.util.List fileNames) Loads the current version of the elements, directories, and files recursively.
void	load(java.util.List dirNames, java.util.List fileNames, java.util.Date date) Loads the directories by date.
void	load(java.util.List dirNames, java.util.List fileNames, java.lang.String revision, boolean isInterface) Loads the directories by revision.
void	loadByLabel(java.util.List dirNames, java.util.List fileNames, java.lang.String label) Loads working copies of the directories by label.
boolean	mustDeleteBeforeLoad() Indicates whether this client must delete existing files before loading a new copy from the VCS.
void	revert(java.util.List fileNames) Reverts the given files.

Method Detail

getInfo

java.util.List getInfo()
                throws VCSException

Returns general VCS information. It returns information like vendor, version, and other general information about the VCS.

Throws:

VCSException

checkout

void checkout(java.util.List fileNames)
       throws VCSException

Checks out the files from the VCS along with a list of file names referring to the elements in the VCS that should be checked out.

Throws:

VCSException

getLog

java.util.List getLog(java.lang.String fileName)
               throws VCSException

Returns the log for the given file from the version control system. The log is a list of responses from the version control on the file.

Throws:

VCSException

checkin

void checkin(java.util.List fileNames,
             java.lang.String description)
      throws VCSException

Checks the files into the VCS.

Throws:

VCSException

load

void load(java.util.List dirNames,
          java.util.List fileNames,
          java.util.Date date)
   throws VCSException

Loads the directories by date. The working copy from the VCS is retrieved by date. It does not lock any element in VCS.

Throws:

VCSException

load

void load(java.util.List dirNames,
          java.util.List fileNames,
          java.lang.String revision,
          boolean isInterface)
   throws VCSException

Loads the directories by revision. The working copy from the VCS is retrieved using revision assigned to the element in VCS. It does not lock any element in VCS.

Throws:

VCSException

load

void load(java.util.List dirNames,
          java.util.List fileNames)
   throws VCSException

Loads the current version of the elements, directories, and files recursively. It does not lock any element in VCS.

Throws:

VCSException

loadByLabel

void loadByLabel(java.util.List dirNames,
                 java.util.List fileNames,
                 java.lang.String label)
          throws VCSException

Loads working copies of the directories by label. The working copy from the VCS is retrieved using label assigned to the element in VCS. It does not lock any element in VCS.

Throws:

VCSException

delete

void delete(boolean isPredelete,
            java.util.List fileNames,
            java.lang.String comment)
     throws VCSException

Deletes a list of files from the VCS. Any reasons for deletion should be passed as comment.

Throws:

VCSException

revert

void revert(java.util.List fileNames)
     throws VCSException

Reverts the given files.

Throws:

VCSException

isCheckedOut

boolean isCheckedOut(java.lang.String fileName)
              throws VCSException

Indicates whether the given file is checked out of the VCS.

Throws:

VCSException

mustDeleteBeforeLoad

boolean mustDeleteBeforeLoad()
                      throws VCSException

Indicates whether this client must delete existing files before loading a new copy from the VCS.

Throws:

VCSException