System オブジェクト

システムマネージャオブジェクト。

システム設定情報を取得することができます。
通常 [install_directory]/conf/imart.xml が読み込まれた状態になっていますが、
任意の *.iniファイルを読み込んで値を定義する事も可能です。
複数の *.ini ファイルを読み込む場合、同じキーを定義しないように注意する必要があります。

システム管理者の参照、更新を行うことができます。
システム管理者の情報を操作する場合に用いるシステム管理者オブジェクトの構成は以下の通りです。
システム管理者オブジェクト
システム管理者
オブジェクト
(Object)
userId [必須] ユーザID (String)
password パスワード (String)
locale ロケール (String)
encoding エンコーディング (String)
mailAddress メールアドレス (String)
telNo 電話番号 (String)



システムで有効な、クライアントタイプ、ロケール、カラーパターンの情報を取得することができます。
上記の情報は、サーバマネージャの[install_directory]/conf/system.xmlで定義することが可能です。

システムマネージャで取得できるクライアントタイプオブジェクトの構成は以下の通りです。
クライアントタイプオブジェクト
クライアントタイプ
オブジェクト
(Object)
clientType [読み取り専用] クライアントタイプ (String)
displayName [読み取り専用] クライアントタイプ表示名 (String)

システムマネージャで取得できるロケールオブジェクトの構成は以下の通りです。
ロケールオブジェクト
ロケール
オブジェクト
(Object)
locale [読み取り専用] ロケール (String)
displayName [読み取り専用] ロケール表示名 (String)
encoding [読み取り専用] エンコーディング (String)
このロケールに対応したデフォルトのエンコーディングです。
encodings [読み取り専用] ロケール対応エンコーディングの配列 (StringのArray)
このロケールに対応したエンコーディングの一覧です。

システムマネージャで取得できるカラーパターンオブジェクトの構成は以下の通りです。
カラーパターンオブジェクト
カラーパターン
オブジェクト
(Object)
id [読み取り専用] カラーパターンID (String)
displayName [読み取り専用] カラーパターン表示名 (String)
このカラーパターンの表示名です。
code [読み取り専用] カラーコード (String)
このカラーパターンをイメージするカラーコードです。
cssFile [読み取り専用] CSSファイルのパス (String)
このカラーパターン用のCSSファイルが格納されているファイルのパスです。
設定中の先頭のCSSファイルのパスを返却します。
コンテキストパスからの相対パスです。
cssFiles [読み取り専用] CSSファイルのパスの一覧 (Array[String型])
このカラーパターン用のCSSファイルが格納されているファイルのパスの一覧です。
コンテキストパスからの相対パスです。
imageFolder [読み取り専用] イメージフォルダのパス (String)
このカラーパターン用のイメージファイルが格納されているフォルダのパスです。
コンテキストパスからの相対パスです。
property[キー名] [読み取り専用] プロパティ (String)
このカラーパターンのキーに対する属性情報です。


システムメニューオブジェクトの構成は以下の通りです。
システムメニューオブジェクト
メニュー・モデル
オブジェクト
(Object)
id メニューID (String)
url URL (String)
displayName[ロケール] メニュー名 (String)
ロケール別の表示名です。
imagePath メニューイメージパス (String)
メニューのアイコンイメージです。
contents コンテンツの種類 (String)


バージョン:1.0
導入されたバージョン:4.3

