SanityCheckPluginInterface (SeqWare 1.1.2 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

BundleDir_Check, CLICheck, ClientServerConsistencyCheck, DB_Check, DB_WS_ConsistencyCheck, HDFS_Check, Oozie_Check, Script_Check, TutorialCheck, WS_Check
```
public interface SanityCheckPluginInterface
```
Specifies an interface for checks that can be done for a SeqWare install

Author:

dyuen, Raunaq Suri

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()`

- Method Detail
  - isMasterTest
```
boolean isMasterTest()
```
  - isTutorialTest
```
boolean isTutorialTest()
```
  - isDBTest
```
boolean isDBTest()
```
  - check
```
boolean check(QueryRunner qRunner,
            Metadata metadataWS)
              throws SQLException
```
    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
```
String getDescription()
```
    Describes the check and indicates what may be wrong
    
    Returns:
  - getPriority
```
int getPriority()
```
    Indicate the priority of the check, higher is later
    
    Returns:

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015 SeqWare. All rights reserved.