FileDocCategorySizeDatePackage
SOSCheckout.javaAPI DocApache Ant 1.703220Wed Dec 13 06:16:24 GMT 2006org.apache.tools.ant.taskdefs.optional.sos

SOSCheckout

public class SOSCheckout extends SOS
Retrieves and locks files in Visual SourceSafe via a SourceOffSite server.
ant.task
name="soscheckout" category="scm"

Fields Summary
Constructors Summary
Methods Summary
protected org.apache.tools.ant.types.CommandlinebuildCmdLine()
Build the command line
CheckOutFile required parameters: -server -name -password -database -project -file
CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome
CheckOutProject required parameters: -server -name -password -database -project
CheckOutProject optional parameters:-workdir -recursive -verbose -nocache -nocompression -soshome

return
Commandline the generated command to be executed

        commandLine = new Commandline();

        // If we find a "file" attribute then act on a file otherwise act on a project
        if (getFilename() != null) {
            // add -command CheckOutFile to the commandline
            commandLine.createArgument().setValue(SOSCmd.FLAG_COMMAND);
            commandLine.createArgument().setValue(SOSCmd.COMMAND_CHECKOUT_FILE);
            // add -file xxxxx to the commandline
            commandLine.createArgument().setValue(SOSCmd.FLAG_FILE);
            commandLine.createArgument().setValue(getFilename());
        } else {
            // add -command CheckOutProject to the commandline
            commandLine.createArgument().setValue(SOSCmd.FLAG_COMMAND);
            commandLine.createArgument().setValue(SOSCmd.COMMAND_CHECKOUT_PROJECT);
            // look for a recursive option
            commandLine.createArgument().setValue(getRecursive());
        }

        getRequiredAttributes();
        getOptionalAttributes();

        return commandLine;
public final voidsetFile(java.lang.String filename)
The filename to act upon. If no file is specified then the task acts upon the project.

param
filename The new file value

        super.setInternalFilename(filename);
public voidsetRecursive(boolean recursive)
Flag to recursively apply the action. Defaults to false.

param
recursive True for recursive operation.

        super.setInternalRecursive(recursive);