IM-Workflow

jp.co.intra_mart.foundation.workflow.administrator
クラス MailTemplateManager

java.lang.Object
  上位を拡張 jp.co.intra_mart.foundation.workflow.administrator.MailTemplateManager

public class MailTemplateManager
extends Object

メール定義情報を管理するマネージャです。

メール定義情報およびメールテンプレートファイルの登録、更新、削除、取得を行います。

 管理するメールテンプレートファイルは以下の通りです。
   [%Storage Service%]
      /workflow
          /data
              /[%ログイングループID%]
                  /[%ログイングループ単位の設定値(master-file-dir)%]
                      /mail
                          /テンプレートファイル名_[%ロケール%].xml
                          /template.xml
                          
                          [%ロケール%]
                              日本語 : ja
                              英語   : en
                              中国語 : zh
                              など
 
 メールテンプレートファイルを新規作成時、元となるテンプレートファイルが
 見つからない場合は template.xml を使用します。
 

導入されたバージョン:
7.2

コンストラクタの概要
MailTemplateManager(String loginGroupId)
          コンストラクタ
引数で指定したログイングループIDでメール定義情報管理マネージャを新しく生成します。
 
メソッドの概要
 void abortFileControl()
          メール定義のXMLファイルの操作を取消します。
 void beginFileControl()
          メール定義のXMLファイルを操作する準備を行います。
 void createMailTemplateData(MailTemplateDataModel... models)
          メールテンプレート情報を新規作成します。
 void createMailTemplateDataFamily(MailTemplateDataModel... models)
          メールテンプレート情報と配下の情報を新規作成します。
 void createMailTemplateTypeData(MailTemplateTypeModel... models)
          メールテンプレート種別情報を新規作成します。
 void deleteMailTemplateData(MailTemplateDataModel... models)
          メールテンプレート情報を削除します。
 void deleteMailTemplateDataFamily(MailTemplateDataModel... models)
          メールテンプレート情報と配下の情報を削除します。
 void deleteMailTemplateTypeData(MailTemplateTypeModel... models)
          メールテンプレート種別情報を削除します。
 void flushFileControl()
          メール定義のXMLファイルの変更を確定します。
 MailTemplateDataModel[] getMailTemplateData(String mailId)
          メールテンプレート情報を全ロケール分取得します。
 int getMailTemplateDataCount(String mailId)
          メールテンプレート情報の件数を全ロケール分取得します。
 int getMailTemplateDataCountWithLocale(String mailId, String localeId)
          指定したロケールIDでメールテンプレート情報の件数を取得します。
 MailTemplateDataModel[] getMailTemplateDataFamily(String mailId)
          メールテンプレート情報と配下の情報を全ロケール分取得します。
 MailTemplateDataModel getMailTemplateDataFamilyWithLocale(String mailId, String localeId)
          指定したロケールIDでメールテンプレート情報と配下の情報を1件取得します。
 MailTemplateDataListModel[] getMailTemplateDataList(MailTemplateSearchConditionInfo condition)
          指定した検索条件でメールテンプレート情報を検索します。
 int getMailTemplateDataListCount(MailTemplateSearchConditionInfo condition)
          指定した検索条件でメールテンプレート情報の検索結果件数を取得します。
 int getMailTemplateDataListCountWithAccessRole(MailTemplateSearchConditionInfo condition, String[] accessRole)
          指定した検索条件とアクセスロールでメールテンプレート情報の検索結果件数を取得します。
 MailTemplateDataListModel[] getMailTemplateDataListWithAccessRole(MailTemplateSearchConditionInfo condition, String[] accessRole)
          指定した検索条件とアクセスロールでメールテンプレート情報を検索します。
 MailTemplateDataModel getMailTemplateDataWithLocale(String mailId, String localeId)
          指定したロケールIDでメールテンプレート情報を1件取得します。
 MailTemplateTypeModel[] getMailTemplateTypeData(String mailId)
          メールテンプレート種別情報を取得します。
 ContentsVersionViewDataModel[] getMailTemplateUseStatusList(ContentsVersionViewDataSearchConditionInfo condition)
          指定した検索条件でメール定義利用状況情報を検索します。
 int getMailTemplateUseStatusListCount(ContentsVersionViewDataSearchConditionInfo condition)
          指定した検索条件でメール定義利用状況情報の検索結果件数を取得します。
 ReplaceStringDataModel[] getReplaceStringData()
          置換文字列情報を取得します。
 void updateMailTemplateData(MailTemplateDataModel... models)
          メールテンプレート情報を更新します。
 void updateMailTemplateDataFamily(MailTemplateDataModel... models)
          メールテンプレート情報と配下の情報を更新します。
 void updateMailTemplateTypeData(MailTemplateTypeModel... models)
          メールテンプレート種別情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MailTemplateManager