メソッドの概要
static Boolean addSuperUser(Object superUser)
システム管理者を作成します。
static void defineProperty(String key ,String value)
システム設定情報を設定します。
static Object getClientType(String locale ,String clientType)
システムで有効なクライアントタイプ情報を取得します。
static Array getClientTypes(String locale)
システムで有効なクライアントタイプ情報の一覧を取得します。
static Object getColorPattern(String reqLocale ,String colorId)
システムで有効なカラーパターン情報を取得します。
static Object getColorPatterns(String locale)
システムで有効なカラーパターン情報の一覧を取得する。
static String getDefaultClientType()
デフォルトクライアントタイプを取得します。
static String getDefaultColorPatternId()
デフォルトカラーパターンIDを取得します。
static String getDefaultLocale()
デフォルトロケールを取得します。
static Number getFloat(String key ,Number def)
システム設定情報を取得します。
static Number getInteger(String key ,Number def)
システム設定情報を取得します。
static Object getLocale(String regLocale ,String locale)
システムで有効なロケール情報を取得します。
static Object getLocales(String locale)
システムで有効なロケール情報の一覧を取得します。
static Object getSuperUser()
システム管理者を取得します。
Date getSystemMaxDate()
最大の未来日を取得します。
static Array getSystemMenu()
システムメニューを取得します。
Date getSystemMinDate()
最大の過去日を取得します。
static Object getValue(String key ,Object def)
システム設定情報を取得します。
static Boolean isFalse(String key)
システム設定情報を真偽値としてチェックします。
static Boolean isTrue(String key)
システム設定情報を真偽値としてチェックします。
static Boolean isValid(String key)
システム設定情報をチェックします。
static Boolean read(String file_name)
iniファイルを読込みます。
static Boolean updateSuperUser(Object superUser)
システム管理者を更新します。

メソッドの詳細
addSuperUser

static Boolean addSuperUser(Object superUser)

システム管理者を作成します。
パラメータ
superUser Object システム管理者オブジェクト
返却値
Boolean 成功/失敗(true/false)

defineProperty

static void defineProperty(String key ,String value)

システム設定情報を設定します。

このメソッドはスレッドセーフではありません。
パラメータ
key String キー
value String キーに対応する値
返却値
void

getClientType

static Object getClientType(String locale ,String clientType)

システムで有効なクライアントタイプ情報を取得します。
存在しない指定ロケールおよびクライアントタイプが指定された場合はデフォルトのクライアントタイプ情報を返却します。
パラメータ
locale String ロケール
clientType String クライアントタイプ
返却値
Object クライアントタイプオブジェクト

getClientTypes

static Array getClientTypes(String locale)

システムで有効なクライアントタイプ情報の一覧を取得します。
指定したロケールのクライアントタイプオブジェクトの一覧を取得します。
クライアントタイプが一件も存在しない場合は、空の配列を返却します。
パラメータ
locale String ロケール
返却値
Array クライアントタイプオブジェクト の配列

getColorPattern

static Object getColorPattern(String reqLocale ,String colorId)

システムで有効なカラーパターン情報を取得します。

存在しない指定ロケールおよびカラーパターンIDが指定された場合はデフォルトのカラーパターン情報を返却します。
パラメータ
reqLocale String 指定ロケール
colorId String カラーパターンID
返却値
Object カラーパターンオブジェクト

getColorPatterns

static Object getColorPatterns(String locale)

システムで有効なカラーパターン情報の一覧を取得する。

指定したロケールのカラーパターンオブジェクトの一覧を取得します。
カラーパターン情報が一件も存在しない場合は空の配列を返却します。
パラメータ
locale String 指定ロケール
返却値
Object カラーパターンオブジェクト の配列

getDefaultClientType

static String getDefaultClientType()

デフォルトクライアントタイプを取得します。

デフォルトクライアントタイプが存在しない場合はnullが返却されます。
返却値
String デフォルトクライアントタイプ

getDefaultColorPatternId

static String getDefaultColorPatternId()

デフォルトカラーパターンIDを取得します。

デフォルトカラーパターンIDが存在しない場合はnullが返却されます。
返却値
String デフォルトカラーパターンID

getDefaultLocale

static String getDefaultLocale()

デフォルトロケールを取得します。

デフォルトロケールが存在しない場合はnullが返却されます。
返却値
String デフォルトロケール

getFloat

static Number getFloat(String key ,Number def)

システム設定情報を取得します。

