InterfaceSpecification » 履歴 » バージョン 17

Miyazaki Masafumi, 2015/05/05 19:08

1 1 MIYAZAKI Masafumi
h1. インタフェース仕様
2 1 MIYAZAKI Masafumi
3 9 MIYAZAKI Masafumi
----
4 9 MIYAZAKI Masafumi
5 8 MIYAZAKI Masafumi
{{>toc}}
6 8 MIYAZAKI Masafumi
7 14 MIYAZAKI Masafumi
h2. Questionクラス
8 1 MIYAZAKI Masafumi
9 15 MIYAZAKI Masafumi
一つ一つの "問題" に相当するクラス。
10 15 MIYAZAKI Masafumi
11 14 MIYAZAKI Masafumi
h3. プロパティ
12 2 MIYAZAKI Masafumi
13 1 MIYAZAKI Masafumi
| 名前 | 型 | 説明 |
14 1 MIYAZAKI Masafumi
| id | int | 問題の識別子 |
15 1 MIYAZAKI Masafumi
| question | stirng | 問題文 |
16 7 MIYAZAKI Masafumi
| correctAnswers | array<string> | 正解となる選択肢群。配列形式。 |
17 7 MIYAZAKI Masafumi
| incorrectAnswers | array<string> | 不正解となる選択肢群。配列形式。 |
18 1 MIYAZAKI Masafumi
19 14 MIYAZAKI Masafumi
h3. メソッド
20 1 MIYAZAKI Masafumi
21 7 MIYAZAKI Masafumi
| 名前 | 応答値 | 引数 | 説明 |
22 17 Miyazaki Masafumi
| get*** | 各プロパティ | なし | 各プロパティのアクセサ(getter)。***はプロパティ名を表す。 |
23 17 Miyazaki Masafumi
| set*** | なし | 各プロパティ | 各プロパティのアクセサ(setter)。***はプロパティ名を表す。 |
24 10 MIYAZAKI Masafumi
| isCorrect | bool | string | 指定した文字列が正解群(correctAnswers)に含まれるか否かの真偽値を応答する。 |
25 1 MIYAZAKI Masafumi
| getCorrectAnswersInJSON | string | なし | 正解群をJSON配列形式で応答する。ex) ["answer1", "answer2", "answer3"] |
26 1 MIYAZAKI Masafumi
| getIncorrectAnswersInJSON | string | なし | 不正解群をJSON配列形式で応答する。ex) ["answer1", "answer2", "answer3"] |
27 1 MIYAZAKI Masafumi
28 14 MIYAZAKI Masafumi
----
29 14 MIYAZAKI Masafumi
30 16 MIYAZAKI Masafumi
h2. WhiskyExaminationDBクラス
31 15 MIYAZAKI Masafumi
32 15 MIYAZAKI Masafumi
データベースのアクセサを提供するクラス。
33 14 MIYAZAKI Masafumi
34 14 MIYAZAKI Masafumi
h3. メソッド
35 2 MIYAZAKI Masafumi
36 4 MIYAZAKI Masafumi
| 関数名 | 応答値 | 引数 | 説明 |
37 6 MIYAZAKI Masafumi
| getNumberOfQuestions | int 総問題数 | なし | 現在の総問題数を応答する。 |
38 3 MIYAZAKI Masafumi
| getQuestion | Question | なし | 問題を1つランダムに取り出し、応答する。 |
39 3 MIYAZAKI Masafumi
| getQuestionById | Question | int 問題の識別子 | 指定した識別子の問題を取り出し、応答する。 |
40 11 MIYAZAKI Masafumi
| getQuestions | array<Question> | int 問題数 | 指定した個数の問題をランダムに取り出し、配列形式で応答する。(※1参照) |
41 11 MIYAZAKI Masafumi
| setQuestion | int 登録/更新時の問題の識別子(=id) | Question 問題 | 指定した問題を登録する。(※2参照) |
42 1 MIYAZAKI Masafumi
43 1 MIYAZAKI Masafumi
※1.
44 11 MIYAZAKI Masafumi
 問題は重複しないものとする。
45 11 MIYAZAKI Masafumi
 ただし、引数に指定された問題数が総問題数を上回る場合は問題の重複を許し、指定数分の問題を応答する。
46 11 MIYAZAKI Masafumi
※2.
47 11 MIYAZAKI Masafumi
 idが既存の場合は、当該idの問題に対して問題文/正解群/不正解群を上書きし、当該idを応答する。
48 11 MIYAZAKI Masafumi
 idが既存でない場合は、当該idを無視して新規登録を行ない、新規登録時のidを応答する。