User

java.lang.Object
- com.cmput301f16t11.a2b.User

```
public class User
extends java.lang.Object
```
User class model, contains username, email and phone number

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActiveDriverRequest(UserRequest request)` Add an active driver request
`void`	`addActiveRiderRequest(UserRequest request)` add an active rider request
`void`	`addDriverRequest(UserRequest request)` Add a driver request
`void`	`addRiderRequest(UserRequest request)` add a rider request
`java.lang.Boolean`	`canDrive()` Check whether this user has signed up to include driving capabilities
`boolean`	`equals(java.lang.Object obj)`
`java.util.ArrayList<UserRequest>`	`getActiveRequestsAsDriver()`
`java.util.ArrayList<UserRequest>`	`getActiveRequestsAsRider()` returns all active requests created by the user as a rider
`Vehicle`	`getCar()` Gets current user's car
`java.lang.String`	`getEmail()` gets email of user
`java.lang.String`	`getFormattedPhoneNumber()` gets a string version of the phone numeber - (xxx)123-4567
`java.lang.String`	`getId()` get user id
`java.lang.String`	`getName()` gets user name of user
`int`	`getNumRatings()` Method to get the number of times a user has been rated
`java.lang.String`	`getPhoneNumber()` gets curr phone number of user
`double`	`getRating()` Method to get the user's current rating
`int`	`getTotalRating()` Method to get the summation of ratings user has received
`boolean`	`hasAcceptedRequests(UserRequest request)` Method to see if the request has been accepted
`void`	`notifyUser(UserRequest r)`
`void`	`removeActiveRiderRequest(UserRequest request)` Remove an active request from the list of active rider requests
`void`	`setActiveRequestsAsDriver(java.util.Collection<UserRequest> requests)` set active requests as driver
`void`	`setActiveRequestsAsRider(java.util.Collection<UserRequest> requests)` sets active requests as rider
`void`	`setCar(Vehicle vehicle)` Set the car obj for the user
`void`	`setClosedRequestsAsDriver(java.util.Collection<UserRequest> requests)` set a closed request by driver
`void`	`setClosedRequestsAsRider(java.util.Collection<UserRequest> requests)` set a closed request for rider
`void`	`setDriveAbility(java.lang.Boolean ability)` Allow a rider to drive or remove the ability of a rider/driver to drive
`void`	`setEmail(java.lang.String email)` set email
`void`	`setId(java.lang.String id)` set user id
`void`	`setName(java.lang.String name)` Sets username
`void`	`setNumRatings(int i)` Set number of user ratings
`void`	`setPhoneNumber(java.lang.String phoneNumber)` Sets phone number
`void`	`setRating(double i)` Set user rating
`void`	`setTotalRating(int i)` Set user total rating
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getCar
```
public Vehicle getCar()
```
    Gets current user's car
    
    Returns:
    
    User's vehicle object
  - getName
```
public java.lang.String getName()
```
    gets user name of user
    
    Returns:
    
    curr username
  - canDrive
```
public java.lang.Boolean canDrive()
```
    Check whether this user has signed up to include driving capabilities
    
    Returns:
    
    true if you are signed up to drive
  - getEmail
```
public java.lang.String getEmail()
```
    gets email of user
    
    Returns:
    
    gets curr email
  - getPhoneNumber
```
public java.lang.String getPhoneNumber()
```
    gets curr phone number of user
    
    Returns:
    
    the curr phone number
  - getFormattedPhoneNumber
```
public java.lang.String getFormattedPhoneNumber()
```
    gets a string version of the phone numeber - (xxx)123-4567
    
    Returns:
    
    the formatted string
  - getActiveRequestsAsRider
```
public java.util.ArrayList<UserRequest> getActiveRequestsAsRider()
```
    returns all active requests created by the user as a rider
    
    Returns:
    
    list of UserRequests created by rider that are active
  - getActiveRequestsAsDriver
```
public java.util.ArrayList<UserRequest> getActiveRequestsAsDriver()
```
  - getNumRatings
```
public int getNumRatings()
```
    Method to get the number of times a user has been rated
    
    Returns:
    
    numRatings
  - getTotalRating
```
public int getTotalRating()
```
    Method to get the summation of ratings user has received
    
    Returns:
    
    totalRating
  - getRating
```
public double getRating()
```
    Method to get the user's current rating
    
    Returns:
    
    rating : int
  - getId
```
public java.lang.String getId()
```
    get user id
    
    Returns:
    
    id
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setPhoneNumber
```
public void setPhoneNumber(java.lang.String phoneNumber)
```
    Sets phone number
    
    Parameters:
    
    phoneNumber - to set
  - setName
```
public void setName(java.lang.String name)
```
    Sets username
    
    Parameters:
    
    name - new username
  - setEmail
```
public void setEmail(java.lang.String email)
```
    set email
    
    Parameters:
    
    email - new email
  - setDriveAbility
```
public void setDriveAbility(java.lang.Boolean ability)
```
    Allow a rider to drive or remove the ability of a rider/driver to drive
    
    Parameters:
    
    ability - true if ability to drive, false otherwise
  - setId
```
public void setId(java.lang.String id)
```
    set user id
    
    Parameters:
    
    id - new id
  - setRating
```
public void setRating(double i)
```
    Set user rating
    
    Parameters:
    
    i - Double rating
  - setTotalRating
```
public void setTotalRating(int i)
```
    Set user total rating
    
    Parameters:
    
    i - int new rating summation
  - setNumRatings
```
public void setNumRatings(int i)
```
    Set number of user ratings
    
    Parameters:
    
    i - int new number of ratings
  - setClosedRequestsAsDriver
```
public void setClosedRequestsAsDriver(java.util.Collection<UserRequest> requests)
```
    set a closed request by driver
    
    Parameters:
    
    requests - list of UserRequests
  - setCar
```
public void setCar(Vehicle vehicle)
```
    Set the car obj for the user
    
    Parameters:
    
    vehicle - the car object
  - setClosedRequestsAsRider
```
public void setClosedRequestsAsRider(java.util.Collection<UserRequest> requests)
```
    set a closed request for rider
    
    Parameters:
    
    requests - list of UserRequests
  - setActiveRequestsAsRider
```
public void setActiveRequestsAsRider(java.util.Collection<UserRequest> requests)
```
    sets active requests as rider
    
    Parameters:
    
    requests - list of UserRequests
  - setActiveRequestsAsDriver
```
public void setActiveRequestsAsDriver(java.util.Collection<UserRequest> requests)
```
    set active requests as driver
    
    Parameters:
    
    requests - list of UserRequests
  - addActiveRiderRequest
```
public void addActiveRiderRequest(UserRequest request)
```
    add an active rider request
    
    Parameters:
    
    request - UserRequest
  - addActiveDriverRequest
```
public void addActiveDriverRequest(UserRequest request)
```
    Add an active driver request
    
    Parameters:
    
    request - UserRequest
  - addRiderRequest
```
public void addRiderRequest(UserRequest request)
```
    add a rider request
    
    Parameters:
    
    request - UserRequest
  - addDriverRequest
```
public void addDriverRequest(UserRequest request)
```
    Add a driver request
    
    Parameters:
    
    request - UserRequest
  - removeActiveRiderRequest
```
public void removeActiveRiderRequest(UserRequest request)
```
    Remove an active request from the list of active rider requests
  - hasAcceptedRequests
```
public boolean hasAcceptedRequests(UserRequest request)
```
    Method to see if the request has been accepted
    
    Parameters:
    
    request - UserRequest in question
    
    Returns:
    
    true/false accepted status
  - notifyUser
```
public void notifyUser(UserRequest r)
```

Class User

Method Summary

Methods inherited from class java.lang.Object

Method Detail

equals

getCar

getName

canDrive

getEmail

getPhoneNumber

getFormattedPhoneNumber

getActiveRequestsAsRider

getActiveRequestsAsDriver

getNumRatings

getTotalRating

getRating

getId

toString

setPhoneNumber

setName

setEmail

setDriveAbility

setId

setRating

setTotalRating

setNumRatings

setClosedRequestsAsDriver

setCar

setClosedRequestsAsRider

setActiveRequestsAsRider

setActiveRequestsAsDriver

addActiveRiderRequest

addActiveDriverRequest

addRiderRequest

addDriverRequest

removeActiveRiderRequest

hasAcceptedRequests

notifyUser