public MailTemplateManager(String loginGroupId)
コンストラクタ
引数で指定したログイングループIDでメール定義情報管理マネージャを新しく生成します。

パラメータ:
loginGroupId - ログイングループID
メソッドの詳細

createMailTemplateDataFamily

public void createMailTemplateDataFamily(MailTemplateDataModel... models)
                                  throws WorkflowException
メールテンプレート情報と配下の情報を新規作成します。

models 内のメールテンプレート情報、メールテンプレート種別情報の指定に基づいて新規作成しますが、
データ矛盾のチェックを行いません。

models 内にメールテンプレート種別情報を指定した場合は、メールテンプレート種別情報を新規作成します。

メールテンプレート情報にメールテンプレートファイル情報を指定している場合は
メール定義XMLファイルの新規作成を行います。

メール種別によって、元となるデフォルトのテンプレートファイルを読み取り、ファイルを作成します。

パラメータ:
models - メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

createMailTemplateData

public void createMailTemplateData(MailTemplateDataModel... models)
                            throws WorkflowException
メールテンプレート情報を新規作成します。

models 内にメールテンプレート種別情報を指定した場合でも、メールテンプレート種別情報は新規作成しません。
全ての情報を新規作成する場合は createMailTemplateDataFamily を使用してください。

ワークフロー上で使用可能にするためにはメールテンプレート種別情報の作成が必要です。

メールテンプレート情報にメールテンプレートファイル情報を指定している場合は
メール定義XMLファイルの新規作成を行います。

パラメータ:
models - メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

createMailTemplateTypeData

public void createMailTemplateTypeData(MailTemplateTypeModel... models)
                                throws WorkflowException
メールテンプレート種別情報を新規作成します。

パラメータ:
models - メールテンプレート種別情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateMailTemplateDataFamily

public void updateMailTemplateDataFamily(MailTemplateDataModel... models)
                                  throws WorkflowException
メールテンプレート情報と配下の情報を更新します。

models 内のメールテンプレート情報、メールテンプレート種別情報の指定に基づいて更新しますが、
データ矛盾のチェックを行いません。

models 内のメールID、ロケールIDは必須で、それ以外の項目は任意です。
models 内にメールテンプレート種別情報を指定した場合は、メールテンプレート種別情報を更新を行います。
メールテンプレート情報にメールテンプレートパス、メールテンプレートファイル情報を指定した場合は
メール定義XMLファイルの更新を行います。

パラメータ:
models - メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateMailTemplateData

public void updateMailTemplateData(MailTemplateDataModel... models)
                            throws WorkflowException
メールテンプレート情報を更新します。

models 内にメールテンプレート種別情報を指定した場合でも、メールテンプレート種別情報は更新しません。
全ての情報を更新する場合は updateMailTemplateDataFamily を使用してください。

メールテンプレート情報にメールテンプレートパス、メールテンプレートファイル情報を指定している場合は
メール定義XMLファイルの更新を行います。

パラメータ:
models - メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateMailTemplateTypeData

public void updateMailTemplateTypeData(MailTemplateTypeModel... models)
                                throws WorkflowException
メールテンプレート種別情報を更新します。

パラメータ:
models - メールテンプレート種別情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteMailTemplateDataFamily

public void deleteMailTemplateDataFamily(MailTemplateDataModel... models)
                                  throws WorkflowException
メールテンプレート情報と配下の情報を削除します。

models 内のメールテンプレート情報、メールテンプレート種別情報の指定に基づいて削除しますが、
データ矛盾のチェックを行いません。

models 内のメールテンプレートIDは必須、メールテンプレート種別情報は任意、それ以外の項目は無視します。
models 内にメールテンプレート種別情報を指定した場合は、指定のメールテンプレート種別情報を削除します。
models 内にメールテンプレート種別情報を指定しない場合は、キー情報に一致するメールテンプレート種別情報を削除します。

メールテンプレート情報にメールテンプレートパスを指定していない場合は自動的に取得して
メール定義XMLファイルの削除を行います。

パラメータ:
models - メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteMailTemplateData

public void deleteMailTemplateData(MailTemplateDataModel... models)
                            throws WorkflowException
