de.codengine.tankerkoenig.models.requests

Class PricesResult

java.lang.Object

de.codengine.tankerkoenig.models.requests.PricesResult

All Implemented Interfaces:

Result

public final class PricesResult
extends Object

Result of PricesRequest. In case of success, isOk() will return true.

Else, the error information are supplied as described in BaseResult

Nested Class Summary

Nested classes/interfaces inherited from interface de.codengine.tankerkoenig.models.requests.Result

Result.ResponseStatus

Constructor Summary

Constructors

Constructor and Description
PricesResult()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getData() Returns the original data supplier for gas prices Won't be filled for requests by CorrectionRequest
Optional<GasPrices>	getGasPrice(String id) Will return the gas prices for a station, defined by the Station ID.
Map<String,GasPrices>	getGasPrices() Will return an unmodifyable map of gas prices, which uses the Station ID as key
Optional<String>	getLicense() Will return the APIs license information.
Optional<String>	getMessage() In case of an error, will return the error message
Optional<Result.ResponseStatus>	getStatus() Returns whether the request was successful Won't be filled for requests by CorrectionRequest
Boolean	isOk() Returns whether the request was successful

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PricesResult

public PricesResult()

Method Detail

getGasPrices

public Map<String,GasPrices> getGasPrices()

Will return an unmodifyable map of gas prices, which uses the Station ID as key

getGasPrice

public Optional<GasPrices> getGasPrice(String id)

Will return the gas prices for a station, defined by the Station ID.

getStatus

public Optional<Result.ResponseStatus> getStatus()

Returns whether the request was successful

Won't be filled for requests by CorrectionRequest

Specified by:

getStatus in interface Result

getMessage

public Optional<String> getMessage()

In case of an error, will return the error message

Specified by:

getMessage in interface Result

getLicense

public Optional<String> getLicense()

Will return the APIs license information.

Won't be filled for requests by CorrectionRequest

Specified by:

getLicense in interface Result

getData

public Optional<String> getData()

Returns the original data supplier for gas prices

Won't be filled for requests by CorrectionRequest

Specified by:

getData in interface Result

isOk

public Boolean isOk()

Returns whether the request was successful

Specified by:

isOk in interface Result