BaseJob (VectorCAST Execution 0.24 API)

java.lang.Object
- com.vectorcast.plugins.vectorcastexecution.job.BaseJob

Direct Known Subclasses:

DeleteJobs, NewMultiJob, NewMultiJobUpdate, NewSingleJob
```
public abstract class BaseJob
extends Object
```
Base job management - create/delete/update

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseJob(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response, boolean useSavedData)` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addArchiveArtifacts(hudson.model.Project project)` Add archive artifacts step
`protected void`	`addDeleteWorkspaceBeforeBuildStarts(hudson.model.Project project)` Add the delete workspace before build starts option
`protected VectorCASTSetup`	`addSetup(hudson.model.Project project)` Add the VectorCAST setup step to copy the python scripts to the workspace
`protected void`	`addVCCoverage(hudson.model.Project project)` Add VectorCAST coverage reporting step
`protected void`	`addXunit(hudson.model.Project project)` Add XUnit rules step
`protected abstract void`	`cleanupProject()` Cleanup top-level project, as in delete
`void`	`create(boolean update)` Create the job(s)
`protected abstract hudson.model.Project`	`createProject()` Create top-level project
`protected abstract void`	`doCreate(boolean update)` Do create of project details
`protected String`	`getBaseName()` Get base name of manage project
`protected String`	`getEnvironmentSetupUnix()` Get environment setup for unix
`protected String`	`getEnvironmentSetupWin()` Get environment setup for windows
`protected String`	`getEnvironmentTeardownUnix()` Get environment tear down for unix
`protected String`	`getEnvironmentTeardownWin()` Get environment tear down for windows
`protected String`	`getExecutePreambleUnix()` Get execute preamble for unix
`protected String`	`getExecutePreambleWin()` Get execute preamble for windows
`protected jenkins.model.Jenkins`	`getInstance()` Get Jenkins instance
`protected String`	`getManageProjectName()` Get manage project name
`protected boolean`	`getOptionClean()` Get option to clean workspace before build
`protected String`	`getOptionErrorLevel()` Get error level
`protected boolean`	`getOptionExecutionReport()` Use execution report
`protected String`	`getOptionHTMLBuildDesc()` Use HTML Build Description
`protected boolean`	`getOptionUseReporting()` Get use Jenkins reporting option
`protected org.kohsuke.stapler.StaplerRequest`	`getRequest()` Get request
`protected org.kohsuke.stapler.StaplerResponse`	`getResponse()` Get response
`protected hudson.model.Project`	`getTopProject()` Get top-level project
`protected boolean`	`isUsingSCM()` Using some form of SCM
`protected void`	`setEnvironmentSetupUnix(String environmentSetupUnix)` Set environment setup for unix
`protected void`	`setEnvironmentSetupWin(String environmentSetupWin)` Set environment setup for windows
`protected void`	`setEnvironmentTeardownUnix(String environmentTeardownUnix)` Set environment teardown for unix
`protected void`	`setEnvironmentTeardownWin(String environmentTeardownWin)` Set environment tear down for windows
`protected void`	`setExecutePreambleUnix(String executePreambleUnix)` Set execute preamble for unix
`protected void`	`setExecutePreambleWin(String executePreambleWin)` Set execute preamble for windows
`protected void`	`setOptionClean(boolean optionClean)` Set option to clean workspace before build
`protected void`	`setOptionErrorLevel(String optionErrorLevel)` Set option error level
`protected void`	`setOptionExecutionReport(boolean optionExecutionReport)` Set use execution report
`protected void`	`setOptionHTMLBuildDesc(String optionHtmlBuildDesc)` Set use HTML Build description
`protected void`	`setOptionUseReporting(boolean optionUseReporting)` Set use Jenkins reporting option
`protected void`	`setUsingSCM(boolean usingSCM)` Set using some form of SCM
`void`	`useSavedData(VectorCASTSetup savedData)` Use Saved Data

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseJob
```
protected BaseJob(org.kohsuke.stapler.StaplerRequest request,
                  org.kohsuke.stapler.StaplerResponse response,
                  boolean useSavedData)
           throws javax.servlet.ServletException,
                  IOException
```
    Constructor
    
    Parameters:
    
    request - request object
    
    response - response object
    
    useSavedData - use saved data true/false
    
    Throws:
    
    javax.servlet.ServletException - exception
    
    IOException - exception
- Method Detail
  - useSavedData
