# 通知設計書 47-パーツ販売不可

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「パーツ販売不可」通知の設計仕様を定義するものである。バーコードスキャンによる販売発注（Sales Order）へのパーツ追加時に、対象パーツが販売可能としてマークされていない場合に表示されるエラー通知について記載する。

### 本通知の処理概要

本通知は、バーコードスキャンで特定したパーツが販売可能（salable）属性を持っていないことをユーザーに通知するためのアプリ内スナックバー通知である。

**業務上の目的・背景**：InvenTreeでは、パーツに「販売可能」（salable）属性を設定することで、販売発注に追加できるパーツを管理している。この属性が設定されていないパーツは、販売発注のラインアイテムとして追加できない。ユーザーがこのようなパーツのバーコードをスキャンした場合、なぜ追加できないのかを明確に通知することで、業務の混乱を防ぎ、適切な対応（パーツ設定の変更、正しいパーツの選択など）を促す。

**通知の送信タイミング**：バーコードスキャンによりパーツが特定され、そのパーツの`isSalable`プロパティがfalseの場合に通知される。具体的には、`SOAddItemBarcodeHandler`クラスの`onBarcodeMatched`メソッド内でパーツ情報を取得した後、`part.isSalable`を確認した時点でトリガーされる。

**通知の受信者**：バーコードスキャン操作を実行したユーザー本人のみ。アプリ内通知であるため、他のユーザーには通知されない。

**通知内容の概要**：「パーツは販売可能としてマークされていません」を示すローカライズされたメッセージ（`L10().partNotSalable`）と、失敗を示すオレンジ色の背景、警告アイコンがスナックバーとして画面下部に表示される。また、失敗音も再生される。

**期待されるアクション**：ユーザーはパーツが販売不可であることを認識し、以下のいずれかの対応を取る：別のパーツをスキャンする、パーツの設定を変更して販売可能にする、または管理者に連絡する。

## 通知種別

アプリ内通知（スナックバー）+ 音声フィードバック

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | なし（UI通知のため） |

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

操作を実行したユーザーのアプリ画面に直接表示。ユーザー選択や条件分岐は不要。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 背景色 | `Colors.deepOrange`（失敗時） |
| アイコン | `TablerIcons.exclamation_circle` |
| 表示時間 | 5秒 |
| 形式 | スナックバー（画面下部） |

### 音声通知

| 項目 | 内容 |
|-----|------|
| 音声ファイル | `sounds/barcode_error.mp3` |
| トリガー | `barcodeFailureTone()`関数 |

### 本文テンプレート

```
{L10().partNotSalable}
```

英語の場合: "Part not marked as salable" または類似のメッセージ

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| partNotSalable | パーツ販売不可メッセージ | L10()（国際化リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| バーコードスキャン | パーツバーコードの認識成功 | `part.isSalable` == false | パーツが販売可能でない |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| isSalable == true | パーツが販売可能な場合はラインアイテム追加フォームが表示される |
| パーツ取得失敗 | パーツが見つからない場合は別のエラー処理 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[バーコードスキャン] --> B[バーコードAPI呼び出し]
    B --> C{パーツID取得}
    C -->|ID無効| D[onBarcodeUnknown]
    C -->|ID有効| E[InvenTreePart取得]
    E --> F{パーツ取得成功}
    F -->|失敗| D
    F -->|成功| G{isSalable確認}
    G -->|true| H[ラインアイテム追加フォーム表示]
    G -->|false| I[barcodeFailureTone]
    I --> J[showSnackIcon partNotSalable]
    D --> K[エラー通知]
    J --> L[終了]
    H --> L
    K --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| Part | パーツ情報の取得 | InvenTreeサーバー側 |

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

#### Part（サーバー側）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | パーツID | バーコードから取得 |
| salable | 販売可能フラグ | isSalableプロパティで参照 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 通知のみで更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パーツ取得失敗 | APIエラー | 別のエラー通知を表示 |
| バーコード不一致 | パーツIDが取得できない | onBarcodeUnknownで処理 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作に応じて即座に表示）

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

- バーコードスキャン操作は認証済みユーザーのみ実行可能
- パーツ情報へのアクセスには適切な権限が必要

## 備考

- バーコードスキャナーは閉じずに継続してスキャンが可能（エラー後も別のパーツをスキャンできる）
- パーツの販売可能設定はInvenTree Webインターフェースで変更可能
- 国際化対応済み（L10()による多言語サポート）

---

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

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

### 推奨読解順序

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

パーツモデルのsalable属性を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | part.dart | `lib/inventree/part.dart` | InvenTreePartクラスのisSalableプロパティ |

**読解のコツ**: `isSalable`がJSONデータのどのフィールドから取得されるか確認する。

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

バーコードスキャン処理の起点を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sales_order.dart | `lib/barcode/sales_order.dart` | SOAddItemBarcodeHandler.onBarcodeMatched（30-75行目） |

**主要処理フロー**:
1. **32-40行目**: パーツIDの取得と検証
2. **43行目**: `InvenTreePart().get(part_id)` でパーツ取得
3. **46行目**: `part.isSalable` の確認
4. **67-69行目**: isSalable=falseの場合の処理

#### Step 3: 通知表示処理を理解する

失敗時のスナックバーと音声フィードバックを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | tones.dart | `lib/barcode/tones.dart` | barcodeFailureTone関数 |
| 3-2 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数のsuccess=false時の処理 |

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

```
SOAddItemBarcodeHandler (sales_order.dart line 21)
    │
    ├─ getOverlayText() - "Scan Part" オーバーレイ
    │
    └─ onBarcodeMatched() (line 30-75)
           │
           ├─ パーツID抽出 (line 32-40)
           │      └─ data["part"]["pk"]
           │
           ├─ InvenTreePart().get(part_id) (line 43)
           │      └─ パーツ情報取得
           │
           └─ [part is InvenTreePart] (line 45-75)
                  │
                  ├─ [isSalable == true] (line 46-66)
                  │      │
                  │      ├─ OneContext().pop() - スキャナー閉じる
                  │      │
                  │      └─ InvenTreeSOLineItem().createForm() - フォーム表示
                  │
                  └─ [isSalable == false] (line 67-70)
                         │
                         ├─ barcodeFailureTone() - 失敗音
                         │      └─ playAudioFile("sounds/barcode_error.mp3")
                         │
                         └─ showSnackIcon(L10().partNotSalable, success: false)
                                └─ オレンジ背景、警告アイコン表示
```

### データフロー図

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

バーコード       ┌─────────────────┐
スキャン ───────▶│onBarcodeMatched │
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │パーツID抽出     │
                 │data["part"]["pk"]│
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐     API Request
                 │InvenTreePart   │────────────────▶ InvenTreeサーバー
                 │.get(part_id)   │◀────────────────  Part情報
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │isSalable確認    │
                 └────────┬────────┘
                          │
                          ▼ (false)
                 ┌─────────────────┐
                 │barcodeFailure  │───▶ 失敗音再生
                 │Tone()          │
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │showSnackIcon() │───▶ エラースナックバー
                 │partNotSalable  │     (オレンジ背景)
                 └─────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sales_order.dart | `lib/barcode/sales_order.dart` | ソース | SOパーツ追加バーコードハンドラー |
| part.dart | `lib/inventree/part.dart` | ソース | パーツモデル、isSalableプロパティ |
| tones.dart | `lib/barcode/tones.dart` | ソース | 失敗音再生 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示関数 |
| handler.dart | `lib/barcode/handler.dart` | ソース | バーコードハンドラー基底クラス |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数 |
