TutorialCheck (SeqWare 1.1.2 API)

java.lang.Object
- io.seqware.pipeline.plugins.sanity.checks.TutorialCheck

All Implemented Interfaces:

SanityCheckPluginInterface
```
public class TutorialCheck
extends Object
implements SanityCheckPluginInterface
```
Runs through our pre-CLI tutorial

Author:

dyuen, Raunaq Suri

Constructor Summary

Constructors
Constructor and Description

TutorialCheck()

Constructors
Constructor and Description
`TutorialCheck()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`check(QueryRunner qRunner, Metadata metadataWS)`
`String`	`getDescription()` Describes the check and indicates what may be wrong
`int`	`getPriority()` Indicate the priority of the check, higher is later
`boolean`	`isDBTest()`
`boolean`	`isMasterTest()`
`boolean`	`isTutorialTest()`

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

- Constructor Detail
  - TutorialCheck
```
public TutorialCheck()
```
- Method Detail
  - isTutorialTest
```
public boolean isTutorialTest()
```
    Specified by:
    
    isTutorialTest in interface SanityCheckPluginInterface
  - isMasterTest
```
public boolean isMasterTest()
```
    Specified by:
    
    isMasterTest in interface SanityCheckPluginInterface
  - isDBTest
```
public boolean isDBTest()
```
    Specified by:
    
    isDBTest in interface SanityCheckPluginInterface
  - check
```
public boolean check(QueryRunner qRunner,
            Metadata metadataWS)
              throws SQLException
```
    Specified by:
    
    check in interface SanityCheckPluginInterface
    
    Parameters:
    qRunner - a runner constructed using your database options, may not be present for non-admins
    metadataWS - a metadata interface constructed using the web service interface
    
    Returns:
    whether the check succeeded
    
    Throws:
    
    SQLException
  - getDescription
```
public String getDescription()
```
    Description copied from interface: SanityCheckPluginInterface
    
    Describes the check and indicates what may be wrong
    
    Specified by:
    
    getDescription in interface SanityCheckPluginInterface
    
    Returns:
  - getPriority
```
public int getPriority()
```
    Description copied from interface: SanityCheckPluginInterface
    
    Indicate the priority of the check, higher is later
    
    Specified by:
    
    getPriority in interface SanityCheckPluginInterface
    
    Returns:

Class TutorialCheck

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TutorialCheck

Method Detail

isTutorialTest

isMasterTest

isDBTest

check

getDescription

getPriority