# 通知設計書 18-アイテムは既にロケーション内

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「アイテムは既にロケーション内」通知の設計仕様を定義する。この通知は、在庫アイテムを特定のロケーションにスキャン移動しようとした際に、そのアイテムが既に指定されたロケーション内に存在する場合に表示される情報通知である。

### 本通知の処理概要

この通知は、バーコードスキャン機能を使用して在庫アイテムを新しいロケーションに移動させようとした際に、移動先と現在地が同じである場合のフィードバックとして機能する。

**業務上の目的・背景**：在庫管理において、重複する移動操作は非効率であり、またユーザーの混乱を招く可能性がある。アイテムが既に移動先のロケーションに存在する場合、この事実をユーザーに通知することで、不要なAPI呼び出しを防ぎ、ユーザーが現在の在庫状態を正しく理解できるようにする。

**通知の送信タイミング**：`StockLocationScanInItemsHandler` を使用して在庫アイテムをロケーションにスキャンした際に、アイテムの現在のロケーションIDと移動先ロケーションのIDが一致する場合に通知が生成される。

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

**通知内容の概要**：「Item already in location」というメッセージが表示され、スキャンした在庫アイテムが既に指定ロケーション内にあることをユーザーに伝える。

**期待されるアクション**：ユーザーはこの情報を確認し、別のアイテムをスキャンするか、別のロケーションへの移動を検討する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | lightGreen（情報通知として成功扱い） |
| アイコン | circle_check |
| 表示時間 | 5秒 |

### 本文テンプレート

```
Item already in location
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| バーコード操作 | アイテムスキャン | item.locationId == location.pk | スキャンしたアイテムが既にターゲットロケーション内にある場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 異なるロケーション | アイテムの現在ロケーションとターゲットロケーションが異なる場合は移動処理が実行される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ロケーション画面でアイテムスキャン] --> B[StockLocationScanInItemsHandler]
    B --> C[onItemScanned呼び出し]
    C --> D[アイテム情報取得]
    D --> E{ロケーション比較}
    E -->|item.locationId == location.pk| F[barcodeFailureTone再生]
    E -->|異なるロケーション| G[移動処理続行]
    F --> H[showSnackIcon success=true]
    H --> I[緑色スナックバー表示]
    I --> J[return false スキャンダイアログ維持]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし（クライアント側のみ） | - | クライアント側でロケーションIDの比較が行われる |

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

クライアントアプリ側でアイテムの locationId プロパティと移動先ロケーションの pk を比較する。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 既に同じロケーションにあるため更新不要 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | 情報通知のため該当なし | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（情報通知のため不要） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 通知内容には具体的な在庫情報やロケーション情報は含まれず、単純な情報メッセージのみ
- 機密情報は含まれない

## 備考

- 音声フィードバックが有効な場合、barcodeFailureTone()による音が再生される（視覚的には成功扱いだが、操作としては不要だったため）
- 国際化対応済み（L10()による多言語サポート）
- この通知後もバーコードスキャンダイアログは開いたままとなり、ユーザーは続けて別のアイテムをスキャンできる

---

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

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

### 推奨読解順序

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

アイテム既存通知に関連するデータ構造を把握する。

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

**読解のコツ**: このメッセージはアイテムが既に指定ロケーション内にある場合に使用される情報メッセージ。

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

アイテムスキャンハンドラーを特定する。

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

**主要処理フロー**:
1. **175行目**: onItemScanned関数開始
2. **176-181行目**: アイテム情報取得と確認設定取得
3. **187-190行目**: ロケーション比較と通知表示

#### Step 3: ロケーション比較ロジックを理解する

アイテムの現在ロケーションとターゲットロケーションの比較を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | stock.dart | `lib/barcode/stock.dart` | ロケーション比較処理（187行目） |

**主要処理フロー**:
- **187行目**: if (item.locationId == location.pk) チェック
- **188行目**: barcodeFailureTone() - 音声フィードバック
- **189行目**: showSnackIcon(L10().itemInLocation, success: true)
- **190行目**: return false - スキャンダイアログを維持

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

```
StockLocationScanInItemsHandler (stock.dart:166)
    │
    └─ onItemScanned (stock.dart:175)
           │
           ├─ InvenTreeStockItem().get(itemId) (stock.dart:176)
           │      └─ item取得
           │
           └─ ロケーション比較 (stock.dart:187)
                  │
                  └─ [item.locationId == location.pk]
                         │
                         ├─ barcodeFailureTone (tones.dart:17)
                         ├─ showSnackIcon(itemInLocation, success: true)
                         └─ return false
```

### データフロー図

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

アイテム            ───▶ StockLocationScan          ───▶ アイテム情報取得
バーコードスキャン        InItemsHandler                  │
                              │                           ▼
                              │                      onItemScanned
                              │                           │
                              ▼                           ▼
                         ロケーション比較     ───▶  [同じロケーション]
                              │                           │
                              │                           ▼
                              │                    barcodeFailureTone()
                              │                           │
                              │                           ▼
                              │                    showSnackIcon
                              │                    "Item already in location"
                              │                    (緑色背景 success=true)
                              │                           │
                              ▼                           ▼
                         [異なるロケーション]        return false
                              │                    (スキャンダイアログ維持)
                              ▼
                         移動処理続行
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| stock.dart | `lib/barcode/stock.dart` | ソース | 在庫スキャンハンドラー |
| stock.dart | `lib/inventree/stock.dart` | ソース | InvenTreeStockItemモデル（locationIdプロパティ） |
| tones.dart | `lib/barcode/tones.dart` | ソース | 音声フィードバック |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー表示 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語ローカライゼーション |