```
public void useSavedData(VectorCASTSetup savedData)
```
    Use Saved Data
    
    Parameters:
    
    savedData - saved data to use
  - isUsingSCM
```
protected boolean isUsingSCM()
```
    Using some form of SCM
    
    Returns:
    
    true or false
  - setUsingSCM
```
protected void setUsingSCM(boolean usingSCM)
```
    Set using some form of SCM
    
    Parameters:
    
    usingSCM - true/false
  - getEnvironmentSetupWin
```
protected String getEnvironmentSetupWin()
```
    Get environment setup for windows
    
    Returns:
    
    setup
  - setEnvironmentSetupWin
```
protected void setEnvironmentSetupWin(String environmentSetupWin)
```
    Set environment setup for windows
    
    Parameters:
    
    environmentSetupWin - windows environment setup
  - getExecutePreambleWin
```
protected String getExecutePreambleWin()
```
    Get execute preamble for windows
    
    Returns:
    
    preamble
  - setExecutePreambleWin
```
protected void setExecutePreambleWin(String executePreambleWin)
```
    Set execute preamble for windows
    
    Parameters:
    
    executePreambleWin - execute preamble for windows
  - getEnvironmentTeardownWin
```
protected String getEnvironmentTeardownWin()
```
    Get environment tear down for windows
    
    Returns:
    
    environment tear down for windows
  - setEnvironmentTeardownWin
```
protected void setEnvironmentTeardownWin(String environmentTeardownWin)
```
    Set environment tear down for windows
    
    Parameters:
    
    environmentTeardownWin - environment tear down for windows
  - getEnvironmentSetupUnix
```
protected String getEnvironmentSetupUnix()
```
    Get environment setup for unix
    
    Returns:
    
    environment setup
  - setEnvironmentSetupUnix
```
protected void setEnvironmentSetupUnix(String environmentSetupUnix)
```
    Set environment setup for unix
    
    Parameters:
    
    environmentSetupUnix - environment setup for unix
  - getExecutePreambleUnix
```
protected String getExecutePreambleUnix()
```
    Get execute preamble for unix
    
    Returns:
    
    preamble
  - setExecutePreambleUnix
```
protected void setExecutePreambleUnix(String executePreambleUnix)
```
    Set execute preamble for unix
    
    Parameters:
    
    executePreambleUnix - execute preamble for unix
  - getEnvironmentTeardownUnix
```
protected String getEnvironmentTeardownUnix()
```
    Get environment tear down for unix
    
    Returns:
    
    teardown
  - setEnvironmentTeardownUnix
```
protected void setEnvironmentTeardownUnix(String environmentTeardownUnix)
```
    Set environment teardown for unix
    
    Parameters:
    
    environmentTeardownUnix - environment tear down for unix
  - getOptionUseReporting
```
protected boolean getOptionUseReporting()
```
    Get use Jenkins reporting option
    
    Returns:
    
    true to use, false to not
  - setOptionUseReporting
```
protected void setOptionUseReporting(boolean optionUseReporting)
```
    Set use Jenkins reporting option
    
    Parameters:
    
    optionUseReporting - true to use, false to not
  - getOptionErrorLevel
```
protected String getOptionErrorLevel()
```
    Get error level
    
    Returns:
    
    Unstable or Failure
  - setOptionErrorLevel
```
protected void setOptionErrorLevel(String optionErrorLevel)
```
    Set option error level
    
    Parameters:
    
    optionErrorLevel - Unstable or Failure
  - getOptionHTMLBuildDesc
```
protected String getOptionHTMLBuildDesc()
```
    Use HTML Build Description
    
    Returns:
    
    HTML or TEXT
  - setOptionHTMLBuildDesc
```
protected void setOptionHTMLBuildDesc(String optionHtmlBuildDesc)
```
    Set use HTML Build description
    
    Parameters:
    
    optionHtmlBuildDesc - HTML build description
  - getOptionExecutionReport
```
protected boolean getOptionExecutionReport()
```
    Use execution report
    
    Returns:
    
    true to use, false to not
  - setOptionExecutionReport
```
protected void setOptionExecutionReport(boolean optionExecutionReport)
```
    Set use execution report
    
    Parameters:
    
    optionExecutionReport - true to use, false to not
  - getOptionClean
```
protected boolean getOptionClean()
```
    Get option to clean workspace before build
    
    Returns:
    
    true to clean, false to not
  - setOptionClean
