CalendarInfoManagerオブジェクト

コンポーネント情報
version	8.0

コンポーネント概要

カレンダー情報を管理するマネージャクラスです。
カレンダー情報、日付情報の管理と、特定日の日付情報を検索することができます。

特定の日の日付情報は、いくつかの日付情報を優先順位に従って解決されたその日の情報を取得することができます。

コンストラクタの概要

CalendarInfoManager () カレンダーマネージャーのコンストラクタです。

メソッドの概要

返却値の型	メソッド名
ResultObject	deleteCalendarInfo (CalendarInfo `info`) カレンダーを削除します。
ResultObject	deleteCalendarWeekDayInfo (CalendarWeekDayInfo `info`) 曜日の情報を削除します。
ResultObject	deleteDayInfoSet (DayInfoSet `info`) 日付情報セットを削除します。
ResultObject	deleteDayInfo (DayInfo `info`) 日付情報を削除します。
ResultObject	excludeDayInfoSet (String `calendarId`, Array `dayInfoSetIds`) カレンダーに追加されている日付情報セットを取り除きます。
ResultObject	getCalendarInfo (String `calendarId`) 指定したカレンダーを取得します。
ResultObject	getCalendarInfos () カレンダーをすべて取得します。
ResultObject	getCalendarWeekDayInfos (String `calendarId`) 曜日の情報を取得します。
ResultObject	getDayInfoSet (String `dayInfoSetId`) 指定した日付情報セットを取得します。
ResultObject	getDayInfoSetsByCalendarId (String `calendarId`) カレンダーに登録されている日付情報セットを取得します。
ResultObject	getDayInfoSets () 日付情報セットをすべて取得します。
ResultObject	getDayInfoSummariesOnMonth (String `calendarId`, Date `date`, Boolean `[fill]`) 1カ月分の日付情報を取得します。
ResultObject	getDayInfoSummariesOnTermByDayInfoSetIds (String `baseCalendarId`, Array `dayInfoSetIds`, Date `start`, Date `end`) 指定した期間の日付情報を取得します。
ResultObject	getDayInfoSummariesOnTerm (String `calendarId`, Date `start`, Date `end`) 指定した期間の日付情報を取得します。
ResultObject	getDayInfoSummariesOnWeek (String `calendarId`, Date `date`, Boolean `shiftFirstDayOfWeek`) 1週間分の日付情報を取得します。
ResultObject	getDayInfoSummary (String `calendarId`, Date `date`) 指定した日の日付情報を取得します。
ResultObject	getDayInfo (String `dayInfoSetId`, String `dayInfoId`) 日付情報セットID、日付情報IDを指定して日付情報を取得します。
ResultObject	getDayInfosByCalendarId (String `calendarId`) 指定したカレンダーのすべての日付情報を取得します。
ResultObject	getDayInfosByDayInfoSetId (String `dayInfoSetId`) 指定した日付情報セットのすべての日付情報を取得します。
ResultObject	getDayInfos () 非推奨すべての日付情報を取得します。テスト用のメソッドです。正確にソートされた日付情報が必要な場合は、すべてのカレンダー(または日付情報セット)を取得した上で、カレンダーごとの日付情報を取得してください。
ResultObject	hasCalendarInfo (String `calendarId`) カレンダーが存在するかどうか判定します。
ResultObject	hasDayInfoSet (String `dayInfoSetId`) 日付情報セットが存在するかどうか判定します。
ResultObject	hasDayInfo (String `calendarId`, Date `date`, DayInfo `dayInfo`) 指定した日が、指定した日付情報を持つかどうか判定します。
ResultObject	includeDayInfoSet (String `calendarId`, Array `dayInfoSetIds`) カレンダーに日付情報セットを追加します。
ResultObject	insertCalendarInfo (CalendarInfo `info`) カレンダーを作成します。
ResultObject	insertCalendarWeekDayInfo (CalendarWeekDayInfo `info`) 曜日の情報を作成します。
ResultObject	insertDayInfoSet (DayInfoSet `info`) 日付情報セットを作成します。
ResultObject	insertDayInfo (DayInfo `info`) 日付情報を作成します。
ResultObject	isHoliday (String `calendarId`, Date `date`) 指定した日が休日かどうか判定します。
Boolean	setFirstDayOfWeek (Number `firstDayOfWeek`) このマネージャーで使用する週の開始曜日を設定します。 SUNDAY=0～SATURDAY=6をセットできます。それ以外の値をセットした場合は、値を変えません。
ResultObject	updateCalendarInfo (CalendarInfo `info`) カレンダーを更新します。
ResultObject	updateCalendarWeekDayInfo (CalendarWeekInfo `info`) 曜日の情報を更新します。
ResultObject	updateDayInfoSetSortKeyOnCalendar (String `calendarId`, Array `dayInfoSetIds`) 指定したカレンダー内の日付情報セット優先順位を一括で変更します。
ResultObject	updateDayInfoSet (DayInfoSet `info`) 日付情報セットを更新します。
ResultObject	updateDayInfoSortKeyOnDayInfoSet (String `dayInfoSetId`, Array `dayInfoIds`) 指定した日付情報セット内の日付情報優先順位を一括で変更します。
ResultObject	updateDayInfo (DayInfo `info`) 日付情報を更新します。

