public static final class ParkingManager.ParkingInfoOptions extends Object
Constructor and Description |
---|
ParkingInfoOptions(ParkingLot parkingLot)
Initializes a new instance of the
ParkingManager.ParkingInfoOptions class. |
Modifier and Type | Method and Description |
---|---|
T |
setArrivalDate(Date value)
Sets the date and time the user is expected to arrive at a parking lot.
|
T |
setCount(int value)
The maximum number of results.
|
T |
setLocale(Locale locale)
Set the preferred locale for the language of the results.
|
T |
setOutputFields(int value)
Sets what parking lot information should be returned.
|
T |
setParkingType(int type)
Sets the requested parking types.
|
T |
setSortBy(ParkingManager.SortBy value)
Sets the sorting order for the results.
|
T |
setUnits(UserPreferences.Unit value)
Sets the units for the returned data.
|
String |
toString() |
public ParkingInfoOptions(ParkingLot parkingLot)
ParkingManager.ParkingInfoOptions
class.parkingLot
- The parking lot for which to retrieve information.ParkingManager.ParkingManagerException
- Thrown when parkingLot
is null or invalid.public T setArrivalDate(Date value)
value
- The arrival date. The date cannot be set to date in the past.ParkingManager.ParkingManagerException
- when the specified arrival date is invalid or set to some
date in the past.public T setOutputFields(int value)
ParkingManager.PARKING_OUTPUT_FIELD_BASIC
.
Supported values are:
Fields can be combined. For instance, to return both basic information and pricing, use PARKING_OUTPUT_FIELD_BASIC | PARKING_OUTPUT_FIELD_PRICING.value
- Fields to return for parking lot information.ParkingManager.ParkingManagerException
- when value is invalid.public T setSortBy(ParkingManager.SortBy value)
value
- The sorting criteria.public T setCount(int value)
setParkingType(int)
set to both ParkingManager.PARKING_TYPE_PARKING_LOT
and
ParkingManager.PARKING_TYPE_PARKING_BLOCK
, count
is applied to each subset independently.
For instance, if count set to 10, response will return 10 parking lots and 10 parking blocks, if available.value
- Number of results.public T setUnits(UserPreferences.Unit value)
value
- The units for the results.ParkingManager.ParkingManagerException
- when value is invalid.public T setLocale(Locale locale)
locale
- The locale or null
to use the default.public T setParkingType(int type)
ParkingManager.PARKING_TYPE_PARKING_LOT
.type
- Parking type.Copyright © 2013-2016 INRIX, Inc. All Rights Reserved.