IntegrityItemAction (PTC RV&S CM - Jenkins Plugin 2.6 API)

java.lang.Object
- hudson.tasks.BuildStepCompatibilityLayer
- - hudson.tasks.Publisher
  - - hudson.tasks.Notifier
    - - hudson.scm.IntegrityItemAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, Serializable
```
public class IntegrityItemAction
extends hudson.tasks.Notifier
implements Serializable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IntegrityItemAction.IntegrityItemDescriptorImpl` The relationship of Descriptor and IntegrityItemAction (the describable) is akin to class and object.

Nested classes/interfaces inherited from class hudson.tasks.Publisher
hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint
hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep
hudson.tasks.BuildStep.PublisherList

Field Summary

Fields
Modifier and Type Field and Description

static IntegrityItemAction.IntegrityItemDescriptorImpl ITEM_DESCRIPTOR
- Fields inherited from interface hudson.tasks.BuildStep
  BUILDERS, PUBLISHERS

Fields
Modifier and Type	Field and Description
`static IntegrityItemAction.IntegrityItemDescriptorImpl`	`ITEM_DESCRIPTOR`

Constructor Summary

Constructors
Constructor and Description

IntegrityItemAction()

Constructors
Constructor and Description
`IntegrityItemAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>`	`getDescriptor()` Return the instance of DescriptorImpl object for this class
`String`	`getFailureValue()` Returns the failure value that will be set when the build has failed
`String`	`getLogField()` Returns the log field associated with the "build" item
`String`	`getQueryDefinition()` Returns the query definition expression
`hudson.tasks.BuildStepMonitor`	`getRequiredMonitorService()` Returns the build step we're monitoring
`String`	`getServerConfig()` Returns the simple server configuration name
`String`	`getStateField()` Returns the status/state field for the "build" item
`String`	`getSuccessValue()` Returns the success value that will be set when the build is a success
`String`	`getTestCaseTestNameField()` Returns the JUnit Test Name or External ID field for the Test Case
`String`	`getTestFailedVerdictName()` Returns the name for the 'Failed' verdict
`String`	`getTestPassedVerdictName()` Returns the name for the 'Passed' verdict
`String`	`getTestSessionActiveState()` Returns the active State for a Test Session item
`String`	`getTestSessionField()` Returns the Test Session relationship field for the "build" item
`String`	`getTestSessionStateField()` Returns the State field for a Test Session item
`String`	`getTestSessionTestsField()` Returns the Tests field associated with the Test Session item
`String`	`getTestSkippedVerdictName()` Returns the name for the 'Skipped' verdict
`String`	`getTestSuiteContainsField()` Returns the name of the 'Contains' Test Suite structural relationship field
`boolean`	`needsToRunAfterFinalized()` Toggles whether or not this needs to run after build is finalized
`boolean`	`perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)` Executes the actual Integrity Update Item operation
`void`	`setFailureValue(String failureValue)` Sets the failure value that will be set when the build has failed
`void`	`setLogField(String logField)` Sets the log field associated with the "build" item
`void`	`setQueryDefinition(String queryDefinition)` Sets the query definition expression to obtain the build item
`void`	`setServerConfig(String serverConfig)` Sets the simple server configuration name
`void`	`setStateField(String stateField)` Sets the status/state field for the "build" item
`void`	`setSuccessValue(String successValue)` Sets the success value that will be used when the build is a success
`void`	`setTestCaseTestNameField(String testCaseTestNameField)` Sets the JUnit Test Name or External ID field for the Test Case
`void`	`setTestFailedVerdictName(String testFailedVerdictName)` Sets the name for the 'Failed' verdict
`void`	`setTestPassedVerdictName(String testPassedVerdictName)` Sets the name for the 'Passed' verdict
`void`	`setTestSessionActiveState(String testSessionActiveState)` Sets the active State for a Test Session item
`void`	`setTestSessionField(String testSessionField)` Sets the Test Session relationship field for the "build" item
`void`	`setTestSessionStateField(String testSessionStateField)` Sets the State field for a Test Session item
`void`	`setTestSessionTestsField(String testSessionTestsField)` Sets the Tests field associated with the Test Session item
`void`	`setTestSkippedVerdictName(String testSkippedVerdictName)` Sets the name for the 'Skipped' verdict
`void`	`setTestSuiteContainsField(String testSuiteContainsField)` Sets the sunfire reports folder for JUnit test results

Methods inherited from class hudson.tasks.Publisher
all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer
getProjectAction, getProjectActions, perform, prebuild

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

- Field Detail
  - ITEM_DESCRIPTOR
```
@Extension
public static final IntegrityItemAction.IntegrityItemDescriptorImpl ITEM_DESCRIPTOR
```
- Constructor Detail
  - IntegrityItemAction
```
public IntegrityItemAction()
```
- Method Detail
  - getServerConfig
```
public String getServerConfig()
```
    Returns the simple server configuration name
    
    Returns:
  - getQueryDefinition
```
public String getQueryDefinition()
```
    Returns the query definition expression
    
    Returns:
    
    Query Definition
  - getStateField
```
public String getStateField()
```
    Returns the status/state field for the "build" item
    
    Returns:
  - getSuccessValue
```
public String getSuccessValue()
```
    Returns the success value that will be set when the build is a success
    
    Returns:
  - getFailureValue
```
public String getFailureValue()
```
    Returns the failure value that will be set when the build has failed
    
    Returns:
  - getLogField
```
public String getLogField()
```
    Returns the log field associated with the "build" item
    
    Returns:
  - getTestSessionField
```
public String getTestSessionField()
```
    Returns the Test Session relationship field for the "build" item
    
    Returns:
  - getTestSessionStateField
