org.onebusaway.users.services
Interface UserPropertiesService

All Known Implementing Classes:
UserPropertiesServiceV1Impl, UserPropertiesServiceV2Impl

public interface UserPropertiesService


Method Summary
 int addStopBookmark(User user, String name, List<String> stopIds, RouteFilter filter)
           
 void authorizeApi(User user, long minApiRequestInteval)
          Authorize this user to use the api
 void clearDefaultLocation(User user)
           
 void deleteStopBookmarks(User user, int id)
           
 UserBean getAnonymousUserAsBean(UserBean bean)
           
 UserBean getUserAsBean(User user, UserBean bean)
           
 Class<? extends UserProperties> getUserPropertiesType()
           
 void markServiceAlertAsRead(User user, String situationId, long time, boolean isRead)
           
 void mergeProperties(User sourceUser, User targetUser)
           
 void resetUser(User user)
           
 void setDefaultLocation(User user, String locationName, double lat, double lon)
           
 void setLastSelectedStopIds(User user, List<String> stopId)
           
 void setRememberUserPreferencesEnabled(User user, boolean rememberUserPreferencesEnabled)
           
 void updateStopBookmark(User user, int id, String name, List<String> stopIds, RouteFilter routeFilter)
           
 

Method Detail

getUserPropertiesType

Class<? extends UserProperties> getUserPropertiesType()

getUserAsBean

UserBean getUserAsBean(User user,
                       UserBean bean)

getAnonymousUserAsBean

UserBean getAnonymousUserAsBean(UserBean bean)

setRememberUserPreferencesEnabled

void setRememberUserPreferencesEnabled(User user,
                                       boolean rememberUserPreferencesEnabled)

setDefaultLocation

void setDefaultLocation(User user,
                        String locationName,
                        double lat,
                        double lon)

clearDefaultLocation

void clearDefaultLocation(User user)

setLastSelectedStopIds

void setLastSelectedStopIds(User user,
                            List<String> stopId)

addStopBookmark

int addStopBookmark(User user,
                    String name,
                    List<String> stopIds,
                    RouteFilter filter)
Parameters:
user -
name -
stopIds -
filter -
Returns:
the id for the newly created bookmark

updateStopBookmark

void updateStopBookmark(User user,
                        int id,
                        String name,
                        List<String> stopIds,
                        RouteFilter routeFilter)

deleteStopBookmarks

void deleteStopBookmarks(User user,
                         int id)

authorizeApi

void authorizeApi(User user,
                  long minApiRequestInteval)
Authorize this user to use the api

Parameters:
User - the user
minApiRequestInteval - the minimum time between requests in milliseconds

markServiceAlertAsRead

void markServiceAlertAsRead(User user,
                            String situationId,
                            long time,
                            boolean isRead)

resetUser

void resetUser(User user)

mergeProperties

void mergeProperties(User sourceUser,
                     User targetUser)


Copyright © 2011 OneBusAway. All Rights Reserved.