MailRequestTable (NablarchApi)

java.lang.Object
- nablarch.common.mail.MailRequestTable

すべての実装されたインタフェース:

Initializable
```
@Published(tag="architect")
public class MailRequestTable
extends Object
implements Initializable
```
メール送信要求管理テーブルのスキーマを保持するデータオブジェクト。

作成者:

Shinsuke Yoshio

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`SqlPStatement`	`createReaderStatement(String mailSendPatternId)` 処理対象データを取得する`SqlPStatement`を生成する。
`SqlPStatement`	`createReaderStatement(String mailSendPatternId, String sendProcessId)` 処理対象データを取得する`SqlPStatement`を生成する。
`nablarch.common.mail.MailRequestTable.MailRequest`	`getMailRequest(SqlRow data)` SQLの取得結果の1レコードをMailRequestTable.MailRequestに変換する。
`int`	`getTargetCount(String mailRequestPatternId)` 処理対象件数を取得する。
`void`	`initialize()` SQLを初期化する。
`void`	`insert(String mailRequestId, MailContext context)` メール送信要求管理テーブルにレコードを登録する。
`void`	`insert(String mailRequestId, MailContext context, String transactionName)` 指定されたトランザクション名を用いてメール送信要求管理テーブルにレコードを登録する。
`void`	`setCharsetColumnName(String charsetColumnName)` メール送信要求管理テーブルの文字セットカラムの名前を設定する。
`void`	`setFromColumnName(String fromColumnName)` メール送信要求管理テーブルの送信者メールアドレスカラムの名前を設定する。
`void`	`setMailBodyColumnName(String mailBodyColumnName)` メール送信要求管理テーブルの本文カラムの名前を設定する。
`void`	`setMailConfig(MailConfig mailConfig)` メール関連のコード値を保持するデータオブジェクトを設定する。
`void`	`setMailRequestIdColumnName(String mailRequestIdColumnName)` メール送信要求管理テーブルの要求IDカラムの名前を設定する。
`void`	`setMailSendPatternIdColumnName(String mailSendPatternIdColumnName)` メール送信要求管理テーブルのメール送信パターンIDをのカラム名を設定する。
`void`	`setReplyToColumnName(String replyColumnName)` メール送信要求管理テーブルの返信先メールアドレスカラムの名前を設定する。
`void`	`setRequestDateTimeColumnName(String requestDateTimeColumnName)` メール送信要求管理テーブルの要求日時カラムの名前を設定する。
`void`	`setReturnPathColumnName(String returnPathColumnName)` メール送信要求管理テーブルの差し戻し先メールアドレスカラムの名前を設定する。
`void`	`setSendDateTimeColumnName(String sendDateTimeColumnName)` メール送信要求管理テーブルの送信日時カラムの名前を設定する。
`void`	`setSendProcessIdColumnName(String sendProcessIdColumnName)` 送信するバッチのプロセスIDのカラム名を設定する。
`void`	`setStatusColumnName(String statusColumnName)` メール送信要求管理テーブルのステータスカラムの名前を設定する。
`void`	`setSubjectColumnName(String subjectColumnName)` メール送信要求管理テーブルの件名カラムの名前を設定する。
`void`	`setTableName(String tableName)` メール送信要求管理テーブルの名前を設定する。
`void`	`updateFailureStatus(String mailRequestId, String status)` ステータスを更新する。
`void`	`updateSendProcessId(String sendProcessId)` メール送信バッチのプロセスIDを更新する。
`void`	`updateStatus(String mailRequestId, String status)` ステータスを更新する。

- メソッドの詳細
  - setTableName
```
public void setTableName(String tableName)
```
    メール送信要求管理テーブルの名前を設定する。
    
    パラメータ:
    
    tableName - メール送信要求管理テーブルの名前
  - setMailRequestIdColumnName
```
public void setMailRequestIdColumnName(String mailRequestIdColumnName)
```
    メール送信要求管理テーブルの要求IDカラムの名前を設定する。
    
    パラメータ:
    
    mailRequestIdColumnName - メール送信要求管理テーブルの要求IDカラムの名前
  - setSubjectColumnName
```
public void setSubjectColumnName(String subjectColumnName)
```
    メール送信要求管理テーブルの件名カラムの名前を設定する。
    
    パラメータ:
    
    subjectColumnName - メール送信要求管理テーブルの件名カラムの名前
  - setFromColumnName
```
public void setFromColumnName(String fromColumnName)
```
    メール送信要求管理テーブルの送信者メールアドレスカラムの名前を設定する。
    
    パラメータ:
    
    fromColumnName - メール送信要求管理テーブルの送信者メールアドレスカラムの名前
  - setReplyToColumnName
```
public void setReplyToColumnName(String replyColumnName)
```
    メール送信要求管理テーブルの返信先メールアドレスカラムの名前を設定する。
    
    パラメータ:
    
    replyColumnName - メール送信要求管理テーブルの返信先メールアドレスカラムの名前
  - setReturnPathColumnName
```
public void setReturnPathColumnName(String returnPathColumnName)
```
    メール送信要求管理テーブルの差し戻し先メールアドレスカラムの名前を設定する。
    
    パラメータ:
    
    returnPathColumnName - メール送信要求管理テーブルの差し戻し先メールアドレスカラムの名前
  - setMailBodyColumnName
```
public void setMailBodyColumnName(String mailBodyColumnName)
```
    メール送信要求管理テーブルの本文カラムの名前を設定する。
    
    パラメータ:
    
    mailBodyColumnName - メール送信要求管理テーブルの本文カラムの名前
  - setCharsetColumnName
```
public void setCharsetColumnName(String charsetColumnName)
```
    メール送信要求管理テーブルの文字セットカラムの名前を設定する。
    
    パラメータ:
    
    charsetColumnName - メール送信要求管理テーブルの文字セットカラムの名前
  - setStatusColumnName