```
protected void setOptionClean(boolean optionClean)
```
    Set option to clean workspace before build
    
    Parameters:
    
    optionClean - true to clean, false to not
  - getTopProject
```
protected hudson.model.Project getTopProject()
```
    Get top-level project
    
    Returns:
    
    project
  - getManageProjectName
```
protected String getManageProjectName()
```
    Get manage project name
    
    Returns:
    
    manage project name
  - getBaseName
```
protected String getBaseName()
```
    Get base name of manage project
    
    Returns:
    
    base name
  - getRequest
```
protected org.kohsuke.stapler.StaplerRequest getRequest()
```
    Get request
    
    Returns:
    
    request
  - getInstance
```
protected jenkins.model.Jenkins getInstance()
```
    Get Jenkins instance
    
    Returns:
    
    Jenkins instance
  - getResponse
```
protected org.kohsuke.stapler.StaplerResponse getResponse()
```
    Get response
    
    Returns:
    
    response
  - addDeleteWorkspaceBeforeBuildStarts
```
protected void addDeleteWorkspaceBeforeBuildStarts(hudson.model.Project project)
```
    Add the delete workspace before build starts option
    
    Parameters:
    
    project - project to add to
  - create
```
public void create(boolean update)
            throws IOException,
                   javax.servlet.ServletException,
                   hudson.model.Descriptor.FormException,
                   JobAlreadyExistsException,
                   InvalidProjectFileException
```
    Create the job(s)
    
    Parameters:
    
    update - true/false
    
    Throws:
    
    IOException - exception
    
    javax.servlet.ServletException - exception
    
    hudson.model.Descriptor.FormException - exception
    
    JobAlreadyExistsException - exception
    
    InvalidProjectFileException - exception
  - createProject
```
protected abstract hudson.model.Project createProject()
                                               throws IOException,
                                                      JobAlreadyExistsException
```
    Create top-level project
    
    Returns:
    
    created project
    
    Throws:
    
    IOException - exception
    
    JobAlreadyExistsException - exception
  - cleanupProject
```
protected abstract void cleanupProject()
```
    Cleanup top-level project, as in delete
  - doCreate
```
protected abstract void doCreate(boolean update)
                          throws IOException,
                                 javax.servlet.ServletException,
                                 hudson.model.Descriptor.FormException,
                                 InvalidProjectFileException
```
    Do create of project details
    
    Parameters:
    
    update - true if doing an update rather than a create
    
    Throws:
    
    IOException - exception
    
    javax.servlet.ServletException - exception
    
    hudson.model.Descriptor.FormException - exception
    
    InvalidProjectFileException - exception
  - addSetup
```
protected VectorCASTSetup addSetup(hudson.model.Project project)
```
    Add the VectorCAST setup step to copy the python scripts to the workspace
    
    Parameters:
    
    project - project
    
    Returns:
    
    the setup build step
  - addArchiveArtifacts
```
protected void addArchiveArtifacts(hudson.model.Project project)
```
    Add archive artifacts step
    
    Parameters:
    
    project - project to add to
  - addXunit
```
protected void addXunit(hudson.model.Project project)
```
    Add XUnit rules step
    
    Parameters:
    
    project - project to add step to
  - addVCCoverage
```
protected void addVCCoverage(hudson.model.Project project)
```
    Add VectorCAST coverage reporting step
    
    Parameters:
    
    project - project to add step to

Class BaseJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseJob

Method Detail

useSavedData

isUsingSCM

setUsingSCM

getEnvironmentSetupWin

setEnvironmentSetupWin

getExecutePreambleWin

setExecutePreambleWin

getEnvironmentTeardownWin

setEnvironmentTeardownWin

getEnvironmentSetupUnix

setEnvironmentSetupUnix

getExecutePreambleUnix

setExecutePreambleUnix

getEnvironmentTeardownUnix

setEnvironmentTeardownUnix

getOptionUseReporting

setOptionUseReporting

getOptionErrorLevel

setOptionErrorLevel

getOptionHTMLBuildDesc

setOptionHTMLBuildDesc

getOptionExecutionReport

setOptionExecutionReport

getOptionClean

setOptionClean

getTopProject

getManageProjectName

getBaseName

getRequest

getInstance

getResponse

addDeleteWorkspaceBeforeBuildStarts

create

createProject

cleanupProject

doCreate

addSetup

addArchiveArtifacts

addXunit

addVCCoverage