指定したキーに対応するシステム設定情報を数値型で取得します。 指定キーが未定義の場合は null を返却します。 引数にて未定義時デフォルト値を指定の場合は、指定データを返却します。
パラメータ
key String 取得キー
def Number 指定キーが未定義の場合の返却値(浮動小数点型)
返却値
Number 取得情報(浮動小数点型)

getInteger

static Number getInteger(String key ,Number def)

システム設定情報を取得します。

指定したキーに対応するシステム設定情報を数値型で取得します。 指定キーが未定義の場合は null を返却します。 引数にて未定義時デフォルト値を指定の場合は、指定データを返却します。
パラメータ
key String 取得キー
def Number 指定キーが未定義の場合の返却値(整数型)
返却値
Number 取得情報(整数型)

getLocale

static Object getLocale(String regLocale ,String locale)

システムで有効なロケール情報を取得します。

存在しない指定ロケールおよび取得ロケールが指定された場合はデフォルトのロケール情報を返却します。
パラメータ
regLocale String 指定ロケール
locale String ロケール
返却値
Object ロケールオブジェクト

getLocales

static Object getLocales(String locale)

システムで有効なロケール情報の一覧を取得します。

指定したロケールのロケールオブジェクトの一覧を取得します。
ロケール情報が一件も存在しない場合は空の配列を返却します。
パラメータ
locale String 要求元ロケール
返却値
Object ロケールオブジェクト の配列

getSuperUser

static Object getSuperUser()

システム管理者を取得します。
返却値
Object システム管理者オブジェクト

getSystemMaxDate

Date getSystemMaxDate()

最大の未来日を取得します。

システムで取り扱う最大未来日を返却します。
取得に失敗した場合は、nullを返却します。
返却値
Date システムで取り扱う最大未来日

getSystemMenu

static Array getSystemMenu()

システムメニューを取得します。
返却値
Array システムメニューオブジェクトの配列

getSystemMinDate

Date getSystemMinDate()

最大の過去日を取得します。

システムで取り扱う最大過去日を返却します。
取得に失敗した場合は、nullを返却します。
返却値
Date システムで取り扱う最大過去日

getValue

static Object getValue(String key ,Object def)

システム設定情報を取得します。

指定したキーに対応するシステム設定情報を取得します。 指定キーが未定義の場合は null を返却します。 引数にて未定義時デフォルト値を指定の場合は、指定データを返却します。
パラメータ
key String 取得キー
def Object 指定キーが未定義の場合の返却値(任意指定)
返却値
Object 取得情報

isFalse

static Boolean isFalse(String key)

システム設定情報を真偽値としてチェックします。

指定したキーに対応するシステム設定情報が OFF または FALSE かどうかチェックします。
OFF または FALSE は大文字小文字も厳密に区別します。
パラメータ
key String 取得キー
返却値
Boolean OFF または FALSE の場合は、true

isTrue

static Boolean isTrue(String key)

システム設定情報を真偽値としてチェックします。

指定したキーに対応するシステム設定情報が ON または TRUE かどうかチェックします。
ON または TRUE は大文字小文字も厳密に区別します。
パラメータ
key String 取得キー
返却値
Boolean ON または TRUE の場合は、true

isValid

static Boolean isValid(String key)

システム設定情報をチェックします。

指定したキーがシステム設定情報として存在するかどうかチェックします。
パラメータ
key String 取得キー
返却値
Boolean 存在する場合は、true

read

static Boolean read(String file_name)

iniファイルを読込みます。

iniファイルを読み込んでシステム設定情報に設定します。
ファイル名は拡張子なしのファイルラベル名のみ指定します。
(自動で .ini を付加してファイル検索します。)
パラメータ
file_name String ファイル名(拡張子省略形式)
返却値
Boolean true :ini ファイルの読込と設定が成功終了 false:ini ファイルの読込または設定に失敗

updateSuperUser

static Boolean updateSuperUser(Object superUser)

システム管理者を更新します。
パラメータ
superUser Object システム管理者オブジェクト
返却値
Boolean 成功/失敗(true/false)