コンストラクタの詳細

CalendarInfoManager ()

カレンダーマネージャーのコンストラクタです。

メソッドの詳細

ResultObject deleteCalendarInfo (CalendarInfo info)

カレンダーを削除します。
国際化項目もすべて削除されます。

パラメータ

info : CalendarInfo: カレンダー情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject deleteCalendarWeekDayInfo (CalendarWeekDayInfo info)

曜日の情報を削除します。

パラメータ

info : CalendarWeekDayInfo: 曜日の情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject deleteDayInfoSet (DayInfoSet info)

日付情報セットを削除します。
国際化項目もすべて削除されます。

パラメータ

info : DayInfoSet: 日付情報セット

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject deleteDayInfo (DayInfo info)

日付情報を削除します。
国際化項目もすべて削除されます。

パラメータ

info : DayInfo: 日付情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject excludeDayInfoSet (String calendarId, Array dayInfoSetIds)

カレンダーに追加されている日付情報セットを取り除きます。
追加されていない日付情報セットIDを指定した場合、何もしません。

パラメータ

calendarId : String: カレンダーID

dayInfoSetIds : Array: 日付情報セットのリスト

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject getCalendarInfo (String calendarId)

指定したカレンダーを取得します。

パラメータ

calendarId : String: カレンダーID

返却値

ResultObject: ResultObject dataにカレンダー情報を持つ結果オブジェクト

ResultObject getCalendarInfos ()

カレンダーをすべて取得します。

返却値

ResultObject: ResultObject dataにカレンダー情報の配列を持つ結果オブジェクト

ResultObject getCalendarWeekDayInfos (String calendarId)

曜日の情報を取得します。
返却値はObjectで、キーは曜日の番号(DateTime.SUNDAY ～ DateTime.SATURDAY)です。

パラメータ

calendarId : String: カレンダーID

返却値

ResultObject: ResultObject dataに週の情報の配列を持つ結果オブジェクト

ResultObject getDayInfoSet (String dayInfoSetId)

指定した日付情報セットを取得します。

パラメータ

dayInfoSetId : String: 日付情報セットID

返却値

ResultObject: ResultObject dataに日付情報セットを持つ結果オブジェクト

ResultObject getDayInfoSetsByCalendarId (String calendarId)

カレンダーに登録されている日付情報セットを取得します。

パラメータ

calendarId : String: カレンダーID

返却値

ResultObject: ResultObject dataに日付情報セットの配列を持つ結果オブジェクト

ResultObject getDayInfoSets ()

日付情報セットをすべて取得します。

返却値

ResultObject: ResultObject dataに日付情報セットの配列を持つ結果オブジェクト

ResultObject getDayInfoSummariesOnMonth (String calendarId, Date date, Boolean [fill])

1カ月分の日付情報を取得します。
fillフラグにtrueを指定すると、取得する最初の日が日曜日、最後の日が土曜日となるよう、前後の月の情報を足して返却します。

返却値は、７曜日×４～６週の要素数を持つリストとなります。

パラメータのdateのうち、year, monthのフィールドのみを使用します。

パラメータ

calendarId : String: 対象のカレンダーID

date : Date: 対象日付

[fill] : Boolean: カレンダーのマス目にすべての日付が入るよう、前後の月の情報も数日分表示します。

返却値

ResultObject: ResultObject dataに日付情報サマリーの配列を持つ結果オブジェクト

