Frontend Schnittstelle Backend zum Controller

← zurück zur Schnittstellenübersicht

Verantwortlicher: Kim Rinderknecht, Daniel Reichert

BackendService

Der Backend Service dient als Schnittstelle zwischen Frontend und Backend und liefert vom Backend bereitgestellte Daten an das Frontend.

getBars(Location location, Double radius, Integer weekday) : Promise(Bar[])

Gibt alle Bars zurück, die den übergeben Parametern entsprechen.

Parameter

1. location (Location): latitude und longitude in einem Objekt.
2. radius (Double): Der Radius, der über die GUI vom User eingegeben wurde.
3. weekday (Integer): Der Wochentag, der über die GUI vom User eingegeben wurde.

Rückgabewert

Promise(Bar[]): Gibt ein Array mit allen passenden Bars zurück.

reportData(Integer barId, String description) : Promise(Boolean)

Speichert Meldungen von Bars im Backend.

Parameter

1. barId (Integer): ID der Bar, für die eine Meldung gespeichert werden soll.
2. description (String): Text der Meldung.

Rückgabewert

Promise(Boolean): Gibt true zurück, wenn die Meldung erfolgreich gespeichert wurde und false wenn nicht.

saveRoute(Route route) : Promise(String)

Speichert eine Route im Backend und übergibt einen Link zu der erstellten Route.

Parameter

1. route (Route): JSON Route Objekt, das direkt ins Backend weitergeleitet werden kann.

Rückgabewert

Promise(String): Übergibt einen Hash zu der erstellten Route

saveHappy(HappyHour happy, Integer barId, String admin, String adminpw) : Promise(Boolean)

Speichert eine Happy Hour im Backend und übergibt einen Boolean, ob das Schreiben erfolgreich war oder nicht.

Parameter

1. happy (HappyHour): JSON Happy-Hour Objekt, das direkt ins Backend weitergeleitet werden kann.
2. barId (Integer): Die Bar ID, für die die Happy Hour gilt.
3. admin: Adminname
4. adminpw: Adminpasswort

Rückgabewert

Promise(Boolean): Gibt truezurück, wenn die Happy Hour erfolgreich gespeichert wurde und false wenn nicht.

getRoute(String hash) : Promise(Route)

Gibt eine Route mit dem angeforderten Hashzurück.

Parameter

1. hash (String): Ein Hashwert, der zuvor beim Speichern einer Route zurückgegeben wurde.

Rückgabewert

Promise(Route): Ein Routen Objekt, mit allen darin enthaltenen Bars.

getToproutes() : Promise(Route[])

Gibt alle Toprouten zurück.

Rückgabewert

Promise(Route[]): Alle Toprouten mit allen darin enthaltenen Bars.

getReports(String admin, String adminpw) : Promise([Report](Frontend Typ Report)[])

Gibt alle gemeldeten Bars mit den zugehörigen Meldungen zurück.

Parameter

1. admin (String): Adminname
2. adminpw (String): Adminpasswort

Rückgabewert

Promise([Report](Frontend Typ Report)[]): Alle vorliegenden Meldungen zu allen Bars.

delReport(Integer id, String admin, String adminpw) : Promise(Boolean)

Löscht eine bestimmte Meldung zu einer Bar.

Parameter

2. id (Integer): Die ID der zu löschenden Meldung
3. admin (String): Adminname
4. adminpw (String): Adminpasswort

Rückgabewert

Promise(Boolean): Gibt true zurück, wenn die Meldung erfolgreich gelöscht wurde und false wenn nicht.

delReports(Integer barId, String admin, String adminpw) : Promise(Boolean)

Löscht alle zu einer Bar vorhandene Meldungen.

Parameter

1. barId (Integer): Die ID der Bar mit den Meldungen
2. admin (String): Adminname
3. adminpw (String): Adminpasswort

Rückgabewert

Promise(Boolean): Gibt true zurück, wenn alle Meldungen zu einer Bar erfolgreich gelöscht wurden und false wenn nicht.

deleteHappy(Integer hourId, String admin, String adminpw) : Promise(Boolean)

Löscht die Happy Hour Angabe mit der übergebenen ID.

Parameter

1. barId (Integer): Die ID der zu löschenden Happy Hour
2. admin (String): Adminname
3. adminpw (String): Adminpasswort

Rückgabewert

Promise(Boolean): Gibt true zurück, wenn die Happy Hour erfolgreich gelöscht wurde und false wenn nicht.