org.jasen.interfaces
Interface JasenScanResult

All Superinterfaces:

Serializable

All Known Implementing Classes:

StandardScanResult

public interface JasenScanResult

extends Serializable

Contains the result of a scan.

Author:

Jason Polites

Method Summary

boolean	completed() Returns false if the scan could not be completed due to an error
double	getProbability() Returns the probability that the scanned message was a spam message
String[][]	getTestResults() Gets the results of each test NOTE: This is a convenience method only intended to help debugging etc

Method Detail

getProbability

public double getProbability()

Returns the probability that the scanned message was a spam message

Returns:

A probability between 0.0 and 1.0

getTestResults

public String[][] getTestResults()

Gets the results of each test
NOTE: This is a convenience method only intended to help debugging etc

Returns:

A String array comprising of 4 values

See Also:

Jasen.RESULT_INDEX_PROBABILITY, Jasen.RESULT_INDEX_TIME, Jasen.RESULT_INDEX_NAME, Jasen.RESULT_INDEX_DISPLAY

completed

public boolean completed()

Returns false if the scan could not be completed due to an error

Returns:

True if the scan completed successfully. False otherwise