getGroup()
プロトタイプ
オブジェクト型クラスメソッド
(Object) getGroup(String id)
概要
指定カテゴリ内設定データ一覧の取得
入力値
String id : カテゴリID
返却値
設定データオブジェクト
詳細
このメソッドの返却オブジェクトを無闇に変更すると暦モジュールの
動作が不安定になる場合が有ります。
isWeekday()
プロトタイプ
真偽値型クラスメソッド
(boolean) isWeekday(Date target, String id)
概要
指定日付が非休日かをチェック
入力値
Date target: チェック対象日付データ
String id : カテゴリID
返却値
真値:指定日付が非休日設定
偽値:指定日付は休日設定
詳細
暦マスタの設定情報と照合して、指定の日付が非休日判定なら true を
返却して、休日判定なら false を返却します。
isHoliday()
プロトタイプ
真偽値型クラスメソッド
(boolean) isHoliday(Date target, String id)
概要
指定日付が休日かをチェック
入力値
Date target: チェック対象日付データ
String id : カテゴリID
返却値
真値:指定日付が休日設定
偽値:指定日付は非休日設定
詳細
暦マスタの設定情報と照合して、指定の日付が休日判定なら true を
返却して、非休日判定なら false を返却します。
definePlugin()
プロトタイプ
void 型クラスメソッド
(void) definePlugin(String key, String exp, Function plugin)
概要
休日・非休日判定用プラグイン関数の登録
入力値
String key : プラグイン設定キー
String name : マスタメンテ画面での表示名称
Function plugin: 実行関数
返却値
なし
詳細
休日・非休日判定用プラグイン関数の登録を行います。
getDate()
プロトタイプ
オブジェクト型クラスメソッド
(Object) getDate(Date target, String id)
概要
指定日付の暦情報の取得
入力値
Date target: チェック対象日付データ
String id : カテゴリID
返却値
該当日付の暦データオブジェクト
詳細
返却されるオブジェクトの構造は以下のようになっています。
return_object
├ date// 日付データ(DATE型)
├ data[]// 備考データ
│ ├ 0
│ │ ・
│ └ n
├ match// 休日または非休日設定で該当した設定項目数
├ color// 最高優先度項目の設定表示色
├ holiday// 休日フラグ(真偽値)
└ weekday// 平日フラグ(真偽値)
返却オブジェクトのプロパティ match は、休日判定の場合、該当した
休日設定項目の数が保存されます。
また、該当日付が非休日判定の場合には、該当した非休日設定項目の
数が保存されます。
getMonth()
プロトタイプ
配列型クラスメソッド
(Array) getMonth(number year, number month, String id)
概要
1ヶ月分の暦情報の取得
入力値
number year : 年
number month: 月
String id : カテゴリID
返却値
指定年月の暦情報を持つ配列
詳細
指定年月の1ヶ月分の休日・非休日の暦情報を作成して返却します。
返却する配列の要素番号は 1 から始まる連想配列になります。
各要素番号が指定年月の日に該当します。
例)要素番号 10 には、その月の 10 日の情報が格納されています。
返却する配列の各要素はオブジェクトになっていて、その構造は、
getDate() メソッドの返却値と同様になっています。