# 通知設計書 16-無効な在庫ロケーション

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「無効な在庫ロケーション」通知の設計仕様を定義する。この通知は、バーコードスキャンで検出されたロケーションが無効である場合、または指定されたロケーションが存在しない場合に表示されるエラー通知である。

### 本通知の処理概要

この通知は、バーコードスキャン機能を使用して在庫ロケーションを特定しようとした際に、スキャンしたバーコードが有効なロケーションを指していない場合のフィードバックとして機能する。

**業務上の目的・背景**：在庫管理において、正確なロケーション情報は在庫追跡の基盤となる。スキャンしたバーコードが有効なロケーションを指していない場合（データベースに存在しない、削除された、またはロケーション以外のバーコードなど）、ユーザーは即座にこれを認識し、正しいロケーションをスキャンし直す必要がある。この通知により、誤ったロケーションへの在庫移動を防止できる。

**通知の送信タイミング**：`BarcodeScanStockLocationHandler` または派生クラスを使用してバーコードをスキャンし、スキャン結果に `stocklocation` キーが含まれていないか、PKが0以下の場合に通知が生成される。また、`ScanParentLocationHandler` で親ロケーション設定時にAPI応答が400エラーを返した場合にも表示される。

**通知の受信者**：バーコードスキャン操作を実行した現在のアプリユーザー。通知はアプリ内スナックバーとして即座に表示される。

**通知内容の概要**：「Invalid Stock Location」というメッセージが表示され、スキャンしたバーコードが有効なロケーションを指していないことをユーザーに伝える。失敗音声フィードバックも再生される。

**期待されるアクション**：ユーザーは正しいロケーションバーコードをスキャンし直すか、ロケーション情報を手動で確認・入力する。

## 通知種別

アプリ内通知（スナックバー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無し |

### 送信先決定ロジック

現在の操作を実行しているアプリユーザーに対して即座に表示される。サーバーへの通知送信は行わず、クライアントサイドのみで処理される。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | deepOrange（エラー時） |
| アイコン | exclamation_circle |
| 表示時間 | 5秒 |

### 本文テンプレート

```
Invalid Stock Location
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | L10().invalidStockLocation | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| バーコード操作 | ロケーションバーコードスキャン | stocklocationキーなし または pk <= 0 | スキャン結果が有効なロケーションを含まない場合 |
| バーコード操作 | 親ロケーション設定失敗 | API statusCode 400 | 無効な親ロケーションを指定した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効なロケーションスキャン時 | PKが正の値で有効なロケーションの場合は通知なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ロケーションバーコードスキャン] --> B[サーバーAPIでバーコード検証]
    B --> C{レスポンス確認}
    C -->|stocklocation含む| D{PK確認}
    C -->|stocklocation含まない| E[無効ロケーション通知]
    D -->|PK > 0| F[ロケーション処理続行]
    D -->|PK <= 0| E
    E --> G[barcodeFailureTone再生]
    G --> H[showSnackIcon success=false]
    H --> I[エラースナックバー表示]
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし（クライアント側のみ） | - | サーバー側でバーコード検証が行われる |

### テーブル別参照項目詳細

クライアントアプリ側では直接データベースを参照しない。サーバーAPI経由でバーコードの検証が行われる。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | エラー時は更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ロケーション不存在 | スキャンしたバーコードがどのロケーションにも紐付いていない | ユーザーに再スキャンを促す |
| ロケーション削除済み | 以前有効だったロケーションが削除された | ユーザーに別のロケーションを選択させる |
| 非ロケーションバーコード | 在庫アイテムやパーツなど別種類のバーコードをスキャン | ユーザーにロケーションバーコードを求める |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（ユーザーによる手動再試行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

24時間365日（アプリ使用時のみ）

## セキュリティ考慮事項

- エラー通知には詳細なエラー情報は含まれず、単純な失敗メッセージのみ
- 無効なロケーションIDなどの技術的情報は通知に含まれない

## 備考

- 音声フィードバックが有効な場合、barcodeFailureTone()による失敗音が再生される
- 国際化対応済み（L10()による多言語サポート）
- この通知は複数のロケーションスキャンハンドラーで共通して使用される

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

無効ロケーション通知に関連するデータ構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | app_en.arb | `lib/l10n/app_en.arb` | invalidStockLocation の定義（671行目） |

**読解のコツ**: このメッセージはロケーションスキャン失敗時に使用される汎用エラーメッセージ。

#### Step 2: エントリーポイントを理解する

ロケーションスキャンハンドラーの基底クラスを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | stock.dart | `lib/barcode/stock.dart` | BarcodeScanStockLocationHandler クラス（25-60行目） |

**主要処理フロー**:
1. **30-52行目**: onBarcodeMatched - バーコードマッチ時の処理
2. **32行目**: data.containsKey("stocklocation") チェック
3. **33行目**: PK取得 (_loc = data["stocklocation"]?["pk"])
4. **49-51行目**: 失敗時の通知表示

#### Step 3: 派生クラスを理解する

親ロケーション設定ハンドラーでの使用を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | stock.dart | `lib/barcode/stock.dart` | ScanParentLocationHandler クラス（236-270行目） |

**主要処理フロー**:
- **253-256行目**: API statusCode 400時の invalidStockLocation 表示

### プログラム呼び出し階層図

```
BarcodeScanStockLocationHandler (stock.dart:25)
    │
    └─ onBarcodeMatched (stock.dart:30)
           │
           ├─ data.containsKey("stocklocation") チェック
           │      │
           │      └─ [含まない] → 失敗処理へ
           │
           └─ _loc = data["stocklocation"]?["pk"]
                  │
                  └─ [_loc <= 0] → 失敗処理
                         │
                         ├─ barcodeFailureTone (tones.dart:17)
                         └─ showSnackIcon(invalidStockLocation, success: false)

ScanParentLocationHandler (stock.dart:236)
    │
    └─ onLocationScanned (stock.dart:242)
           │
           └─ location.update() (stock.dart:243)
                  │
                  └─ [statusCode == 400] → 失敗処理
                         │
                         ├─ barcodeFailureTone
                         └─ showSnackIcon(invalidStockLocation)
```

### データフロー図

```
[入力]                    [処理]                      [出力]

ロケーション        ───▶ サーバーAPI              ───▶ バーコード検証
バーコードスキャン        /barcode/                     結果
                              │
                              ▼
                         レスポンス解析
                              │
               ┌──────────────┴──────────────┐
               ▼                              ▼
        stocklocation                   stocklocationなし
        キーあり                        または PK<=0
               │                              │
               ▼                              ▼
        ロケーション                    barcodeFailureTone()
        処理続行                              │
                                              ▼
                                        showSnackIcon
                                        "Invalid Stock Location"
                                        (オレンジ色背景)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| stock.dart | `lib/barcode/stock.dart` | ソース | ロケーションスキャンハンドラー |
| tones.dart | `lib/barcode/tones.dart` | ソース | 音声フィードバック |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー表示 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語ローカライゼーション |
| handler.dart | `lib/barcode/handler.dart` | ソース | BarcodeHandler基底クラス |
