com.veriplace.client
Class LocationUpdates

java.lang.Object
  com.veriplace.client.LocationUpdates

public class LocationUpdates
extends java.lang.Object

A result set returned by PollingAPI.getUpdates(Integer), representing location updates that occurred within a given time interval whose details can be queried by the current application.

Constructor Summary

LocationUpdates(java.util.Date updatedTime, java.util.Date sinceTime, int period, java.util.Map<User,java.util.List<LocationUpdateReference>> updates, java.util.Set<java.lang.Integer> availablePeriods)

Method Summary

java.util.Set<java.lang.Integer>	getAvailablePeriods() Returns a set of all the allowable values that can be passed to PollingAPI.setPeriodSeconds(int).
int	getPeriod() Returns the minimum time interval, in seconds, of location updates included in this result set.
java.util.Date	getSinceTime() Returns the starting date and time of the update query.
java.util.Date	getUpdatedTime() Returns the ending date and time of the update query.
java.util.Map<User,java.util.List<LocationUpdateReference>>	getUpdates() Returns all of the location updates in this result set as a map, where each key is a Veriplace User object and each value is a list of LocationUpdateReferences.
java.util.List<LocationUpdateReference>	getUpdatesForUser(User user) Returns a list of all the LocationUpdateReferences for the given user in this result set, or an empty list if the user had no updates.
java.util.Set<User>	getUsers() Returns a set of all the Veriplace users in this result set.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationUpdates

public LocationUpdates(java.util.Date updatedTime,
                       java.util.Date sinceTime,
                       int period,
                       java.util.Map<User,java.util.List<LocationUpdateReference>> updates,
                       java.util.Set<java.lang.Integer> availablePeriods)

Method Detail

getUpdatedTime

public java.util.Date getUpdatedTime()

Returns the ending date and time of the update query.

getSinceTime

public java.util.Date getSinceTime()

Returns the starting date and time of the update query.

getPeriod

public int getPeriod()

Returns the minimum time interval, in seconds, of location updates included in this result set.

getUpdates

public java.util.Map<User,java.util.List<LocationUpdateReference>> getUpdates()

Returns all of the location updates in this result set as a map, where each key is a Veriplace User object and each value is a list of LocationUpdateReferences.

getUsers

public java.util.Set<User> getUsers()

Returns a set of all the Veriplace users in this result set.

getUpdatesForUser

public java.util.List<LocationUpdateReference> getUpdatesForUser(User user)

Returns a list of all the LocationUpdateReferences for the given user in this result set, or an empty list if the user had no updates.

getAvailablePeriods

public java.util.Set<java.lang.Integer> getAvailablePeriods()

Returns a set of all the allowable values that can be passed to PollingAPI.setPeriodSeconds(int).