ResultObject getDayInfoSummariesOnTermByDayInfoSetIds (String baseCalendarId, Array dayInfoSetIds, Date start, Date end)

指定した期間の日付情報を取得します。
このメソッドはカレンダーIDではなく日付情報セットIDのリストを指定します。
baseCalendarIdの指定は、週の情報の取得のみに使用されます。

このメソッドは、日付情報セットの組み替え中にプレビュー表示するために作成されたメソッドです。
通常、アプリケーションがこのメソッドを使用することはありません。

パラメータのstart,endのうち、year, month, dayOfMonthのフィールドのみを使用します。

パラメータ

baseCalendarId : String: 元になるカレンダーのカレンダーID

dayInfoSetIds : Array: 対象の日付情報セットID

start : Date: 取得期間の最初の日

end : Date: 取得期間の終わりの日(指定した日を含む)

返却値

ResultObject: ResultObject dataに日付情報サマリーの配列を持つ結果オブジェクト

ResultObject getDayInfoSummariesOnTerm (String calendarId, Date start, Date end)

指定した期間の日付情報を取得します。

パラメータのstart,endのうち、year, month, dayOfMonthのフィールドのみを使用します。

パラメータ

calendarId : String: 対象のカレンダーID

start : Date: 取得期間の最初の日

end : Date: 取得期間の終わりの日(指定した日を含む)

返却値

ResultObject: ResultObject dataに日付情報サマリーの配列を持つ結果オブジェクト

ResultObject getDayInfoSummariesOnWeek (String calendarId, Date date, Boolean shiftFirstDayOfWeek)

1週間分の日付情報を取得します。

calendarで指定した日を含む、コンストラクタで指定した週の開始曜日から7日間の情報を取得します。

パラメータのdateのうち、year, month, day_of_weekのフィールドのみを使用します。

パラメータ

calendarId : String: 対象のカレンダーID

date : Date: 対象の年月日を含む日付

shiftFirstDayOfWeek : Boolean: 週の開始曜日を取得の最初の日にするかどうか？

返却値

ResultObject: ResultObject dataに日付情報サマリーの配列を持つ結果オブジェクト

ResultObject getDayInfoSummary (String calendarId, Date date)

指定した日の日付情報を取得します。

パラメータ

calendarId : String: 対象のカレンダーID

date : Date: 対象日付

返却値

ResultObject: ResultObject dataに日付情報サマリーの配列を持つ結果オブジェクト

ResultObject getDayInfo (String dayInfoSetId, String dayInfoId)

日付情報セットID、日付情報IDを指定して日付情報を取得します。

パラメータ

dayInfoSetId : String: 日付情報セットID

dayInfoId : String: 日付情報ID

返却値

ResultObject: ResultObject dataに日付情報を持つ結果オブジェクト

ResultObject getDayInfosByCalendarId (String calendarId)

指定したカレンダーのすべての日付情報を取得します。

パラメータ

calendarId : String: カレンダーID

返却値

ResultObject: ResultObject dataに日付情報の配列を持つ結果オブジェクト

ResultObject getDayInfosByDayInfoSetId (String dayInfoSetId)

指定した日付情報セットのすべての日付情報を取得します。

パラメータ

dayInfoSetId : String: 日付情報セットID

返却値

ResultObject: ResultObject dataに日付情報の配列を持つ結果オブジェクト

ResultObject getDayInfos () 非推奨

テスト用のメソッドです。正確にソートされた日付情報が必要な場合は、すべてのカレンダー(または日付情報セット)を取得した上で、カレンダーごとの日付情報を取得してください。

すべての日付情報を取得します。

返却値

ResultObject: ResultObject dataに日付情報の配列を持つ結果オブジェクト

ResultObject hasCalendarInfo (String calendarId)

カレンダーが存在するかどうか判定します。

パラメータ

calendarId : String: 対象のカレンダーID

返却値

ResultObject: ResultObject dataに存在するかどうかのフラグを持つ結果オブジェクト

ResultObject hasDayInfoSet (String dayInfoSetId)

日付情報セットが存在するかどうか判定します。

パラメータ

dayInfoSetId : String: 対象の日付情報セットID

返却値

ResultObject: ResultObject dataに存在するかどうかのフラグを持つ結果オブジェクト

ResultObject hasDayInfo (String calendarId, Date date, DayInfo dayInfo)

