Updated documentation for final delivery

This commit is contained in:
Jonas Haugland 2022-04-27 11:24:19 +02:00
parent f36f03f7c7
commit 19c50ebee2
8 changed files with 68 additions and 74 deletions

View File

@ -25,14 +25,15 @@ class Tournament {
Teams Teams
} }
class Administrator { class Admin {
*admin_id *admin_id
Name Name
Email Email
google_id
Manager-status Manager-status
} }
class User { class Guest {
} }
@ -40,8 +41,8 @@ Team "2..*" -- "1..*" Tournament : "Plays in"
Tournament "1" -- "1..*" Match : "Contains" Tournament "1" -- "1..*" Match : "Contains"
Team "2..2" -- "1..*" Match : "Competes in" Team "2..2" -- "1..*" Match : "Competes in"
Administrator "1..*" -- "0..*" Tournament : "Manages" Admin "1..*" -- "0..*" Tournament : "Manages"
Administrator "1..*" -- "0..*" Team : "Manages" Admin "1..*" -- "0..*" Team : "Manages"
User "0..*" --> "0..*" Tournament : "View overview" Guest "0..*" --> "0..*" Tournament : "View overview"
@enduml @enduml

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 136 KiB

View File

@ -1,5 +1,7 @@
@startuml Create Tournament @startuml Create Tournament
title Create Tournament title Create Tournament
skinparam actorStyle awesome
Actor Admin #palegreen Actor Admin #palegreen
participant Website participant Website
database Server #brown database Server #brown

View File

@ -1,5 +1,7 @@
@startuml Asura Tournament System @startuml Asura Tournament System
title Login title Login
skinparam actorStyle awesome
Actor Admin #palegreen Actor Admin #palegreen
participant Website participant Website
database Server #brown database Server #brown
@ -14,13 +16,13 @@ activate Server
deactivate Server deactivate Server
alt status = success alt status = success
Website-->Admin: "Login Successful" Website-->Admin: "Login Successful"
opt if (isManager(user)) opt if (userIsAdmin)
Website->Admin: redirect(managerPage) Website->Admin: redirect(frontPage)
else else
Website->Admin: redirect(adminPage) Website->Admin: redirect(noSuchUserPage)
end
end end
end
deactivate Website deactivate Website
deactivate Admin deactivate Admin
@enduml @enduml

View File

@ -1,5 +1,7 @@
@startuml Manage Tournament @startuml Manage Tournament
title Manage Tournament title Manage Tournament
skinparam actorStyle awesome
Actor Admin #palegreen Actor Admin #palegreen
participant Website participant Website
database Server #brown database Server #brown
@ -9,13 +11,13 @@ alt Manage Teams
Admin->Website: manageTeamsButton() Admin->Website: manageTeamsButton()
activate Admin activate Admin
activate Website activate Website
Website-->Admin: redirect(/tournament/id/teams) Website-->Admin: redirect(/tournament/{id}/teams)
opt Add opt Add
Admin->Website: addTeam(name,members) Admin->Website: addTeam(name)
opt Error opt Error
Website-->Admin: displayError(error) Website-->Admin: displayError(error)
end end
Website->Server: addTeam(id,name,members) Website->Server: addTeam(id,name)
activate Server activate Server
Server-->Website: postTeam(team) Server-->Website: postTeam(team)
deactivate Server deactivate Server
@ -31,43 +33,20 @@ alt Manage Teams
activate Server activate Server
Server-->Website: postTeam(team) Server-->Website: postTeam(team)
deactivate Server deactivate Server
Website-->Admin: showTeam(team,members) Website-->Admin: showTeam(team)
opt Add Member
Admin->Website: addMember(name)
activate Server
Website->Server: updateTeam(team,member:name)
Website-->Admin: showTeam(team,member)
deactivate Server
end
opt Remove Member
Admin->Website: removeMember(id)
activate Server
Website->Server: updateTeam(team,member:id)
Website-->Admin: showTeam(team,member)
deactivate Server
deactivate Admin
deactivate Website
end
end end
opt Delete opt Delete
activate Admin activate Admin
activate Website activate Website
Admin->Website: deleteTeam(team) Admin->Website: deleteTeam(team)
Website-->Admin: confirm ? Yes : No;
opt Error
Website-->Admin: displayError(error)
end
opt Yes
Website->Server: removeTeam(team:id) Website->Server: removeTeam(team:id)
activate Server activate Server
Server-->Website: postTeam(team) Server-->Website: postTeam(team)
deactivate Server deactivate Server
Website-->Admin: updateTeamList(team) Website-->Admin: updateTeamList(team)
end opt Error
opt No Website-->Admin: displayError(error)
Website-->Admin: redirect(/tournament/tournament/id/teams)
end end
deactivate Admin deactivate Admin
deactivate Website deactivate Website
@ -76,15 +55,21 @@ end
alt Select Match Winner alt Select Match Winner
Admin->Website: chooseWinner(match,team) Admin->Website: chooseWinner(match,team)
activate Admin
activate Website
Website->Server: updateMatch(id:matchID,winner:teamID) Website->Server: updateMatch(id:matchID,winner:teamID)
activate Server activate Server
Server-->Website: updateParentOf(child:matchID) Server-->Website: updateParentOf(child:matchID)
deactivate Server deactivate Server
Website-->Admin: displayTournament(Tournament) Website-->Admin: displayTournament(Tournament)
deactivate Admin
deactivate Website
end end
alt Delete Tournament alt Delete Tournament
Admin->Website: removeTournament(tournament) Admin->Website: removeTournament(tournament)
activate Admin
activate Website
Website-->Admin: confirm ? Yes : No; Website-->Admin: confirm ? Yes : No;
opt Yes opt Yes
activate Server activate Server
@ -93,9 +78,10 @@ alt Delete Tournament
deactivate Server deactivate Server
end end
opt No opt No
Website-->Admin: redirect(/tournaments/id/) Website-->Admin: close(confirmationDialogue)
end end
deactivate Admin deactivate Admin
deactivate Website deactivate Website
end end
@enduml @enduml

