com.segue.scc.published.api.vcs

Interface VersionControlProfile

All Superinterfaces:

BrowseableProfile, SourceControlProfile

public interface VersionControlProfile
extends SourceControlProfile

Adds checkin, checkout and label support to the SourceControlProfile

Field Summary

Fields inherited from interface com.segue.scc.published.api.vcs.SourceControlProfile

PLUGIN_NAME

Fields inherited from interface com.segue.scc.published.api.vcs.BrowseableProfile

TYPE_FILE, TYPE_PROJECT, TYPE_RETRIEVE

Method Summary

Modifier and Type	Method and Description
void	checkIn(java.lang.String filePath, java.lang.String checkoutPath, java.lang.String versionLabel, java.lang.String comment) Upload a local (checked out) file to the source control system.
void	checkOut(java.lang.String filePath, java.lang.String targetPath, java.lang.String comment, boolean getLocalCopy) Checkout means to lock a file in the source control system for exclusive access.
void	createWorkingDirectory(java.io.File workdir, java.lang.String label) Deprecated. not used anymore
void	get(java.lang.String filePath, java.lang.String targetPath, boolean recursive, java.lang.String label)
java.lang.String[]	getLabels(java.lang.String filePath, java.lang.String pattern) Deprecated. not used anymore

Methods inherited from interface com.segue.scc.published.api.vcs.SourceControlProfile

addFile, addFiles, cleanupWorkingDirectory, createWorkingDirectory, get, getLastName, getName, getParent, getPropertyProvider, getSourceCodeControlInfo, getStringResolver, removeWorkingDirectory, updateRepository, validateProfileSettings

Methods inherited from interface com.segue.scc.published.api.vcs.BrowseableProfile

addDirectory, buildPath, getRootPath, getSeparator, isValidProjectName, list

Method Detail

checkOut

void checkOut(java.lang.String filePath,
              java.lang.String targetPath,
              java.lang.String comment,
              boolean getLocalCopy)
       throws SourceControlException

Checkout means to lock a file in the source control system for exclusive access. The real need for this method is, that in some source control systems, only checked out files can be checked in.

Parameters:

filePath -

targetPath - This optional parameter is a string value set to the complete local path to which you want to check the file out. This path includes the file name that you wish to check out.

comment -

getLocalCopy - if true existing local files will be overwritten

Throws:

SourceControlException

checkIn

void checkIn(java.lang.String filePath,
             java.lang.String checkoutPath,
             java.lang.String versionLabel,
             java.lang.String comment)
      throws SourceControlException

Upload a local (checked out) file to the source control system.

Parameters:

filePath -

checkoutPath -

versionLabel -

comment -

Throws:

SourceControlException

get

void get(java.lang.String filePath,
         java.lang.String targetPath,
         boolean recursive,
         java.lang.String label)
  throws SourceControlException

Throws:

SourceControlException

getLabels

@Deprecated
java.lang.String[] getLabels(java.lang.String filePath,
                                          java.lang.String pattern)
                                   throws SourceControlException

Deprecated. not used anymore

Throws:

SourceControlException

createWorkingDirectory

@Deprecated
void createWorkingDirectory(java.io.File workdir,
                                         java.lang.String label)
                                  throws SourceControlException

Deprecated. not used anymore

Throws:

SourceControlException