指定した日が、指定した日付情報を持つかどうか判定します。

パラメータ

calendarId : String: 対象のカレンダーID

date : Date: 対象日付

dayInfo : DayInfo: 日付情報

返却値

ResultObject: ResultObject dataに存在するかどうかのフラグを持つ結果オブジェクト

ResultObject includeDayInfoSet (String calendarId, Array dayInfoSetIds)

カレンダーに日付情報セットを追加します。
追加されたカレンダーは、優先度が一番低い状態で追加されます。
追加しようとしていた日付情報セットが、既に追加されていた場合は例外をスローします。

パラメータ

calendarId : String: カレンダーID

dayInfoSetIds : Array: 日付情報セットのリスト

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject insertCalendarInfo (CalendarInfo info)

カレンダーを作成します。
国際化項目に複数指定があれば、すべて登録します。

国際化項目のみ追加する場合は、updateCalendarInfoを使用します。

パラメータ

info : CalendarInfo: カレンダー情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject insertCalendarWeekDayInfo (CalendarWeekDayInfo info)

曜日の情報を作成します。

パラメータ

info : CalendarWeekDayInfo: 曜日の情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject insertDayInfoSet (DayInfoSet info)

日付情報セットを作成します。
国際化項目に複数指定があれば、すべて登録します。

国際化項目のみ追加する場合は、updateCalendarInfoを使用します。

パラメータ

info : DayInfoSet: 日付情報セット

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject insertDayInfo (DayInfo info)

日付情報を作成します。
国際化項目に複数指定があれば、すべて登録します。

国際化項目のみ追加する場合は、updateCalendarInfoを使用します。

パラメータ

info : DayInfo: 日付情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject isHoliday (String calendarId, Date date)

指定した日が休日かどうか判定します。

パラメータ

calendarId : String: 対象のカレンダーID

date : Date: 対象日付

返却値

ResultObject: ResultObject dataに休日フラグを持つ結果オブジェクト

Boolean setFirstDayOfWeek (Number firstDayOfWeek)

このマネージャーで使用する週の開始曜日を設定します。 SUNDAY=0～SATURDAY=6をセットできます。それ以外の値をセットした場合は、値を変えません。

パラメータ

firstDayOfWeek : Number: 開始曜日

返却値

Boolean: Boolean 値を変更した場合、返却値がtrueとなります。セットできない値の場合はfalseを返却します。

ResultObject updateCalendarInfo (CalendarInfo info)

カレンダーを更新します。
国際化項目に複数指定があれば、すべて更新します。
未登録のロケールがあれば、そのロケールで国際化項目が作成されます。

パラメータ

info : CalendarInfo: カレンダー情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject updateCalendarWeekDayInfo (CalendarWeekInfo info)

曜日の情報を更新します。

パラメータ

info : CalendarWeekInfo: 曜日の情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject updateDayInfoSetSortKeyOnCalendar (String calendarId, Array dayInfoSetIds)

指定したカレンダー内の日付情報セット優先順位を一括で変更します。
dayInfoSetIdsで指定した順番に優先されるように更新されます。

指定されなかったIDは最後尾に移動します。
また、内包していない情報セットの指定があった場合はその日付情報セットは無視します。

パラメータ

calendarId : String: カレンダーID

dayInfoSetIds : Array: 日付情報セットのリスト

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject updateDayInfoSet (DayInfoSet info)

日付情報セットを更新します。
国際化項目に複数指定があれば、すべて更新します。
未登録のロケールがあれば、そのロケールで国際化項目が作成されます。

パラメータ

info : DayInfoSet: 日付情報セット

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject updateDayInfoSortKeyOnDayInfoSet (String dayInfoSetId, Array dayInfoIds)

指定した日付情報セット内の日付情報優先順位を一括で変更します。
dayInfoSetIdsで指定した順番に優先されるように更新されます。

指定されなかったIDは最後尾に移動します。

パラメータ

dayInfoSetId : String: 日付情報セットID

dayInfoIds : Array: 日付情報IDのリスト

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト

ResultObject updateDayInfo (DayInfo info)

日付情報を更新します。
国際化項目に複数指定があれば、すべて更新します。
未登録のロケールがあれば、そのロケールで国際化項目が作成されます。

パラメータ

info : DayInfo: 日付情報

返却値

ResultObject: ResultObject dataがnullの結果オブジェクト