# 通知設計書 17-無効な在庫アイテム

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：在庫管理において、正確な在庫アイテムの識別は重要な業務要件である。スキャンしたバーコードが有効な在庫アイテムを指していない場合（データベースに存在しない、削除された、または在庫アイテム以外のバーコードなど）、ユーザーは即座にこれを認識し、正しい在庫アイテムをスキャンし直す必要がある。この通知により、誤ったアイテムの操作を防止できる。

**通知の送信タイミング**：`BarcodeScanStockItemHandler` または派生クラスを使用してバーコードをスキャンし、スキャン結果に `stockitem` キーが含まれていないか、PKが0以下の場合に通知が生成される。

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

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

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

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### スナックバー通知

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

### 本文テンプレート

```
Invalid Stock Item
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| バーコード操作 | 在庫アイテムバーコードスキャン | stockitemキーなし または pk <= 0 | スキャン結果が有効な在庫アイテムを含まない場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効なアイテムスキャン時 | PKが正の値で有効な在庫アイテムの場合は通知なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[在庫アイテムバーコードスキャン] --> B[サーバーAPIでバーコード検証]
    B --> C{レスポンス確認}
    C -->|stockitem含む| D{PK確認}
    C -->|stockitem含まない| 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` | invalidStockItem の定義（674行目） |

**読解のコツ**: このメッセージは在庫アイテムスキャン失敗時に使用される汎用エラーメッセージ。

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

在庫アイテムスキャンハンドラーの基底クラスを特定する。

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

**主要処理フロー**:
1. **73-95行目**: onBarcodeMatched - バーコードマッチ時の処理
2. **75行目**: data.containsKey("stockitem") チェック
3. **76行目**: PK取得 (_item = data["stockitem"]?["pk"])
4. **92-94行目**: 失敗時の通知表示

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

ロケーションへのアイテムスキャンハンドラーでの使用を確認する。

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

**主要処理フロー**:
- **175行目以降**: onItemScannedのオーバーライド

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

```
BarcodeScanStockItemHandler (stock.dart:68)
    │
    └─ onBarcodeMatched (stock.dart:73)
           │
           ├─ data.containsKey("stockitem") チェック
           │      │
           │      └─ [含まない] → 失敗処理へ
           │
           └─ _item = data["stockitem"]?["pk"]
                  │
                  └─ [_item <= 0] → 失敗処理
                         │
                         ├─ barcodeFailureTone (tones.dart:17)
                         └─ showSnackIcon(invalidStockItem, success: false)

StockLocationScanInItemsHandler (stock.dart:166)
    │
    └─ extends BarcodeScanStockItemHandler
           │
           └─ onItemScanned (stock.dart:175)
                  └─ 在庫アイテム処理
```

### データフロー図

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

在庫アイテム        ───▶ サーバーAPI              ───▶ バーコード検証
バーコードスキャン        /barcode/                     結果
                              │
                              ▼
                         レスポンス解析
                              │
               ┌──────────────┴──────────────┐
               ▼                              ▼
          stockitem                     stockitemなし
          キーあり                      または PK<=0
               │                              │
               ▼                              ▼
        barcodeSuccessTone()          barcodeFailureTone()
        アイテム処理続行                      │
                                              ▼
                                        showSnackIcon
                                        "Invalid Stock Item"
                                        (オレンジ色背景)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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基底クラス |