```
public void setStatusColumnName(String statusColumnName)
```
    メール送信要求管理テーブルのステータスカラムの名前を設定する。
    
    パラメータ:
    
    statusColumnName - メール送信要求管理テーブルのステータスカラムの名前
  - setRequestDateTimeColumnName
```
public void setRequestDateTimeColumnName(String requestDateTimeColumnName)
```
    メール送信要求管理テーブルの要求日時カラムの名前を設定する。
    
    パラメータ:
    
    requestDateTimeColumnName - メール送信要求管理テーブルの要求日時カラムの名前
  - setSendDateTimeColumnName
```
public void setSendDateTimeColumnName(String sendDateTimeColumnName)
```
    メール送信要求管理テーブルの送信日時カラムの名前を設定する。
    
    パラメータ:
    
    sendDateTimeColumnName - メール送信要求管理テーブルの送信日時カラムの名前
  - setMailSendPatternIdColumnName
```
public void setMailSendPatternIdColumnName(String mailSendPatternIdColumnName)
```
    メール送信要求管理テーブルのメール送信パターンIDをのカラム名を設定する。
    
    パラメータ:
    
    mailSendPatternIdColumnName - メール送信要求管理テーブルのメール送信パターンIDのカラム名
  - setSendProcessIdColumnName
```
public void setSendProcessIdColumnName(String sendProcessIdColumnName)
```
    送信するバッチのプロセスIDのカラム名を設定する。
    
    パラメータ:
    
    sendProcessIdColumnName - 送信するバッチのプロセスIDのカラム名
  - setMailConfig
```
public void setMailConfig(MailConfig mailConfig)
```
    メール関連のコード値を保持するデータオブジェクトを設定する。
    
    パラメータ:
    
    mailConfig - メール関連のコード値を保持するデータオブジェクト
  - insert
```
public void insert(String mailRequestId,
                   MailContext context)
```
    メール送信要求管理テーブルにレコードを登録する。
    
    パラメータ:
    
    mailRequestId - メールリクエストID
    
    context - メール送信要求情報
  - insert
```
public void insert(String mailRequestId,
                   MailContext context,
                   String transactionName)
```
    指定されたトランザクション名を用いてメール送信要求管理テーブルにレコードを登録する。
    
    パラメータ:
    
    mailRequestId - メールリクエストID
    
    context - メール送信要求情報
    
    transactionName - トランザクション名
  - getTargetCount
```
public int getTargetCount(String mailRequestPatternId)
```
    処理対象件数を取得する。
    本クラスのスキーマ設定にメール送信パターンIDを設定した場合には、処理対象のメール送信パターンIDの設定が必須となる。スキーマ定義にメール送信パターンIDが設定されているのに、処理対象のメール送信パターンIDが設定されていない場合にはSQL実行時エラーとなる。
    
    パラメータ:
    
    mailRequestPatternId - 処理対象のメール送信パターンID
    
    戻り値:
    
    処理対象件数
  - createReaderStatement
```
public SqlPStatement createReaderStatement(String mailSendPatternId)
```
    処理対象データを取得するSqlPStatementを生成する。
    
    パラメータ:
    
    mailSendPatternId - メール送信パターンID
    
    戻り値:
    
    処理対象データを取得するステートメント
  - createReaderStatement
```
public SqlPStatement createReaderStatement(String mailSendPatternId,
                                           String sendProcessId)
```
    処理対象データを取得するSqlPStatementを生成する。
    
    パラメータ:
    
    mailSendPatternId - メール送信パターンID
    
    sendProcessId - メール送信バッチのプロセスID
    
    戻り値:
    
    処理対象データを取得するステートメント
  - updateStatus
```
public void updateStatus(String mailRequestId,
                         String status)
```
    ステータスを更新する。
    指定されたメールリクエストIDに紐付くレコードのステータスを指定された値に更新する。
    
    パラメータ:
    
    mailRequestId - メールリクエストID
    
    status - ステータス
  - updateFailureStatus
```
public void updateFailureStatus(String mailRequestId,
                                String status)
```
    ステータスを更新する。
    指定されたメールリクエストIDに紐付くレコードのステータスを指定された値に更新する。
    
    パラメータ:
    
    mailRequestId - メールリクエストID
    
    status - ステータス
  - updateSendProcessId
```
public void updateSendProcessId(String sendProcessId)
```
    メール送信バッチのプロセスIDを更新する。
    マルチプロセス用の設定がされている場合のみ更新し、別トランザクションで実行する。
    
    パラメータ:
    
    sendProcessId - 更新するメール送信バッチのプロセスID
  - getMailRequest
```
public nablarch.common.mail.MailRequestTable.MailRequest getMailRequest(SqlRow data)
```
    SQLの取得結果の1レコードをMailRequestTable.MailRequestに変換する。
    
    パラメータ:
    
    data - メール送信要求1レコード
    
    戻り値:
    
    メール送信要求
  - initialize
```
public void initialize()
```
    SQLを初期化する。
    
    定義:
    
    initialize インタフェース内 Initializable

クラス MailRequestTable

メソッドのサマリー

メソッドの詳細

setTableName

setMailRequestIdColumnName

setSubjectColumnName

setFromColumnName

setReplyToColumnName

setReturnPathColumnName

setMailBodyColumnName

setCharsetColumnName

setStatusColumnName

setRequestDateTimeColumnName

setSendDateTimeColumnName

setMailSendPatternIdColumnName

setSendProcessIdColumnName

setMailConfig

insert

insert

getTargetCount

createReaderStatement

createReaderStatement

updateStatus

updateFailureStatus

updateSendProcessId

getMailRequest

initialize