# 通知設計書 30-アイテム受入成功

## 概要

本ドキュメントは、InvenTreeアプリにおけるアイテム受入成功通知の設計を定義する。購買発注からのアイテム受入処理が正常に完了した際に、ユーザーにスナックバー形式で成功を通知する。

### 本通知の処理概要

アイテム受入成功通知は、ユーザーが購買発注のラインアイテムに対して受入処理を実行し、その処理がサーバーに正常に完了した際に表示される。バーコードスキャンによる受入と手動フォームからの受入の両方で同じ通知が使用される。

**業務上の目的・背景**：購買発注からのアイテム受入は、調達プロセスにおける重要な入庫処理である。サプライヤーから届いた部品・資材を正式に在庫として登録する作業であり、この処理の完了をユーザーに即座にフィードバックすることで、入庫作業の進捗確認と在庫データの整合性維持を実現する。受入処理の失敗や重複を防ぐため、成功通知の明確な表示が重要である。

**通知の送信タイミング**：受入フォームで「受入」操作を実行し、サーバーAPIからの応答が成功となった直後、またはバーコードスキャンによる自動受入が成功した際に通知が送信される。`receive`メソッドの`onSuccess`コールバックや`onBarcodeMatched`/`onBarcodeUnhandled`メソッドで発火する。

**通知の受信者**：受入操作を実行したユーザー本人のみ。ローカル通知のため、他のユーザーには通知されない。

**通知内容の概要**：「Received Stock Item」（在庫アイテムを受け入れました）というテキストメッセージと成功を示す緑色のチェックマークアイコンが表示される。

**期待されるアクション**：ユーザーは通知を確認し、受入処理が正常に完了したことを認識する。バーコードスキャンモードでは続けて次のアイテムのスキャンが可能。通知は5秒後に自動的に消える。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（UIスレッド） |
| 優先度 | 中 |
| リトライ | 無し |

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

受入操作を実行したユーザーの画面に直接表示される。現在アクティブな画面コンテキストに対して通知が表示される。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 背景色 | Colors.lightGreen（成功時） |
| アイコン | TablerIcons.circle_check |
| 表示位置 | 画面下部 |
| 自動消去 | 5秒後 |

### 本文テンプレート

```
Received Stock Item
```

多言語対応: L10().receivedItem により国際化された文字列が使用される。

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | スナックバー通知のため添付なし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| receivedItem | 通知メッセージ | L10().receivedItem（国際化リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 発生元ファイル |
|------------|----------------|---------|--------------|
| 画面操作 | 購買発注ラインアイテム受入フォームの送信 | API応答が成功 | po_line_detail.dart |
| バーコードスキャン | サプライヤーバーコードスキャン受入 | API応答が成功（lineitem/success含む） | purchase_order.dart |
| バーコードスキャン | アクション必要時の受入フォーム送信 | API応答が成功 | purchase_order.dart |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| API応答エラー | サーバーからエラー応答があった場合は成功通知は表示されない |
| バーコード不一致 | バーコードがマッチしない場合は失敗通知が表示される |
| データ不足 | 必要なデータが不足している場合は失敗通知が表示される |

## 処理フロー

### 送信フロー（手動受入）

```mermaid
flowchart TD
    A[受入ボタン押下] --> B[receiveLineItemメソッド呼び出し]
    B --> C[item.receiveメソッド呼び出し]
    C --> D[受入フォーム表示]
    D --> E[ユーザーが数量・ロケーション入力]
    E --> F[送信ボタン押下]
    F --> G[API POST リクエスト送信]
    G --> H{API応答}
    H -->|成功| I[onSuccessコールバック実行]
    H -->|失敗| J[エラーハンドリング]
    I --> K[showSnackIcon呼び出し]
    K --> L[スナックバー表示]
    L --> M[画面リフレッシュ]
```

### 送信フロー（バーコードスキャン受入）