メールテンプレート情報を削除します。

models 内にメールテンプレート種別情報を指定した場合でも、メールテンプレート種別情報は削除しません。
全ての情報を削除する場合は deleteMailTemplateDataFamily を使用してください。

メールテンプレート情報にメールテンプレートパスを指定していない場合は自動的に取得して
メール定義XMLファイルの削除を行います。

パラメータ:
models - メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteMailTemplateTypeData

public void deleteMailTemplateTypeData(MailTemplateTypeModel... models)
                                throws WorkflowException
メールテンプレート種別情報を削除します。

パラメータ:
models - メールテンプレート種別情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataList

public MailTemplateDataListModel[] getMailTemplateDataList(MailTemplateSearchConditionInfo condition)
                                                    throws WorkflowException
指定した検索条件でメールテンプレート情報を検索します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

アクセスロールの指定を行う場合は getMailTemplateDataListWithAccessRole を使用してください。

パラメータ:
condition - メールテンプレート一覧情報検索条件
戻り値:
MailTemplateDataListModel[] メールテンプレート一覧情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataListCount

public int getMailTemplateDataListCount(MailTemplateSearchConditionInfo condition)
                                 throws WorkflowException
指定した検索条件でメールテンプレート情報の検索結果件数を取得します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

アクセスロールの指定を行う場合は getMailTemplateDataListCountWithAccessRole を使用してください。

パラメータ:
condition - メールテンプレート一覧情報検索条件
戻り値:
int メール定義情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataListWithAccessRole

public MailTemplateDataListModel[] getMailTemplateDataListWithAccessRole(MailTemplateSearchConditionInfo condition,
                                                                         String[] accessRole)
                                                                  throws WorkflowException
指定した検索条件とアクセスロールでメールテンプレート情報を検索します。

指定したアクセスロールに紐付き、参照権限があるメール定義情報を検索対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

パラメータ:
condition - メールテンプレート一覧情報検索条件
accessRole - アクセスロールの配列
戻り値:
MailTemplateDataListModel[] メールテンプレート一覧情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataListCountWithAccessRole

public int getMailTemplateDataListCountWithAccessRole(MailTemplateSearchConditionInfo condition,
                                                      String[] accessRole)
                                               throws WorkflowException
指定した検索条件とアクセスロールでメールテンプレート情報の検索結果件数を取得します。

指定したアクセスロールに紐付き、参照権限があるメール定義情報を検索対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

パラメータ:
condition - メールテンプレート一覧情報検索条件
accessRole - アクセスロールの配列
戻り値:
int メール定義情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataFamily

public MailTemplateDataModel[] getMailTemplateDataFamily(String mailId)
                                                  throws WorkflowException
メールテンプレート情報と配下の情報を全ロケール分取得します。

メールテンプレート情報の他にメールテンプレート種別情報、メールテンプレートファイル情報の取得も行います。

登録されている全ロケール分を取得します。
ロケールの指定を行う場合は getMailTemplateDataFamilyWithLocale を使用してください。

パラメータ:
mailId - メールID
戻り値:
MailTemplateDataModel[] メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateData

public MailTemplateDataModel[] getMailTemplateData(String mailId)
                                            throws WorkflowException
メールテンプレート情報を全ロケール分取得します。

メールテンプレート情報の他にメールテンプレートファイル情報の取得も行います。

メールテンプレート種別情報は取得しません。
全ての情報を取得する場合は getMailTemplateDataFamily を使用してください。

登録されている全ロケール分を取得します。
ロケールの指定を行う場合は getMailTemplateDataWithLocale を使用してください。

パラメータ:
mailId - メールID
戻り値:
MailTemplateDataModel[] メールテンプレート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataCount

public int getMailTemplateDataCount(String mailId)
                             throws WorkflowException
メールテンプレート情報の件数を全ロケール分取得します。

パラメータ:
mailId - メールID
戻り値:
int メールテンプレート情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataCountWithLocale

public int getMailTemplateDataCountWithLocale(String mailId,
                                              String localeId)
                                       throws WorkflowException
指定したロケールIDでメールテンプレート情報の件数を取得します。

パラメータ:
mailId - メールID
localeId - ロケールID
戻り値:
int メールテンプレート情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataFamilyWithLocale

public MailTemplateDataModel getMailTemplateDataFamilyWithLocale(String mailId,
                                                                 String localeId)
                                                          throws WorkflowException
指定したロケールIDでメールテンプレート情報と配下の情報を1件取得します。

