README.md 7.48 KB
Newer Older
M3156's avatar
M3156 committed
1
2
3
4
5
6
7
8
9
10
11
12
# TTOS0300 (Käyttöliittymäohjelmointi) Kurssin harjoitustyö - iTool

## Tekijä

* Samson Azizyan
* M3156 
* Versionumero 0.1


## Sisällysluettelo 


M3156's avatar
M3156 committed
13
14
15
16
17
* [Sovelluksen yleiskuvaus](#sovelluksen-yleiskuvaus)
* [Kohdeyleisö](#kohdeyleisö)
* [Käyttöympäristö ja käytetyt teknologiat](#käyttöympäristö-ja-käytetyt-teknologiat)
* [Käyttäjäroolit](#käyttäjäroolit)
* [Ominaisuudet](#ominaisuudet)
M3156's avatar
M3156 committed
18
* [Käyttötapaukset](#toiminnallisia-vaatimuksia)
M3156's avatar
M3156 committed
19
* [Hyväksyntätestit](#hyväksyntätestit)
M3156's avatar
M3156 committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
* [Käsitemalli](#tärkeimmät-käyttötapaukset-general-use-cases)
* [Luokkakaavio](#palvelu-mockup-prototyyppi)
* [Työnjako](#tärkeimmät-tunnistetut-ominaisuudetpiirteet-features)
* [Työaikasuunnitelma](#käyttäjätarinat)

# Sovelluksen yleiskuvaus

Tarkoituksena on suunnitella ja toteuttaa työkaluvuokraussovelluksen prototyyppi,
joka aluksi toimisi vain paikallisesti. Vuokrausmenetelmä toimisi samalla periaatteella kun
Über-sovelluksen kyytipalvelu eli jokainen käyttäjä voi vuokrata jokaisen käyttäjän vuokralle
asettamat työkalut, työkalun omistajan hintapyynnön mukaan. Käyttäjät pystyy kommentoimaan työkaluja
ja antaa 1-5 arvion käyttäjistä, joiden kanssa on suorittanut transaction.

# Kohdeyleisö

Kohdeyleisö on kaikki henkilöt, joilla ei ole monipuolista työkalukokoelmaa. Eli todennäköisesti
kaupungeissa asuvat ihmiset.

# Käyttöympäristö ja käytetyt teknologiat

* Microsoft Windows (Käyttöympäristö)
* Visual Studio 2017
* WPF
* C#
* MySql

# Käyttäjäroolit

## Asiakas

Asiakas käyttää sovellusta vuoratakseen tai laittakseen vuokralle työkaluja.

## Ylläpitäjä

Ylläpitäjä ylläpitää palvelua ja pitää huolta siitä, että työkaluja myöhässä palauttaneiden käyttäjätilit
laitetaan joko jäähylle tai jäädytetään kokonaan.

# Ominaisuudet

| Tunnus | Ominaisuus | Prioriteetti | Muuta |
| :-: | :-: | :-: | :-: |
M3156's avatar
M3156 committed
61
| FT01 | [ Tunnusten luominen ja kirjautuminen](../liitteet/f1_login.md) | Pakollinen | |
M3156's avatar
M3156 committed
62
| FT02 | [ Lisää/poistaa työkalu ](../liitteet/f2_tools.md) | Pakollinen | |
M3156's avatar
M3156 committed
63
64
| FT03 | [ Tunnusten poistaminen](../liitteet/f3_delete_account.md) | Pakollinen | |
| FT04 | [ Mahdollisuus arvioida käyttäjiä ](../liitteet/f4_rating.md) | Nice to Have | |
M3156's avatar
M3156 committed
65
| FT05 | [ Työkalujen kommentoiminen ](../liitteet/f5_comment.md) | Nice to Have | |
M3156's avatar
M3156 committed
66
| FT06 | [ Työkalujen vuokraaminen ](../liitteet/f6_rentatool.md) | Pakollinen | |
M3156's avatar
M3156 committed
67
68
69
| FT07 | [ Työkalujen palautus ](../liitteet/f7_returntool.md) | Pakollinen | |
| FT08 | [ Työkalujen poistaminen ](../liitteet/f8_deletetool.md) | Pakollinen | |

M3156's avatar
M3156 committed
70
71
72
73
74
75
76
77
78
79
80

# Käyttötapaukset

## Tunnusten luominen ja kirjautuminen

```plantuml
@startuml
    Käyttäjä --> (Tunnusten luominen)
    Käyttäjä --> (Kirjautuminen)
@enduml
```
M3156's avatar
M3156 committed
81
82
**Käyttötapauksen kuvaus**

M3156's avatar
M3156 committed
83
84
85
1. Käyttäjä luo tunnukset
2. Käyttäjä kirjautuu palveluun

M3156's avatar
M3156 committed
86
87
88
89
90
91
92
93
94
**Poikkeukset**
 
* P1 Käyttäjä ei täyttänyt kaikki kentät oikein, saa virheilmoituksen
* P2 Käyttäjä ei muista salasanaa, ottaa yhteyttä ylläpitoon
	
**Lopputulos**	

* Asiakas on luonut tunnukset ja on päässyt kirjautumaan iTool sovellukseen

M3156's avatar
M3156 committed
95
96
97
98
**Käyttötiheys** 

* Tunnusten luominen: Kerran per sähköposti
* Kirjautuminen: rajaton
M3156's avatar
M3156 committed
99

M3156's avatar
M3156 committed
100
## Työkalujen selailu, vuokraus, palautus ja poistaminen
M3156's avatar
M3156 committed
101
102
103

```plantuml
@startuml
M3156's avatar
M3156 committed
104
    :Työkalun omistaja: as Omistaja
M3156's avatar
M3156 committed
105
    Käyttäjä --> (Työkalujen selailu) : Selaa
M3156's avatar
M3156 committed
106
    Käyttäjä --> Omistaja : Soittaa ja sopii tapaaminen
M3156's avatar
M3156 committed
107
108
    Käyttäjä --> (Työkalun vuokraus) : Vuokraa
    Käyttäjä --> (Työkalun palautus) : Palauttaa
M3156's avatar
M3156 committed
109
110
    Käyttäjä --> (Työkalun poistaminen) : Poistaa
    (Työkalun poistaminen) --> (iTool tietokanta) : Ylikirjoittaa
M3156's avatar
M3156 committed
111
@enduml
M3156's avatar
M3156 committed
112
113
114
115
116
117
118
119
```

**Käyttötapauksen kuvaus**

1. Käyttäjä selaa voukrattavissa olevia työkaluja
2. Käyttäjä ottaa yhteyttä työkalun omistajaan ja sopii tapaaminen
3. Käyttäjä vuokraa työkalun
4. Käyttäjä palauttaa työkalun
M3156's avatar
M3156 committed
120
121
5. Käyttäjä poistaa työkalun
6. Sovellus ylikirjoittaa poistetun työkalun
M3156's avatar
M3156 committed
122
123
124
125

	
**Lopputulos**	

M3156's avatar
M3156 committed
126
* Asiakas on vuokrannut, palautanut tai poistanut työkalun onnistuneesti
M3156's avatar
M3156 committed
127
128
129
130

**Käyttötiheys** 

* Vuokraus: rajaton
M3156's avatar
M3156 committed
131
* Palautus: kerran per transaction
M3156's avatar
M3156 committed
132
* Poistaminen: kerran per työkalu
M3156's avatar
M3156 committed
133
134
135
136
137
138
139
140
141
142
143

## Työkalujen kommentointi

```plantuml
@startuml
    :Käyttäjä 1: as k1
    :Käyttäjä 2: as k2
    k1 --> (Työkalun kommentti) : Jättää kommentin työkalusta
    k2 --> (Työkalun kommentin vastaus) : Vastaa kommenttiin
    (Työkalun kommentin vastaus) --> (Työkalun kommentti)
@enduml
M3156's avatar
M3156 committed
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
```

**Käyttötapauksen kuvaus**

1. Käyttäjä 1 jättää kommentin työkalusta
2. Käyttäjä 2 kommentoi Käyttäjä 1:n jättämä kommenttia

	
**Lopputulos**	

* Kommentointi sujuu onnistuneesti

**Käyttötiheys** 

* Kommenttointi: rajaton
M3156's avatar
M3156 committed
159
160
* Vastaaminen kommentteihin: rajaton

M3156's avatar
M3156 committed
161
# Hyväksyntätestit
M3156's avatar
M3156 committed
162
163
164

| TestiID | Kuvaus |								
|:-:|:-:|
M3156's avatar
M3156 committed
165
166
167
168
169
| AT01 | [Tunnusten luominen ja sovellukseen kirjautuminen](../liitteet/at1_tunnusten_luominen.md) |
| AT02 | [Työkalun lisäys/poisto](../liitteet/at3_addtool.md) |
| AT03 | [Työkalun vuokraaminen](../liitteet/at4_rentatool.md) |
| AT04 | [Tunnusten poistaminen](../liitteet/at5_delete.md) |
| AT05 | [Kommentointi](../liitteet/at6_comments.md) |
M3156's avatar
M3156 committed
170
171
172
173
174
175
| AT06 | [Työkalun palautus](../liitteet/at7_returnatool.md) |

# Käsitemalli

```plantuml
@startuml
M3156's avatar
M3156 committed
176
177
    CommentWindow --|> MainPage
    RegisterWindow --|> MainWindow
M3156's avatar
M3156 committed
178
179
    MainWindow --> MainPage
    MainPage --> ProfileWindow
M3156's avatar
M3156 committed
180
181
182
183
    User --> MainPage
    User --> ProfileWindow
    Tool --|> User
    User --> DB
M3156's avatar
M3156 committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
@enduml
```
# Luokkamalli

```plantuml
@startuml
    class User {
        +userID
        +userEmail
        #userPassword
        +userFirstName
        +userLastName
        +userMobile
        +userPicture
        +userLocation
        +userPaymentMethod
        +addTool()
        +deleteTool()
        +rentTool()
        +returnTool()
        +comment()
        #editEmail()
        #editPassword()
        +login()
        +logout()
    }
    
    class Tool {
        +toolID
        +toolName
        +toolCategory
        +toolDescription
        +toolImage
    }
    
    class MainWindow {
        Opne()
        Close()
        Show()
    }
    
    class RegisterWindow {
        Opne()
        Close()
        Show()
    }
    
    class MainPage {
        Opne()
        Close()
        Show()
    }
    
    class ProfileWindow {
        Opne()
        Close()
        Show()
    }
    
    class CommentWindow {
        Opne()
        Close()
        Show()
    }
M3156's avatar
M3156 committed
248
    
M3156's avatar
M3156 committed
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
    class DB {
        GetConnectionString()
        GetUsersFromMysql()
        GetToolOwnerFromMysql()
        EmailChecker()
        GetToolsFromMysql()
        GetOwnedToolsFromMysql()
        AddTransactionToMysql()
    }
    
    CommentWindow --|> MainPage
    RegisterWindow --|> MainWindow
    MainWindow --> MainPage
    MainPage --> ProfileWindow
    User --> MainPage
    User --> ProfileWindow
    Tool --|> User
    User --> DB
M3156's avatar
M3156 committed
267
    
M3156's avatar
M3156 committed
268
@enduml
M3156's avatar
M3156 committed
269
270
271
272
273
274
275
276
277
278
279
280
```

# Työnjako

Samson Azizyan
Suunnittelu, XAML toteutus, code in behind, testit, Mysql database (Tietokannat kurssi)

# Työaika suunnitelma

* Viikko 11: MainWindow ja RegisterWindow sekä XAML että code in behind. User, Tool luokat, Mysql tietokanta (15h)
* Viikko 12: DB, MainPage XAML ja code in behind, DB, Mysql (10h)
* Viikko 13: ProfileWindow, DB (5h)
M3156's avatar
M3156 committed
281
282
* Viikko 14: Kaikkien ikkunoiden toimintojen parantamista, DB, Harjoitustyön suunnitelmä xD (17h)
* Viikko 15: Kaikkien ikkunoiden toimintojen parantamista, DB, CommentWindow XAML, Mysql näkymät (3h)
M3156's avatar
M3156 committed
283
284
285
* Viikko 16: Testaaminen, debuggaaminen

Pakko myöntää etää aloin koodaamaan jo viikolla 11 ja tein tämän suunnitelman vasta viikolla 14.