# 通知設計書 54-購買発注キャンセル確認

## 概要

本ドキュメントは、InvenTreeアプリにおける「購買発注（Purchase Order）キャンセル確認」ダイアログの設計仕様を定義する。購買発注をキャンセルする前に、ユーザーに対して確認を求めるダイアログを表示する。

### 本通知の処理概要

購買発注のキャンセルは、サプライヤーとの取引をキャンセル状態に変更する重要な業務操作である。この確認ダイアログは、誤操作によるキャンセルを防ぎ、業務の正確性を確保するためのセーフティメカニズムとして機能する。

**業務上の目的・背景**：購買発注はサプライヤーからの部品・資材調達を管理する重要なデータであり、キャンセルはサプライチェーンや生産計画に影響を与える。誤ってキャンセルを実行すると、調達の遅延や在庫不足が発生する可能性がある。このため、キャンセル前に確認ダイアログを表示し、ユーザーに最終確認を求めることで、業務の正確性と信頼性を確保する。

**通知の送信タイミング**：ユーザーが購買発注詳細画面のアクションボタン（SpeedDial）から「キャンセル」オプションをタップした時点で、即座に確認ダイアログが表示される。キャンセルオプションは発注がオープン状態（isOpen）の場合にのみ利用可能。

**通知の受信者**：現在の操作を行っているユーザー自身。購買発注の作成権限（canCreate）を持つユーザーがキャンセルアクションを実行でき、確認ダイアログを目にすることになる。

**通知内容の概要**：タイトルとして「Cancel Order」を表示する。ダイアログには×マーク（赤色、TablerIcons.circle_x）が表示され、「Cancel」の2つのボタンが提供される。

**期待されるアクション**：ユーザーは「Cancel」ボタンをタップしてキャンセルを実行するか、ダイアログを閉じて操作をキャンセルする。キャンセルを実行した場合、APIを通じて購買発注のステータスが「キャンセル」に変更され、画面が更新される。

## 通知種別

アプリ内確認ダイアログ（AlertDialog）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（ユーザー操作による即時表示） |
| 優先度 | 高（モーダルダイアログとしてユーザー操作を遮断） |
| リトライ | 無（ダイアログ表示の失敗は考慮しない） |

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

- 現在アプリを操作しているユーザー
- 条件：`widget.order.canCreate == true` かつ `widget.order.isOpen == true` を満たす場合にキャンセルアクションが表示される

## 通知テンプレート

### ダイアログ構成

| 項目 | 内容 |
|-----|------|
| アイコン | TablerIcons.circle_x（赤色） |
| タイトル | L10().cancelOrder |
| 本文 | （空文字列） |
| 形式 | AlertDialog |

### ボタン構成

| ボタン | テキスト | 動作 |
|-------|---------|------|
| 承認ボタン | L10().cancel | キャンセル処理を実行 |
| 拒否ボタン | L10().cancel（デフォルト） | ダイアログを閉じる |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| cancelOrder | キャンセルダイアログのタイトル | L10()（ローカライズ文字列） | Yes |
| cancel | キャンセルボタンのテキスト | L10()（ローカライズ文字列） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | SpeedDialのキャンセルボタンタップ | canCreate && isOpen | 購買発注詳細画面のアクションメニューからキャンセルを選択 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| canCreate == false | ユーザーに作成権限がない場合 |
| isOpen == false | 発注がオープン状態でない場合、キャンセルボタン自体が表示されない |
| hasContext() == false | アプリコンテキストが利用できない場合（テスト環境等） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがキャンセルボタンをタップ] --> B[_cancelOrder関数呼び出し]
    B --> C[confirmationDialog表示]
    C --> D{ユーザーの選択}
    D -->|Cancel承認| E[widget.order.cancelOrder呼び出し]
    D -->|Cancel拒否| F[ダイアログを閉じる]
    E --> G[refresh実行]
    G --> H[画面更新完了]
    F --> I[終了]
    H --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| PurchaseOrder | キャンセル対象の購買発注情報 | InvenTreeサーバーAPI経由 |

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

