net.bitform.api

Interface BasicResponse

All Known Subinterfaces:

SecureResponse

public interface BasicResponse

Represents the result of executing a request.

Method Summary

Modifier and Type	Method and Description
AnalyzeOption.Reaction	getResult(AnalyzeOption option) The the result of an action on one of the analyze targets in SecureOptions
boolean	getResult(BooleanOption option) Gets one of the boolean options in SecureOptions
EnumOptionValue	getResult(EnumOption option) Gets one of the enumeration options in SecureOptions
FileFormat	getResult(FileFormatOption option) Gets one of the file format options in SecureOptions
FileOptionValue	getResult(FileOption option) Gets one of the file options in SecureOptions
long	getResult(IntegerOption option) Gets one of the integer options in SecureOptions
ScrubOption.Reaction	getResult(ScrubOption option) The the result of an action on one of the scrub targets in SecureOptions
int	getResultEnumAsInt(EnumOption option) Gets an enum result as an integer This method is provided for efficency in the C/C++ API and should not be called directly.

Method Detail

getResult

boolean getResult(BooleanOption option)

Gets one of the boolean options in SecureOptions

Parameters:

option - One of the BooleanOption fields in SecureOptions

Returns:

The value of this option

getResult

long getResult(IntegerOption option)

Gets one of the integer options in SecureOptions

Parameters:

option - One of the IntegerOption fields in SecureOptions

Returns:

The value of this option

getResult

FileOptionValue getResult(FileOption option)

Gets one of the file options in SecureOptions

Parameters:

option - One of the FileOption fields in SecureOptions

Returns:

The value of this option

getResult

FileFormat getResult(FileFormatOption option)

Gets one of the file format options in SecureOptions

Parameters:

option - One of the FileFormatOption fields in SecureOptions

Returns:

The value of this option

getResult

EnumOptionValue getResult(EnumOption option)

Gets one of the enumeration options in SecureOptions

Parameters:

option - One of the EnumOption fields in SecureOptions

Returns:

The value of this option

getResultEnumAsInt

int getResultEnumAsInt(EnumOption option)

Gets an enum result as an integer This method is provided for efficency in the C/C++ API and should not be called directly.

Parameters:

option - The EnumOption to get

Returns:

The value of this option

getResult

ScrubOption.Reaction getResult(ScrubOption option)

The the result of an action on one of the scrub targets in SecureOptions

Parameters:

option - One of the ScrubOption fields in SecureOptions

Returns:

The value of the option

getResult

AnalyzeOption.Reaction getResult(AnalyzeOption option)

The the result of an action on one of the analyze targets in SecureOptions

Parameters:

option - One of the AnalyzeOption fields in SecureOptions

Returns:

The value of the option