# 通知設計書 27-販売発注更新

## 概要

本ドキュメントは、InvenTreeアプリにおける販売発注更新通知の設計を定義する。販売発注情報の編集が正常に完了した際に、ユーザーにスナックバー形式で成功を通知する。

### 本通知の処理概要

販売発注更新通知は、ユーザーが販売発注詳細画面から販売発注情報を編集し、その変更がサーバーに正常に保存された際に表示される。

**業務上の目的・背景**：販売発注（Sales Order）は、顧客への製品販売を管理する中核的なビジネスプロセスである。発注参照番号、説明、顧客参照番号、目標日、担当者などの変更が正しく反映されたことをユーザーに即座にフィードバックすることで、販売業務の正確性と顧客対応の効率化を実現する。販売発注情報の誤りは出荷ミスや顧客クレームに直結するため、更新完了の明確な確認が重要である。

**通知の送信タイミング**：販売発注編集フォームで「保存」操作を実行し、サーバーAPIからの応答が成功となった直後に通知が送信される。`editOrder`メソッド内の`onSuccess`コールバックで発火する。

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

**通知内容の概要**：「Sales order updated」（販売発注が更新されました）というテキストメッセージと成功を示す緑色のチェックマークアイコンが表示される。

**期待されるアクション**：ユーザーは通知を確認し、販売発注の編集が正常に完了したことを認識する。通知は5秒後に自動的に消える。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### スナックバー通知

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

### 本文テンプレート

```
Sales order updated
```

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | 販売発注編集フォームの保存ボタン押下 | API応答が成功 | `editOrder`メソッド内でeditFormのonSuccessコールバック実行時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| API応答エラー | サーバーからエラー応答があった場合は成功通知は表示されない |
| 編集権限なし | widget.order.canEditがfalseの場合は編集ボタンが表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[編集ボタン押下] --> B[editOrderメソッド呼び出し]
    B --> C[フォームフィールド準備]
    C --> D[編集フォーム表示]
    D --> E[ユーザーが値を変更]
    E --> F[保存ボタン押下]
    F --> G[API PUT/PATCH リクエスト送信]
    G --> H{API応答}
    H -->|成功| I[onSuccessコールバック実行]
    H -->|失敗| J[エラーハンドリング]
    I --> K[画面リフレッシュ]
    K --> L[showSnackIcon呼び出し]
    L --> M[スナックバー表示]
    M --> N[5秒後自動消去]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sales_order | 編集対象販売発注の現在値取得 | InvenTreeSalesOrder モデル経由 |

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

#### sales_order（サーバー側）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | 販売発注識別子 | 編集対象販売発注のID |
| reference | 発注参照番号 | フォーム表示用 |
| description | 説明 | フォーム表示用 |
| customer | 顧客ID | フォーム表示用 |
| customer_reference | 顧客参照番号 | フォーム表示用 |
| target_date | 目標日 | フォーム表示用 |
| responsible | 担当者ID | フォーム表示用 |
| project_code | プロジェクトコード | フォーム表示用（サーバー対応時） |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| sales_order | UPDATE | 販売発注情報の更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API通信エラー | ネットワーク接続不可 | エラーダイアログ表示 |
| バリデーションエラー | 入力値が不正 | フォームエラー表示 |
| 権限エラー | 編集権限なし | 権限エラー通知 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 通知はローカル表示のみで外部送信なし
- 通知内容に機密情報は含まれない
- 編集権限チェックはモデル側で実施（widget.order.canEdit）

## 備考

- 通知メッセージは国際化対応済み（L10().salesOrderUpdated）
- 編集時に顧客フィールドは変更不可（fields.remove("customer")）
- 連絡先モデル非対応サーバーでは連絡先フィールドが非表示
- プロジェクトコード非対応サーバーではプロジェクトコードフィールドが非表示
- 販売発注には発行、キャンセルなどのステータス変更アクションも存在
- バーコードスキャンによる在庫割当機能も統合されている

---

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

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

### 推奨読解順序

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

InvenTreeSalesOrderクラスが販売発注データの構造を定義している。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sales_order.dart | `lib/inventree/sales_order.dart` | InvenTreeSalesOrderクラスの定義、ステータス管理 |

**読解のコツ**: 販売発注には複数のステータス（Pending、In Progress、Complete、Cancelled等）があり、ステータスによって利用可能なアクションが異なる。

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

販売発注詳細画面が編集操作のエントリーポイント。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sales_order_detail.dart | `lib/widget/order/sales_order_detail.dart` | `editOrder`メソッド（309-334行目）が編集処理の起点 |

**主要処理フロー**:
1. **62-77行目**: appBarActionsで編集ボタンを追加
2. **65行目**: widget.order.canEditで権限チェック
3. **309行目**: `editOrder`メソッド定義
4. **311-323行目**: フォームフィールドの動的設定（顧客除去、連絡先/プロジェクトコード対応）
5. **325-333行目**: editFormのonSuccessコールバックでrefreshとshowSnackIcon呼び出し

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数の実装詳細 |

**主要処理フロー**:
- **11行目**: showSnackIcon関数定義
- **35-41行目**: success: true時の緑色背景とチェックアイコン設定

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

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

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

```
SalesOrderDetailWidget (sales_order_detail.dart)
    |
    +-- appBarActions() [62-77行目]
           |
           +-- IconButton onPressed
                  |
                  +-- editOrder() [309行目]
                         |
                         +-- フォームフィールド準備 [311-323行目]
                         |
                         +-- widget.order.editForm() [325行目]
                                |
                                +-- onSuccess callback [329-332行目]
                                       |
                                       +-- refresh(context) [330行目]
                                       |
                                       +-- showSnackIcon() [331行目]
```

### データフロー図

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

ユーザー操作
(編集ボタン)  ──────> editOrder()
                            |
                            v
                      フォームフィールド準備
                      (customer除去、条件付きフィールド)
                            |
                            v
                      editForm()
                            |
                            v
                      API PUT/PATCH ──────> サーバー
                            |
                            v
                      onSuccess
                            |
                            +───> refresh()
                            |
                            +───> showSnackIcon() ──────> スナックバー表示
                                        |
                                        v
                                  L10().salesOrderUpdated ──────> "Sales order updated"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sales_order_detail.dart | `lib/widget/order/sales_order_detail.dart` | ソース | 販売発注詳細画面、編集処理起動 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知表示 |
| sales_order.dart | `lib/inventree/sales_order.dart` | ソース | 販売発注モデル定義 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語メッセージ定義 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー |
