ReturnValue (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.module.ReturnValue

All Implemented Interfaces:

Serializable
```
public class ReturnValue
extends Object
implements Serializable
```
Return values > 0 are errors that will cause the runner to exit. Return of 0 implies success and the runner will continue, assuming all is well. Return of -1 implies the method was not implemented for that module, AND IS NOT AN ERROR!!! By default the runner will continue on with steps as if it succeeded!

Version:

$Id: $Id

Author:

boconnor

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ReturnValue.ExitStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`ReturnValue.ExitStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`algorithm`
`protected Map<String,String>`	`attributes`
`static int`	`DBCOULDNOTDISCONNECT` Constant `DBCOULDNOTDISCONNECT=81`
`static int`	`DBCOULDNOTINITIALIZE` Constant `DBCOULDNOTINITIALIZE=80`
`protected String`	`description`
`static int`	`DIRECTORYNOTREADABLE` Constant `DIRECTORYNOTREADABLE=3`
`static int`	`DIRECTORYNOTWRITABLE` Constant `DIRECTORYNOTWRITABLE=11`
`static int`	`ENVVARNOTFOUND` Constant `ENVVARNOTFOUND=14`
`protected int`	`exitStatus`
`static int`	`FAILURE` Constant `FAILURE=15`
`static int`	`FILEEMPTY` Constant `FILEEMPTY=12`
`static int`	`FILENOTEXECUTABLE` Constant `FILENOTEXECUTABLE=10`
`static int`	`FILENOTREADABLE` Constant `FILENOTREADABLE=4`
`static int`	`FILENOTWRITABLE` Constant `FILENOTWRITABLE=5`
`protected ArrayList<FileMetadata>`	`files`
`static int`	`FREEMARKEREXCEPTION` Constant `FREEMARKEREXCEPTION=70`
`static int`	`INVALIDARGUMENT` Constant `INVALIDARGUMENT=9`
`static int`	`INVALIDFILE` Constant `INVALIDFILE=7`
`static int`	`INVALIDPARAMETERS` Constant `INVALIDPARAMETERS=2`
`static int`	`INVALIDPLUGIN` Constant `INVALIDPLUGIN=120`
`static int`	`METADATAINVALIDIDCHAIN` Constant `METADATAINVALIDIDCHAIN=8`
`static int`	`NOTIMPLEMENTED` Constant `NOTIMPLEMENTED=-1`
`static int`	`NULL` Constant `NULL=-99`
`protected String`	`parameters`
`protected int`	`processExitStatus`
`static int`	`PROCESSING` Constant `PROCESSING=100`
`static int`	`PROGRAMFAILED` Constant `PROGRAMFAILED=1`
`static int`	`QUEUED` Constant `QUEUED=101`
`static int`	`RETURNEDHELPMSG` Constant `RETURNEDHELPMSG=110`
`protected int`	`returnValue`
`static int`	`RUNNERERR` Constant `RUNNERERR=91`
`protected Date`	`runStartTstmp`
`protected Date`	`runStopTstmp`
`static int`	`RUNTIMEEXCEPTION` Constant `RUNTIMEEXCEPTION=6`
`static int`	`SETTINGSFILENOTFOUND` Constant `SETTINGSFILENOTFOUND=13`
`static int`	`SQLQUERYFAILED` Constant `SQLQUERYFAILED=82`
`protected String`	`stderr`
`protected String`	`stdout`
`static int`	`STDOUTERR` Constant `STDOUTERR=90`
`static int`	`SUCCESS` Constant `SUCCESS=0`
`static int`	`UNKNOWN` Constant `UNKNOWN=130`
`protected String`	`url`
`protected String`	`urlLabel`
`protected String`	`version`

Constructor Summary

Constructors
Constructor and Description
`ReturnValue()` Constructor for ReturnValue.
`ReturnValue(int startExitStatus)` Constructor for ReturnValue.
`ReturnValue(ReturnValue.ExitStatus exitStatus)` Constructor for ReturnValue.
`ReturnValue(String startStdout, String startStderr, int startExitStatus)` Constructor for ReturnValue.

Method Summary

Methods
Modifier and Type	Method and Description
`static ReturnValue`	`featureNotImplemented()` featureNotImplemented.
`String`	`getAlgorithm()` Getter for the field `algorithm`.
`String`	`getAttribute(String key)` getAttribute.
`Map<String,String>`	`getAttributes()` Getter for the field `attributes`.
`String`	`getDescription()` Getter for the field `description`.
`int`	`getExitStatus()` Getter for the field `exitStatus`.
`ArrayList<FileMetadata>`	`getFiles()` Getter for the field `files`.
`String`	`getParameters()` Getter for the field `parameters`.
`int`	`getProcessExitStatus()` Getter for the field `processExitStatus`.
`int`	`getReturnValue()` Getter for the field `returnValue`.
`Date`	`getRunStartTstmp()` Getter for the field `runStartTstmp`.
`Date`	`getRunStopTstmp()` Getter for the field `runStopTstmp`.
`String`	`getStderr()` Getter for the field `stderr`.
`String`	`getStdout()` Getter for the field `stdout`.
`String`	`getUrl()` Getter for the field `url`.
`String`	`getUrlLabel()` Getter for the field `urlLabel`.
`String`	`getVersion()` Getter for the field `version`.
`void`	`printAndAppendtoStderr(String errorMessage)` printAndAppendtoStderr.
`void`	`printAndAppendtoStdout(String outMessage)` printAndAppendtoStdout.
`void`	`setAlgorithm(String algorithm)` Setter for the field `algorithm`.
`void`	`setAttribute(String key, String value)` setAttribute.
`void`	`setAttributes(Map<String,String> attributes)` Setter for the field `attributes`.
`void`	`setDescription(String description)` Setter for the field `description`.
`void`	`setExitStatus(int exitStatus)` Setter for the field `exitStatus`.
`void`	`setFiles(ArrayList<FileMetadata> files)` Setter for the field `files`.
`void`	`setParameters(String parameters)` Setter for the field `parameters`.
`void`	`setProcessExitStatus(int processExitStatus)` Setter for the field `processExitStatus`.
`void`	`setReturnValue(int returnValue)` Setter for the field `returnValue`.
`void`	`setRunStartTstmp(Date runStartTstmp)` Setter for the field `runStartTstmp`.
`void`	`setRunStopTstmp(Date runStopTstmp)` Setter for the field `runStopTstmp`.
`void`	`setStderr(String stderr)` Setter for the field `stderr`.
`void`	`setStdout(String stdout)` Setter for the field `stdout`.
`void`	`setUrl(String url)` Setter for the field `url`.
`void`	`setUrlLabel(String urlLabel)` Setter for the field `urlLabel`.
`void`	`setVersion(String version)` Setter for the field `version`.
`String`	`toString()`

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

- Field Detail
  - NULL
```
public static final int NULL
```
    Constant NULL=-99
    
    See Also:
    Constant Field Values
  - NOTIMPLEMENTED
```
public static final int NOTIMPLEMENTED
```
    Constant NOTIMPLEMENTED=-1
    
    See Also:
    Constant Field Values
  - SUCCESS
```
public static final int SUCCESS
```
    Constant SUCCESS=0
    
    See Also:
    Constant Field Values
  - PROGRAMFAILED
```
public static final int PROGRAMFAILED
```
    Constant PROGRAMFAILED=1
    
    See Also:
    Constant Field Values
  - INVALIDPARAMETERS
```
public static final int INVALIDPARAMETERS
```
    Constant INVALIDPARAMETERS=2
    
    See Also:
    Constant Field Values
  - DIRECTORYNOTREADABLE
```
public static final int DIRECTORYNOTREADABLE
```
    Constant DIRECTORYNOTREADABLE=3
    
    See Also:
    Constant Field Values
  - FILENOTREADABLE
```
public static final int FILENOTREADABLE
```
    Constant FILENOTREADABLE=4
    
    See Also:
    Constant Field Values
  - FILENOTWRITABLE
```
public static final int FILENOTWRITABLE
```
    Constant FILENOTWRITABLE=5
    
    See Also:
    Constant Field Values
  - RUNTIMEEXCEPTION
```
public static final int RUNTIMEEXCEPTION
```
    Constant RUNTIMEEXCEPTION=6
    
    See Also:
    Constant Field Values
  - INVALIDFILE
```
public static final int INVALIDFILE
```
    Constant INVALIDFILE=7
    
    See Also:
    Constant Field Values
  - METADATAINVALIDIDCHAIN
```
public static final int METADATAINVALIDIDCHAIN
```
    Constant METADATAINVALIDIDCHAIN=8
    
    See Also:
    Constant Field Values
  - INVALIDARGUMENT
```
public static final int INVALIDARGUMENT
```
    Constant INVALIDARGUMENT=9
    
    See Also:
    Constant Field Values
  - FILENOTEXECUTABLE
```
public static final int FILENOTEXECUTABLE
```
    Constant FILENOTEXECUTABLE=10
    
    See Also:
    Constant Field Values
  - DIRECTORYNOTWRITABLE
```
public static final int DIRECTORYNOTWRITABLE
```
    Constant DIRECTORYNOTWRITABLE=11
    
    See Also:
    Constant Field Values
  - FILEEMPTY
```
public static final int FILEEMPTY
```
    Constant FILEEMPTY=12
    
    See Also:
    Constant Field Values
  - SETTINGSFILENOTFOUND
```
public static final int SETTINGSFILENOTFOUND
```
    Constant SETTINGSFILENOTFOUND=13
    
    See Also:
    Constant Field Values
  - ENVVARNOTFOUND
```
public static final int ENVVARNOTFOUND
```
    Constant ENVVARNOTFOUND=14
    
    See Also:
    Constant Field Values
  - FAILURE
```
public static final int FAILURE
```
    Constant FAILURE=15
    
    See Also:
    Constant Field Values
  - FREEMARKEREXCEPTION
```
public static final int FREEMARKEREXCEPTION
```
    Constant FREEMARKEREXCEPTION=70
    
    See Also:
    Constant Field Values
  - DBCOULDNOTINITIALIZE
```
public static final int DBCOULDNOTINITIALIZE
```
    Constant DBCOULDNOTINITIALIZE=80
    
    See Also:
    Constant Field Values
  - DBCOULDNOTDISCONNECT
```
public static final int DBCOULDNOTDISCONNECT
```
    Constant DBCOULDNOTDISCONNECT=81
    
    See Also:
    Constant Field Values
  - SQLQUERYFAILED
```
public static final int SQLQUERYFAILED
```
    Constant SQLQUERYFAILED=82
    
    See Also:
    Constant Field Values
  - STDOUTERR
```
public static final int STDOUTERR
```
    Constant STDOUTERR=90
    
    See Also:
    Constant Field Values
  - RUNNERERR
```
public static final int RUNNERERR
```
    Constant RUNNERERR=91
    
    See Also:
    Constant Field Values
  - PROCESSING
```
public static final int PROCESSING
```
    Constant PROCESSING=100
    
    See Also:
    Constant Field Values
  - QUEUED
```
public static final int QUEUED
```
    Constant QUEUED=101
    
    See Also:
    Constant Field Values
  - RETURNEDHELPMSG
```
public static final int RETURNEDHELPMSG
```
    Constant RETURNEDHELPMSG=110
    
    See Also:
    Constant Field Values
  - INVALIDPLUGIN
```
public static final int INVALIDPLUGIN
```
    Constant INVALIDPLUGIN=120
    
    See Also:
    Constant Field Values
  - UNKNOWN
```
public static final int UNKNOWN
```
    Constant UNKNOWN=130
    
    See Also:
    Constant Field Values
  - stdout
```
protected String stdout
```
  - stderr
```
protected String stderr
```
  - exitStatus
```
protected int exitStatus
```
  - processExitStatus
```
protected int processExitStatus
```
  - returnValue
```
protected int returnValue
```
  - algorithm
```
protected String algorithm
```
  - parameters
```
protected String parameters
```
  - description
```
protected String description
```
  - version
```
protected String version
```
  - url
```
protected String url
```
  - urlLabel
```
protected String urlLabel
```
  - runStartTstmp
```
protected Date runStartTstmp
```
  - runStopTstmp
```
protected Date runStopTstmp
```
  - files
```
protected ArrayList<FileMetadata> files
```
  - attributes
```
protected Map<String,String> attributes
```
- Constructor Detail
  - ReturnValue
```
public ReturnValue()
```
    Constructor for ReturnValue.
  - ReturnValue
```
public ReturnValue(int startExitStatus)
```
    Constructor for ReturnValue.
    
    Parameters:
    startExitStatus - a int.
  - ReturnValue
```
public ReturnValue(ReturnValue.ExitStatus exitStatus)
```
    Constructor for ReturnValue.
    
    Parameters:
    exitStatus -
  - ReturnValue
```
public ReturnValue(String startStdout,
           String startStderr,
           int startExitStatus)
```
    Constructor for ReturnValue.
    
    Parameters:
    startStdout - a String object.
    startStderr - a String object.
    startExitStatus - a int.
- Method Detail
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Setter for the field attributes.
    
    Parameters:
    attributes - a Map object.
  - setAttribute
```
public void setAttribute(String key,
                String value)
```
    setAttribute.
    
    Parameters:
    key - a String object.
    value - a String object.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Getter for the field attributes.
    
    Returns:
    a Map object.
  - getAttribute
```
public String getAttribute(String key)
```
    getAttribute.
    
    Parameters:
    key - a String object.
    
    Returns:
    a String object.
  - getRunStartTstmp
```
public Date getRunStartTstmp()
```
    Getter for the field runStartTstmp.
    
    Returns:
    a Date object.
  - setRunStartTstmp
```
public void setRunStartTstmp(Date runStartTstmp)
```
    Setter for the field runStartTstmp.
    
    Parameters:
    runStartTstmp - a Date object.
  - getRunStopTstmp
```
public Date getRunStopTstmp()
```
    Getter for the field runStopTstmp.
    
    Returns:
    a Date object.
  - setRunStopTstmp
```
public void setRunStopTstmp(Date runStopTstmp)
```
    Setter for the field runStopTstmp.
    
    Parameters:
    runStopTstmp - a Date object.
  - getReturnValue
```
public int getReturnValue()
```
    Getter for the field returnValue.
    
    Returns:
    a int.
  - setReturnValue
```
public void setReturnValue(int returnValue)
```
    Setter for the field returnValue.
    
    Parameters:
    returnValue - a int.
  - featureNotImplemented
```
public static ReturnValue featureNotImplemented()
```
    featureNotImplemented.
    
    Returns:
    a ReturnValue object.
  - getProcessExitStatus
```
public int getProcessExitStatus()
```
    Getter for the field processExitStatus.
    
    Returns:
    a int.
  - setProcessExitStatus
```
public void setProcessExitStatus(int processExitStatus)
```
    Setter for the field processExitStatus.
    
    Parameters:
    processExitStatus - a int.
  - getStdout
```
public String getStdout()
```
    Getter for the field stdout.
    
    Returns:
    a String object.
  - getStderr
```
public String getStderr()
```
    Getter for the field stderr.
    
    Returns:
    a String object.
  - getExitStatus
```
public int getExitStatus()
```
    Getter for the field exitStatus.
    
    Returns:
    a int.
  - setExitStatus
```
public void setExitStatus(int exitStatus)
```
    Setter for the field exitStatus.
    
    Parameters:
    exitStatus - a int.
  - setStdout
```
public void setStdout(String stdout)
```
    Setter for the field stdout.
    
    Parameters:
    stdout - a String object.
  - setStderr
```
public void setStderr(String stderr)
```
    Setter for the field stderr.
    
    Parameters:
    stderr - a String object.
  - getAlgorithm
```
public String getAlgorithm()
```
    Getter for the field algorithm.
    
    Returns:
    a String object.
  - setAlgorithm
```
public void setAlgorithm(String algorithm)
```
    Setter for the field algorithm.
    
    Parameters:
    algorithm - a String object.
  - getDescription
```
public String getDescription()
```
    Getter for the field description.
    
    Returns:
    a String object.
  - setDescription
```
public void setDescription(String description)
```
    Setter for the field description.
    
    Parameters:
    description - a String object.
  - getVersion
```
public String getVersion()
```
    Getter for the field version.
    
    Returns:
    a String object.
  - setVersion
```
public void setVersion(String version)
```
    Setter for the field version.
    
    Parameters:
    version - a String object.
  - getParameters
```
public String getParameters()
```
    Getter for the field parameters.
    
    Returns:
    a String object.
  - setParameters
```
public void setParameters(String parameters)
```
    Setter for the field parameters.
    
    Parameters:
    parameters - a String object.
  - getFiles
```
public ArrayList<FileMetadata> getFiles()
```
    Getter for the field files.
    
    Returns:
    a ArrayList object.
  - setFiles
```
public void setFiles(ArrayList<FileMetadata> files)
```
    Setter for the field files.
    
    Parameters:
    files - a ArrayList object.
  - printAndAppendtoStderr
```
public void printAndAppendtoStderr(String errorMessage)
```
    printAndAppendtoStderr.
    
    Parameters:
    errorMessage - a String object.
  - printAndAppendtoStdout
```
public void printAndAppendtoStdout(String outMessage)
```
    printAndAppendtoStdout.
    
    Parameters:
    outMessage - a String object.
  - getUrl
```
public String getUrl()
```
    Getter for the field url.
    
    Returns:
    a String object.
  - setUrl
```
public void setUrl(String url)
```
    Setter for the field url.
    
    Parameters:
    url - a String object.
  - getUrlLabel
```
public String getUrlLabel()
```
    Getter for the field urlLabel.
    
    Returns:
    a String object.
  - setUrlLabel
```
public void setUrlLabel(String urlLabel)
```
    Setter for the field urlLabel.
    
    Parameters:
    urlLabel - a String object.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ReturnValue

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

NOTIMPLEMENTED

SUCCESS

PROGRAMFAILED

INVALIDPARAMETERS

DIRECTORYNOTREADABLE

FILENOTREADABLE

FILENOTWRITABLE

RUNTIMEEXCEPTION

INVALIDFILE

METADATAINVALIDIDCHAIN

INVALIDARGUMENT

FILENOTEXECUTABLE

DIRECTORYNOTWRITABLE

FILEEMPTY

SETTINGSFILENOTFOUND

ENVVARNOTFOUND

FAILURE

FREEMARKEREXCEPTION

DBCOULDNOTINITIALIZE

DBCOULDNOTDISCONNECT

SQLQUERYFAILED

STDOUTERR

RUNNERERR

PROCESSING

QUEUED

RETURNEDHELPMSG

INVALIDPLUGIN

UNKNOWN

stdout

stderr

exitStatus

processExitStatus

returnValue

algorithm

parameters

description

version

url

urlLabel

runStartTstmp

runStopTstmp

files

attributes

Constructor Detail

ReturnValue

ReturnValue

ReturnValue

ReturnValue

Method Detail

setAttributes

setAttribute

getAttributes

getAttribute

getRunStartTstmp

setRunStartTstmp

getRunStopTstmp

setRunStopTstmp

getReturnValue

setReturnValue

featureNotImplemented

getProcessExitStatus

setProcessExitStatus

getStdout

getStderr

getExitStatus

setExitStatus

setStdout

setStderr

getAlgorithm

setAlgorithm

getDescription

setDescription