#### PurchaseOrder

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | キャンセル対象の識別 | 画面表示中の発注ID |
| isOpen | キャンセル可否の判定 | ステータスによる |
| canCreate | 権限確認 | ユーザー権限 |
| status | 現在の発注ステータス | 発注データから取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| PurchaseOrder | UPDATE | ステータスをキャンセルに変更 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| キャンセル失敗 | API呼び出しが失敗した場合 | API層でエラーハンドリング |
| 権限エラー | キャンセル権限がない場合 | サーバーサイドでエラー返却 |
| ネットワークエラー | サーバーに接続できない場合 | API層でエラーハンドリング |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（ダイアログ表示はリトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作による即時表示）

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

- キャンセル操作はサーバーサイドで認証・認可チェックが行われる
- 確認ダイアログにより誤操作を防止
- 発注ステータスの変更はサーバーで検証される

## 備考

- キャンセル成功後、画面が自動的に更新される（refresh呼び出し）
- ローカライズ対応により多言語での表示が可能

---

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

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

### 推奨読解順序

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

購買発注のデータモデルと、ダイアログで使用されるパラメータを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | purchase_order.dart | `lib/inventree/purchase_order.dart` | InvenTreePurchaseOrderクラスの構造、isOpen属性、cancelOrder()メソッド |
| 1-2 | dialogs.dart | `lib/widget/dialogs.dart` | confirmationDialog関数のパラメータと動作 |

**読解のコツ**: 購買発注のステータス管理（isPending, isOpen, isPlaced等）を理解することが重要。

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

ユーザーがキャンセル操作を開始する起点となるコードを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | purchase_order_detail.dart | `lib/widget/order/purchase_order_detail.dart` | actionButtons()メソッドでのキャンセルボタン生成、_cancelOrder()メソッドの呼び出し |

**主要処理フロー**:
1. **142-152行目**: isOpen条件チェックとSpeedDialChild生成
2. **225-238行目**: _cancelOrder()メソッドでconfirmationDialogを呼び出し

#### Step 3: ダイアログ表示処理を理解する

確認ダイアログの表示ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | dialogs.dart | `lib/widget/dialogs.dart` | confirmationDialog()関数（61-114行目）の実装詳細 |

**主要処理フロー**:
- **61-70行目**: 関数シグネチャとデフォルトパラメータ
- **78-113行目**: OneContext().showDialogによるダイアログ表示とボタン処理

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

```
PurchaseOrderDetailWidget (purchase_order_detail.dart)
    |
    +-- actionButtons() [92-156行目]
    |       |
    |       +-- SpeedDialChild (キャンセルボタン) [142-152行目]
    |               |
    |               +-- _cancelOrder() [225-238行目]
    |                       |
    |                       +-- confirmationDialog() [dialogs.dart:61-114行目]
    |                       |       |
    |                       |       +-- OneContext().showDialog()
    |                       |       |
    |                       |       +-- onAccept callback
    |                       |               |
    |                       |               +-- widget.order.cancelOrder()
    |                       |               |
    |                       |               +-- refresh(context)
```

### データフロー図

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

ユーザー操作 ────────> _cancelOrder() ───────────> confirmationDialog表示
(キャンセルボタンタップ)                                      |
                                                              v
                                                    ユーザー選択待ち
                                                              |
                              +------------------+------------+
                              |                  |
                              v                  v
                       [Cancel承認]        [Cancel拒否]
                              |                  |
                              v                  v
                        APIキャンセルリクエスト  ダイアログ閉じる
                              |
                              v
                        refresh()呼び出し
                              |
                              v
                        画面更新完了
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| purchase_order_detail.dart | `lib/widget/order/purchase_order_detail.dart` | ソース | 購買発注詳細画面、キャンセル処理の起点 |
| dialogs.dart | `lib/widget/dialogs.dart` | ソース | confirmationDialog関数の実装 |
| purchase_order.dart | `lib/inventree/purchase_order.dart` | ソース | InvenTreePurchaseOrderモデル、cancelOrder()メソッド |
| l10.dart | `lib/l10.dart` | ソース | ローカライズヘルパー関数 |
| refreshable_state.dart | `lib/widget/refreshable_state.dart` | ソース | refresh()メソッドの基底クラス |
