ImBoxTemplateManagerオブジェクト
| コンポーネント情報 | |
|---|---|
| since | 8.0 |
IMBox定義情報を管理するマネージャです。
IMBox定義情報およびIMBoxテンプレートファイルの登録、更新、削除、取得を行います。
IMBox定義情報およびIMBoxテンプレートファイルの登録、更新、削除、取得を行います。
管理するIMBoxテンプレートファイルは以下の通りです。
[%PUBLIC_STORAGE_PATH%]
/im_workflow
/data
/[%テナントID%]
/[%テナント単位の設定値(master-file-dir)%]
/imbox
/テンプレートファイル名_[%ロケール%].xml
/template.xml
[%ロケール%]
日本語 : ja
英語 : en
中国語 : zh_CN
など
IMBoxテンプレートファイルを新規作成時、元となるテンプレートファイルが
見つからない場合は template.xml を使用します。
コンストラクタの概要
| ImBoxTemplateManager () コンストラクタ |
ImBoxTemplateManager (String loginGroupId) 非推奨コンストラクタ
ImBoxTemplateManager() を使用してください。
|
メソッドの概要
コンストラクタの詳細
| ImBoxTemplateManager ()
コンストラクタ
IMBox定義情報管理マネージャを新しく生成します。 |
ImBoxTemplateManager (String loginGroupId)
非推奨
ImBoxTemplateManager() を使用してください。
コンストラクタ
引数で指定したログイングループIDでIMBox定義情報管理マネージャを新しく生成します。
パラメータ
|
メソッドの詳細
WorkflowResultInfo createImBoxTemplateDataFamily (Array models)
IMBoxテンプレート情報と配下の情報を新規作成します。
models 内のIMBoxテンプレート情報、IMBoxテンプレート種別情報の指定に基づいて新規作成しますが、 データ矛盾のチェックを行いません。 models 内にIMBoxテンプレート種別情報を指定した場合は、IMBoxテンプレート種別情報を新規作成します。 IMBoxテンプレート情報にIMBoxテンプレートファイル情報を指定している場合は IMBox定義XMLファイルの新規作成を行います。 IMBox種別によって、元となるデフォルトのテンプレートファイルを読み取り、ファイルを作成します。
パラメータ
返却値
|
WorkflowResultInfo createImBoxTemplateData (Array models)
IMBoxテンプレート情報を新規作成します。
models 内にIMBoxテンプレート種別情報を指定した場合でも、IMBoxテンプレート種別情報は新規作成しません。 全ての情報を新規作成する場合は createImBoxTemplateDataFamily を使用してください。 ワークフロー上で使用可能にするためにはIMBoxテンプレート種別情報の作成が必要です。 IMBoxテンプレート情報にIMBoxテンプレートファイル情報を指定している場合は IMBox定義XMLファイルの新規作成を行います。
パラメータ
返却値
|
WorkflowResultInfo createImBoxTemplateTypeData (Array models)
IMBoxテンプレート種別情報を新規作成します。
パラメータ
返却値
|
WorkflowResultInfo deleteImBoxTemplateDataFamily (Array models)
IMBoxテンプレート情報と配下の情報を削除します。
models 内のIMBoxテンプレート情報、IMBoxテンプレート種別情報の指定に基づいて削除しますが、 データ矛盾のチェックを行いません。 models 内のIMBoxテンプレートIDは必須、IMBoxテンプレート種別情報は任意、それ以外の項目は無視します。 models 内にIMBoxテンプレート種別情報を指定した場合は、指定のIMBoxテンプレート種別情報を削除します。 models 内にIMBoxテンプレート種別情報を指定しない場合は、キー情報に一致するIMBoxテンプレート種別情報を削除します。 IMBoxテンプレート情報にIMBoxテンプレートパスを指定していない場合は自動的に取得して IMBox定義XMLファイルの削除を行います。
パラメータ
返却値
|
WorkflowResultInfo deleteImBoxTemplateData (Array models)
IMBoxテンプレート情報を削除します。
models 内にIMBoxテンプレート種別情報を指定した場合でも、IMBoxテンプレート種別情報は削除しません。 全ての情報を削除する場合は deleteImBoxTemplateDataFamily を使用してください。 IMBoxテンプレート情報にIMBoxテンプレートパスを指定していない場合は自動的に取得して IMBox定義XMLファイルの削除を行います。
パラメータ
返却値
|
WorkflowResultInfo deleteImBoxTemplateTypeData (Array models)
IMBoxテンプレート種別情報を削除します。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataCountWithLocale (String imBoxId, String localeId)
指定したロケールIDでIMBoxテンプレート情報の件数を取得します。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataCount (String imBoxId)
IMBoxテンプレート情報の件数を全ロケール分取得します。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataFamilyWithLocale (String imBoxId, String localeId)
指定したロケールIDでIMBoxテンプレート情報と配下の情報を１件取得します。
IMBoxテンプレート情報の他にIMBoxテンプレート種別情報、IMBoxテンプレートファイル情報の取得も行います。 国際化対応されている情報の場合は、指定したロケールIDのみを取得します。 該当するIMBoxテンプレート情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataFamily (String imBoxId)
IMBoxテンプレート情報と配下の情報を全ロケール分取得します。
IMBoxテンプレート情報の他にIMBoxテンプレート種別情報、IMBoxテンプレートファイル情報の取得も行います。 登録されている全ロケール分を取得します。 ロケールの指定を行う場合は getImBoxTemplateDataFamilyWithLocale を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataListCountWithAccessAuth (ImBoxTemplateSearchConditionInfo condition, Array models)
指定した検索条件と対象情報でIMBoxテンプレート情報の検索結果件数を取得します。
指定した対象情報に紐付き、参照権限があるIMBox定義情報を検索対象にします。 condition で指定したロケールIDを検索条件に使用します。 null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataListCount (ImBoxTemplateSearchConditionInfo condition)
指定した検索条件でIMBoxテンプレート情報の検索結果件数を取得します。
condition で指定したロケールIDを検索条件に使用します。 null を指定した場合は、登録されている全ロケール分を取得します。 アクセスロールの指定を行う場合は getImBoxTemplateDataListCountWithAccessAuth を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataListWithAccessAuth (ImBoxTemplateSearchConditionInfo condition, Array models)
指定した検索条件と対象情報でIMBoxテンプレート情報を検索します。
指定した対象情報に紐付き、参照権限があるIMBox定義情報を検索対象にします。 condition で指定したロケールIDを検索条件に使用します。 null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataList (ImBoxTemplateSearchConditionInfo condition)
指定した検索条件でIMBoxテンプレート情報を検索します。
condition で指定したロケールIDを検索条件に使用します。 null を指定した場合は、登録されている全ロケール分を取得します。 アクセスロールの指定を行う場合は getImBoxTemplateDataListWithAccessAuth を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateDataWithLocale (String imBoxId, String localeId)
指定したロケールIDでIMBoxテンプレート情報を１件取得します。
IMBoxテンプレート情報の他にIMBoxテンプレートファイル情報の取得も行いますが、 IMBoxテンプレート種別情報は取得しません。 全ての情報を取得する場合は getImBoxTemplateDataFamilyWithLocale を使用してください。 該当するIMBoxテンプレート情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateData (String imBoxId)
IMBoxテンプレート情報を全ロケール分取得します。
IMBoxテンプレート情報の他にIMBoxテンプレートファイル情報の取得も行います。 IMBoxテンプレート種別情報は取得しません。 全ての情報を取得する場合は getImBoxTemplateDataFamily を使用してください。 登録されている全ロケール分を取得します。 ロケールの指定を行う場合は getImBoxTemplateDataWithLocale を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateTypeData (String imBoxId)
IMBoxテンプレート種別情報を取得します。
パラメータ
返却値
|
WorkflowResultInfo getImBoxTemplateUseStatusListCount (ContentsVersionViewDataSearchConditionInfo condition)
指定した検索条件でIMBox定義利用状況情報の検索結果件数を取得します。
condition の id と、localeId は必ず設定してください。
返却値
|
WorkflowResultInfo getImBoxTemplateUseStatusList (ContentsVersionViewDataSearchConditionInfo condition)
指定した検索条件でIMBox定義利用状況情報を検索します。
condition の id と、localeId は必ず設定してください。
返却値
|
WorkflowResultInfo updateImBoxTemplateDataFamily (Array models)
IMBoxテンプレート情報と配下の情報を更新します。
models 内のIMBoxテンプレート情報、IMBoxテンプレート種別情報の指定に基づいて更新しますが、 データ矛盾のチェックを行いません。 models 内のIMBoxID、ロケールIDは必須で、それ以外の項目は任意です。 models 内にIMBoxテンプレート種別情報を指定した場合は、IMBoxテンプレート種別情報を更新を行います。 IMBoxテンプレート情報にIMBoxテンプレートパス、IMBoxテンプレートファイル情報を指定した場合は IMBox定義XMLファイルの更新を行います。
パラメータ
返却値
|
WorkflowResultInfo updateImBoxTemplateData (Array models)
IMBoxテンプレート情報を更新します。
models 内にIMBoxテンプレート種別情報を指定した場合でも、IMBoxテンプレート種別情報は更新しません。 全ての情報を更新する場合は updateImBoxTemplateDataFamily を使用してください。 IMBoxテンプレート情報にIMBoxテンプレートパス、IMBoxテンプレートファイル情報を指定している場合は IMBox定義XMLファイルの更新を行います。
パラメータ
返却値
|
WorkflowResultInfo updateImBoxTemplateTypeData (Array models)
IMBoxテンプレート種別情報を更新します。
パラメータ
返却値
|