```
public String getTestSessionStateField()
```
    Returns the State field for a Test Session item
    
    Returns:
  - getTestSessionActiveState
```
public String getTestSessionActiveState()
```
    Returns the active State for a Test Session item
    
    Returns:
  - getTestSessionTestsField
```
public String getTestSessionTestsField()
```
    Returns the Tests field associated with the Test Session item
    
    Returns:
  - getTestCaseTestNameField
```
public String getTestCaseTestNameField()
```
    Returns the JUnit Test Name or External ID field for the Test Case
    
    Returns:
  - getTestSuiteContainsField
```
public String getTestSuiteContainsField()
```
    Returns the name of the 'Contains' Test Suite structural relationship field
    
    Returns:
  - getTestPassedVerdictName
```
public String getTestPassedVerdictName()
```
    Returns the name for the 'Passed' verdict
    
    Returns:
  - getTestFailedVerdictName
```
public String getTestFailedVerdictName()
```
    Returns the name for the 'Failed' verdict
    
    Returns:
  - getTestSkippedVerdictName
```
public String getTestSkippedVerdictName()
```
    Returns the name for the 'Skipped' verdict
    
    Returns:
  - setServerConfig
```
public void setServerConfig(String serverConfig)
```
    Sets the simple server configuration name
    
    Parameters:
    
    serverConfig -
  - setQueryDefinition
```
public void setQueryDefinition(String queryDefinition)
```
    Sets the query definition expression to obtain the build item
    
    Parameters:
    
    queryDefinition - Query Definition Expression
  - setStateField
```
public void setStateField(String stateField)
```
    Sets the status/state field for the "build" item
    
    Parameters:
    
    stateField - Status/State field
  - setSuccessValue
```
public void setSuccessValue(String successValue)
```
    Sets the success value that will be used when the build is a success
    
    Parameters:
    
    successValue - Value to be set when the build is a success
  - setFailureValue
```
public void setFailureValue(String failureValue)
```
    Sets the failure value that will be set when the build has failed
    
    Parameters:
    
    failureValue - Value to be set when the build has failed
  - setLogField
```
public void setLogField(String logField)
```
    Sets the log field associated with the "build" item
    
    Parameters:
    
    logField - Log field that is used to store the build log
  - setTestSessionField
```
public void setTestSessionField(String testSessionField)
```
    Sets the Test Session relationship field for the "build" item
  - setTestSessionStateField
```
public void setTestSessionStateField(String testSessionStateField)
```
    Sets the State field for a Test Session item
  - setTestSessionActiveState
```
public void setTestSessionActiveState(String testSessionActiveState)
```
    Sets the active State for a Test Session item
  - setTestSessionTestsField
```
public void setTestSessionTestsField(String testSessionTestsField)
```
    Sets the Tests field associated with the Test Session item
  - setTestCaseTestNameField
```
public void setTestCaseTestNameField(String testCaseTestNameField)
```
    Sets the JUnit Test Name or External ID field for the Test Case
  - setTestSuiteContainsField
```
public void setTestSuiteContainsField(String testSuiteContainsField)
```
    Sets the sunfire reports folder for JUnit test results
    
    Parameters:
    
    testResultsDir -
  - setTestPassedVerdictName
```
public void setTestPassedVerdictName(String testPassedVerdictName)
```
    Sets the name for the 'Passed' verdict
  - setTestFailedVerdictName
```
public void setTestFailedVerdictName(String testFailedVerdictName)
```
    Sets the name for the 'Failed' verdict
  - setTestSkippedVerdictName
```
public void setTestSkippedVerdictName(String testSkippedVerdictName)
```
    Sets the name for the 'Skipped' verdict
  - perform
```
public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException
```
    Executes the actual Integrity Update Item operation
    
    Specified by:
    
    perform in interface hudson.tasks.BuildStep
    
    Overrides:
    
    perform in class hudson.tasks.BuildStepCompatibilityLayer
    
    Throws:
    
    InterruptedException
    
    IOException
  - needsToRunAfterFinalized
```
public boolean needsToRunAfterFinalized()
```
    Toggles whether or not this needs to run after build is finalized
    
    Overrides:
    
    needsToRunAfterFinalized in class hudson.tasks.Publisher
  - getRequiredMonitorService
```
public hudson.tasks.BuildStepMonitor getRequiredMonitorService()
```
    Returns the build step we're monitoring
    
    Specified by:
    
    getRequiredMonitorService in interface hudson.tasks.BuildStep
  - getDescriptor
```
public hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()
```
    Return the instance of DescriptorImpl object for this class
    
    Specified by:
    
    getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>
    
    Overrides:
    
    getDescriptor in class hudson.tasks.Notifier

Class IntegrityItemAction

Nested Class Summary

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

Constructor Summary

Method Summary

Methods inherited from class hudson.tasks.Publisher

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

Methods inherited from class java.lang.Object

Field Detail

ITEM_DESCRIPTOR

Constructor Detail

IntegrityItemAction

Method Detail

getServerConfig

getQueryDefinition

getStateField

getSuccessValue

getFailureValue

getLogField

getTestSessionField

getTestSessionStateField

getTestSessionActiveState

getTestSessionTestsField

getTestCaseTestNameField

getTestSuiteContainsField

getTestPassedVerdictName

getTestFailedVerdictName

getTestSkippedVerdictName

setServerConfig

setQueryDefinition

setStateField

setSuccessValue

setFailureValue

setLogField

setTestSessionField

setTestSessionStateField

setTestSessionActiveState

setTestSessionTestsField

setTestCaseTestNameField

setTestSuiteContainsField

setTestPassedVerdictName

setTestFailedVerdictName

setTestSkippedVerdictName

perform

needsToRunAfterFinalized

getRequiredMonitorService

getDescriptor