de.codengine.tankerkoenig.models.requests

Class CorrectionRequest

java.lang.Object

de.codengine.tankerkoenig.models.requests.CorrectionRequest

All Implemented Interfaces:

Request<CorrectionResult>

public final class CorrectionRequest
extends Object

Request for station data corrections.

Most CorrectionRequest.Types will require correction data except for WRONG_STATUS_OPEN AND WRONG_STATUS_CLOSED. The type of the correction values depend on the CorrectionRequest.Type

The station ID is always required

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CorrectionRequest.Type The type of the correction request

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

Request.Method

Constructor Summary

Constructors

Constructor and Description
CorrectionRequest(String apiKey, String baseUrl, Requester requester, CorrectionRequest.Type type)

Method Summary

Modifier and Type	Method and Description
R	execute() Executes the request using the underlying Requester, which will return the requested result object
CorrectionRequest	setCorrectionValue(String correctionValue) Sets the corrected value for the correction request.
CorrectionRequest	setStationId(String stationId) Sets the station ID for the correction request.

Methods inherited from class java.lang.Object

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

Constructor Detail

CorrectionRequest

public CorrectionRequest(String apiKey,
                         String baseUrl,
                         Requester requester,
                         CorrectionRequest.Type type)

Method Detail

setStationId

public CorrectionRequest setStationId(String stationId)

Sets the station ID for the correction request. This information is required

Parameters:

stationId - The unique station ID, which is provided with StationListResult or StationDetailResult

setCorrectionValue

public CorrectionRequest setCorrectionValue(String correctionValue)

Sets the corrected value for the correction request. This information is required

The type of the data is determined by the correction type:

- Float (#.##): WRONG_PRICE_E5, WRONG_PRICE_E10, WRONG_PRICE_DIESEL - Post Code (e.g. 12345): WRONG_PETROL_STATION_POSTCODE - Location Data (e.g. 53.0, 13.0): WRONG_PETROL_STATION_LOCATION - Any String: Everything else

Parameters:

correctionValue - The correction value

execute

public final R execute()
                throws RequesterException

Executes the request using the underlying Requester, which will return the requested result object

Specified by:

execute in interface Request<R extends Result>

Throws:

RequesterException - Checked Exceptions that might be thrown during request execution