View File

@ -1,5 +1,7 @@
@startuml Manger View @startuml Manger View
title Manager View title Manager View
skinparam actorStyle awesome
Actor Manager #lime Actor Manager #lime
participant Website participant Website
database Server #brown database Server #brown
@ -11,20 +13,24 @@ note left of Manager #white
end note end note
alt View Admins alt View Admins
Manager->Website: viewAdmins()
activate Manager activate Manager
activate Website activate Website
Manager->Website: viewAdmins()
activate Server activate Server
Website->Server: requestList(Admins) Website->Server: requestList(Admins)
Website<--Server: sendList(Admins) Website<--Server: sendList(Admins)
deactivate Server deactivate Server
Manager<--Website: displayAdmins() Manager<--Website: displayAdmins()
deactivate Manager
deactivate Website
end end
alt Add Admins alt Add Admins
Manager->Website: addAdmin(name,passwd) Manager->Website: createAdmin(email)
activate Manager
activate Website
activate Server activate Server
Website->Server: addUser(id,name,passwd) Website->Server: createAdmin(email)
Website<--Server: {status: success | failure} Website<--Server: {status: success | failure}
deactivate Server deactivate Server
opt status = success opt status = success
@ -38,12 +44,16 @@ deactivate Server
else status = failure else status = failure
Manager<--Website: displayError(error) Manager<--Website: displayError(error)
end end
deactivate Manager
deactivate Website
end end
alt Remove Admins alt Remove Admins
Manager->Website: removeAdmin(name) Manager->Website: removeAdmin(name)
activate Manager
activate Website
activate Server activate Server
Website->Server: removeUser(id) Website->Server: removeAdmin(id)
Website<--Server: {status: success | failure} Website<--Server: {status: success | failure}
deactivate Server deactivate Server
opt status = success opt status = success

View File

@ -1,24 +1,24 @@
@startuml User View @startuml Guest View
title User View title Guest View
actor User #LightBlue skinparam actorStyle awesome
actor Guest #LightBlue
participant Website participant Website
database Server #Brown database Server #Brown
hide footbox hide footbox
User->Website: viewTournament(Tournament) Guest->Website: viewTournament(Tournament)
activate User activate Guest
activate Website activate Website
Website->Server: fetchTournament(Tournament) Website->Server: fetchTournament(Tournament)
activate Server activate Server
Server-->Website: {status: success | failure} Server-->Website: {status: success | failure}
deactivate Server deactivate Server
alt status = success alt status = success
Website-->User: displayTournament(Tournament) Website-->Guest: displayTournament(Tournament)
else status = failure else status = failure
Website-->User: displayError(error) Website-->Guest: displayError(error)
deactivate User deactivate Guest
deactivate Website deactivate Website
end end
@enduml @enduml

View File

@ -13,7 +13,7 @@ package Administrators {
MgrNote .l.|> adm MgrNote .l.|> adm
} }
actor User as u1 actor Guest
left to right direction left to right direction
rectangle System { rectangle System {
@ -36,9 +36,6 @@ rectangle System {
together { together {
usecase "Add team" as TeamAdd usecase "Add team" as TeamAdd
usecase "Delete team" as TeamDel usecase "Delete team" as TeamDel
usecase "Manage team" as TeamMng
usecase "Add members" as MembAdd
usecase "Remove members" as MembDel
} }
together { together {
usecase "View tournaments" as TouVtou usecase "View tournaments" as TouVtou
@ -56,7 +53,7 @@ mgr --> SysLogin
adm --> SysLogin adm --> SysLogin
adm --> HomeView adm --> HomeView
u1 --> HomeView Guest --> HomeView
SysLogin --> MngTou SysLogin --> MngTou
SysLogin --> TouCreateT SysLogin --> TouCreateT
@ -70,12 +67,8 @@ MngTou --> TeamView
TeamView --> TeamAdd TeamView --> TeamAdd
TeamView --> TeamDel TeamView --> TeamDel
TeamView --> TeamMng
TeamMng --> MembAdd
TeamMng --> MembDel
HomeView --> TouVtou HomeView --> TouVtou
HomeView --> TouVmatch HomeView --> TouVmatch
@enduml @enduml