メールテンプレート情報の他にメールテンプレート種別情報、メールテンプレートファイル情報の取得も行います。
国際化対応されている情報の場合は、指定したロケールIDのみを取得します。

該当するメールテンプレート情報が見つからなかった場合は、null を返却します。

パラメータ:
mailId - メールID
localeId - ロケールID
戻り値:
MailTemplateDataModel メールテンプレート情報
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateDataWithLocale

public MailTemplateDataModel getMailTemplateDataWithLocale(String mailId,
                                                           String localeId)
                                                    throws WorkflowException
指定したロケールIDでメールテンプレート情報を1件取得します。

メールテンプレート情報の他にメールテンプレートファイル情報の取得も行いますが、
メールテンプレート種別情報は取得しません。
全ての情報を取得する場合は getMailTemplateDataFamilyWithLocale を使用してください。

該当するメールテンプレート情報が見つからなかった場合は、null を返却します。

パラメータ:
mailId - メールID
localeId - ロケールID
戻り値:
MailTemplateDataModel メールテンプレート情報
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateTypeData

public MailTemplateTypeModel[] getMailTemplateTypeData(String mailId)
                                                throws WorkflowException
メールテンプレート種別情報を取得します。

パラメータ:
mailId - メールID
戻り値:
MailTemplateTypeModel[] メールテンプレート種別情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateUseStatusList

public ContentsVersionViewDataModel[] getMailTemplateUseStatusList(ContentsVersionViewDataSearchConditionInfo condition)
                                                            throws WorkflowException
指定した検索条件でメール定義利用状況情報を検索します。

condition の id と、localeId は必ず設定してください。

パラメータ:
condition - コンテンツ・バージョンの一覧表示情報(利用状況一覧)検索条件
戻り値:
ContentsVersionViewDataModel[] コンテンツ・バージョンの一覧表示情報(利用状況一覧)の配列
例外:
WorkflowException - ワークフロー例外クラス

getMailTemplateUseStatusListCount

public int getMailTemplateUseStatusListCount(ContentsVersionViewDataSearchConditionInfo condition)
                                      throws WorkflowException
指定した検索条件でメール定義利用状況情報の検索結果件数を取得します。

condition の id と、localeId は必ず設定してください。

パラメータ:
condition - コンテンツ・バージョンの一覧表示情報(利用状況一覧)検索条件
戻り値:
int メール定義利用状況情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getReplaceStringData

public ReplaceStringDataModel[] getReplaceStringData()
                                              throws WorkflowException
置換文字列情報を取得します。

戻り値:
ReplaceStringDataModel[] 置換文字列情報の配列
例外:
WorkflowException - ワークフロー例外クラス

beginFileControl

public void beginFileControl()
メール定義のXMLファイルを操作する準備を行います。

メール定義のXMLファイルを操作する前に本メソッドを呼び出すことで、createMailTemplateData、updateMailTemplateData、および、deleteMailTemplateData などで行われたXMLファイルの操作を元の状態に復元できるようになります。

本メソッドを呼び出さない場合でもXMLファイルの操作は行えますが、処理の途中でシステムに問題が発生した場合、ファイルの安全性は保証できません。


flushFileControl

public void flushFileControl()
                      throws WorkflowException
メール定義のXMLファイルの変更を確定します。

beginFileControl を呼び出した後から本メソッドを呼び出した時点までのXMLファイルの変更を確定します。

本メソッドを呼び出す前に beginFileControl を呼び出してファイル操作の準備を行う必要があります。
beginFileControl を呼び出さずに本メソッドを呼び出した場合は例外が発生します。

本メソッドはXMLファイルの変更を確定しますが、データベースへの変更は確定しません。
データベースのトランザクションも同時に行っている場合、本メソッドを呼び出した後は速やかにデータベースへのコミットも行ってください。

例外:
WorkflowException - ワークフロー例外クラス

abortFileControl

public void abortFileControl()
                      throws WorkflowException
メール定義のXMLファイルの操作を取消します。

beginFileControl を呼び出した後から本メソッドを呼び出した時点までのXMLファイルの変更を取消します。

本メソッドを呼び出す前に beginFileControl を呼び出してファイル操作の準備を行う必要があります。
beginFileControl を呼び出さずに本メソッドを呼び出した場合は例外が発生します。

本メソッドはXMLファイルの変更を取消しますが、データベースへの変更は取消しません。

例外:
WorkflowException - ワークフロー例外クラス

IM-Workflow

Copyright © 2000-2015 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.