TenantInfoManagerオブジェクト
| コンポーネント情報 | |
|---|---|
| version | 8.0.15 |
| since | 8.0.0 |
テナント情報マネージャAPIです。
テナント情報の操作を行います。
テナント情報の操作を行います。
定数
| 型 | 定数名 | 定数値 |
|---|---|---|
| Stringstatic | ATTR_DECIMAL_FORMAT テナント属性として格納される数値形式の属性名です。 この定数は バージョン 8.0.15 より利用可能です。 |
"im_i18n_decimal_format_id" |
コンストラクタの概要
| TenantInfoManager () コンストラクタ。 |
メソッドの概要
| 返却値の型 | メソッド名 |
|---|---|
| ResultObject | deleteTenantInfo (String tenantId) テナント情報を削除します。 |
| ResultObject | exists (String tenantId) テナントの存在チェックを行います。 |
| ResultObject | getDefaultTenantId () デフォルトテナントのテナントIDを取得します。 |
| ResultObject | getTenantIds () テナントID一覧を取得します。 |
| ResultObject | getTenantInfo (Boolean isFill) デフォルトのテナント情報を取得します。 |
| ResultObject | getTenantInfo () テナント情報を取得します。 |
| ResultObject | getTenantInfo (String tenantId) 指定されたテナントIDのテナント情報を取得します。 |
| ResultObject | getTenantInfo (String tenantId, Boolean isFill) 指定されたテナントIDのテナント情報を取得します。 |
| ResultObject | insertTenantInfo (TenantInfo tenantInfo) テナント情報を登録します。 |
| ResultObject | updateTenantInfo (TenantInfo tenantInfo) テナント情報を更新します。 |
コンストラクタの詳細
| TenantInfoManager ()
コンストラクタ。
|
メソッドの詳細
ResultObject deleteTenantInfo (String tenantId)
テナント情報を削除します。
このメソッドは バージョン 8.0.7 より利用可能です。
パラメータ
返却値
|
ResultObject exists (String tenantId)
テナントの存在チェックを行います。
このメソッドは バージョン 8.0.7 より利用可能です。
パラメータ
返却値
|
|
ResultObject getDefaultTenantId ()
デフォルトテナントのテナントIDを取得します。
このメソッドは バージョン 8.0.7 より利用可能です。
返却値
|
|
ResultObject getTenantIds ()
テナントID一覧を取得します。
このメソッドは バージョン 8.0.7 より利用可能です。
返却値
|
ResultObject getTenantInfo (Boolean isFill)
デフォルトのテナント情報を取得します。
引数 isFill に false を指定した場合、引数なしの getTenantInfo
メソッドと同じ結果を返却します。引数 isFill に true を指定した場合、各設定値は、テナント設定情報、システムデフォルトのテナント設定情報の順序で参照します。そのため、テナント設定情報が未設定 ( null) の項目は、デフォルトの設定値を補完します。ただし、システムロケールが取得できなかった場合は、エンコーディングが null に設定される可能性があります。
パラメータ
返却値
|
|
ResultObject getTenantInfo ()
テナント情報を取得します。
各設定値は、テナント設定情報から参照します。 テナント設定情報が未設定 ( null) の項目は未設定 (null) のまま返却します。
返却値
|
ResultObject getTenantInfo (String tenantId)
指定されたテナントIDのテナント情報を取得します。
各設定値は、テナント設定情報から参照します。 テナント設定情報が未設定 ( null) の項目は未設定 (null) のまま返却します。このメソッドは バージョン 8.0.7 より利用可能です。
パラメータ
返却値
|
ResultObject getTenantInfo (String tenantId, Boolean isFill)
指定されたテナントIDのテナント情報を取得します。
引数 isFill に false を指定した場合、引数なしの getTenantInfo
メソッドと同じ結果を返却します。引数 isFill に true を指定した場合、各設定値は、テナント設定情報、システムデフォルトのテナント設定情報の順序で参照します。そのため、テナント設定情報が未設定 ( null) の項目は、デフォルトの設定値を補完します。ただし、システムロケールが取得できなかった場合は、エンコーディングが null に設定される可能性があります。このメソッドは バージョン 8.0.7 より利用可能です。
パラメータ
返却値
|
ResultObject insertTenantInfo (TenantInfo tenantInfo)
テナント情報を登録します。
このメソッドは バージョン 8.0.7 より利用可能です。
パラメータ
返却値
|
ResultObject updateTenantInfo (TenantInfo tenantInfo)
テナント情報を更新します。
パラメータ
返却値
|