```mermaid
flowchart TD
    A[バーコードスキャン] --> B[processBarcode呼び出し]
    B --> C[API barcode/po-receive/ POST]
    C --> D{API応答}
    D -->|lineitem/success| E[onBarcodeMatched呼び出し]
    D -->|action_required| F[onBarcodeUnhandled呼び出し]
    D -->|error| G[onBarcodeUnknown呼び出し]
    E --> H[barcodeSuccess呼び出し]
    H --> I[showSnackIcon]
    F --> J[受入フォーム表示]
    J --> K[送信ボタン押下]
    K --> L[API POST]
    L --> M{応答}
    M -->|成功| N[showSnackIcon]
    G --> O[barcodeFailureTone + エラー通知]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| purchase_order_line_item | 受入対象ラインアイテム | InvenTreePOLineItem モデル |
| purchase_order | 関連購買発注 | 発注ステータス確認用 |
| stock_location | 受入先ロケーション | 受入先の選択用 |

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

#### purchase_order_line_item（サーバー側）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | ラインアイテム識別子 | 受入対象のID |
| order | 購買発注ID | 発注情報の取得 |
| quantity | 発注数量 | 受入可能数量の計算 |
| received | 受入済み数量 | 受入進捗の確認 |
| destination | デフォルト受入先 | フォーム初期値 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| stock_item | INSERT | 新規在庫アイテムの作成 |
| purchase_order_line_item | UPDATE | 受入済み数量の更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API通信エラー | ネットワーク接続不可 | エラーダイアログ表示 |
| バリデーションエラー | 入力値が不正（数量超過等） | フォームエラー表示 |
| バーコード不一致 | スキャンしたバーコードが認識されない | barcodeFailureTone + エラー通知 |
| データ不足 | 必要な情報が不足 | missingData通知表示 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（自動リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作起点のため）

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

- 通知はローカル表示のみで外部送信なし
- 通知内容に機密情報は含まれない
- 受入権限チェックはAPI側で実施

## 備考

- 通知メッセージは国際化対応済み（L10().receivedItem）
- バーコードスキャンモードでは成功時に音声フィードバック（barcodeSuccessTone）も再生
- 設定により確認ダイアログの表示/非表示が切り替わる（INV_PO_CONFIRM_SCAN）
- 自動受入モード（auto_allocate: true）では確認なしで即座に受入処理が実行される
- 受入時にカスタムバーコードを在庫アイテムに割り当てることが可能

---

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

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

### 推奨読解順序

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

InvenTreePOLineItemクラスがラインアイテムデータと受入処理を定義している。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | purchase_order.dart | `lib/inventree/purchase_order.dart` | InvenTreePOLineItemクラス、receiveメソッドの定義 |

**読解のコツ**: receiveメソッドは受入フォームを表示し、APIに受入リクエストを送信する。

#### Step 2: 手動受入のエントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | po_line_detail.dart | `lib/widget/order/po_line_detail.dart` | `receiveLineItem`メソッド（127-136行目） |

**主要処理フロー**:
1. **62-81行目**: actionButtonsで受入ボタンを追加
2. **67行目**: widget.item.isCompleteで受入完了チェック
3. **127行目**: `receiveLineItem`メソッド定義
4. **129-135行目**: item.receiveのonSuccessコールバックでshowSnackIcon呼び出し

#### Step 3: バーコードスキャン受入を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | purchase_order.dart (barcode) | `lib/barcode/purchase_order.dart` | POReceiveBarcodeHandlerクラス |

**主要処理フロー**:
1. **22-27行目**: POReceiveBarcodeHandlerクラス定義
2. **33-52行目**: processBarcode - API呼び出しとパラメータ設定
3. **54-62行目**: onBarcodeMatched - 成功時の処理
4. **57行目**: barcodeSuccess(L10().receivedItem) でスナックバー表示
5. **65-116行目**: onBarcodeUnhandled - アクション必要時の処理
6. **107-114行目**: receive完了後にshowSnackIcon呼び出し
7. **118-125行目**: onBarcodeUnknown - エラー時の処理

#### Step 4: 通知表示層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数の実装詳細 |
| 4-2 | barcode.dart | `lib/barcode/barcode.dart` | barcodeSuccess関数（showSnackIconのラッパー） |

**主要処理フロー**:
- **barcode.dart 39-41行目**: barcodeSuccess関数 - 成功音再生とshowSnackIcon呼び出し

#### Step 5: 国際化リソースを理解する

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

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

```
[手動受入]
POLineDetailWidget (po_line_detail.dart)
    |
    +-- receiveLineItem() [127行目]
           |
           +-- widget.item.receive() [129行目]
                  |
                  +-- onSuccess callback [131-134行目]
                         |
                         +-- showSnackIcon() [132行目]
                         |
                         +-- refresh() [133行目]

[バーコードスキャン受入]
POReceiveBarcodeHandler (purchase_order.dart)
    |
    +-- processBarcode() [33行目]
           |
           +-- super.processBarcode() --> API呼び出し
                  |
                  +-- onBarcodeMatched() [54行目]
                  |      |
                  |      +-- barcodeSuccess() [57行目] --> showSnackIcon()
                  |
                  +-- onBarcodeUnhandled() [65行目]
                  |      |
                  |      +-- lineItem.receive() [107行目]
                  |             |
                  |             +-- onSuccess --> showSnackIcon() [113行目]
                  |
                  +-- onBarcodeUnknown() [118行目]
                         |
                         +-- barcodeFailureTone() + showSnackIcon(error)
```

### データフロー図

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

ユーザー操作
(受入/スキャン)  ──────> receive() / processBarcode()
                               |
                               v
                         API POST リクエスト
                         (receive endpoint /
                          barcode/po-receive/)
                               |
                               v
                         サーバー処理
                         - 在庫アイテム作成
                         - 受入数量更新
                               |
                               v
                         成功応答
                               |
                               +───> showSnackIcon() ──────> スナックバー表示
                               |           |
                               |           v
                               |     L10().receivedItem ──────> "Received Stock Item"
                               |
                               +───> barcodeSuccessTone() ──────> 成功音再生
                               |     (バーコードスキャン時のみ)
                               |
                               +───> refresh() ──────> 画面更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| purchase_order.dart (barcode) | `lib/barcode/purchase_order.dart` | ソース | バーコードスキャン受入ハンドラ |
| po_line_detail.dart | `lib/widget/order/po_line_detail.dart` | ソース | 購買発注ライン詳細画面、手動受入 |
| purchase_order.dart (model) | `lib/inventree/purchase_order.dart` | ソース | 購買発注ラインモデル、receiveメソッド |
| barcode.dart | `lib/barcode/barcode.dart` | ソース | barcodeSuccess関数 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知表示 |
| tones.dart | `lib/barcode/tones.dart` | ソース | バーコード成功/失敗音 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語メッセージ定義 |
