jp.co.intra_mart.foundation.calendar.model

インタフェース DayInfoSummary

すべてのスーパーインタフェース:

Serializable

public interface DayInfoSummary
extends Serializable

日付情報サマリーのモデルクラスです。

マージされた日付情報からある特定の日に該当するものを抽出したものを「日付情報サマリー」と呼びます。
マージされて作成されたカレンダー情報は、まだ登録されているレコードのリストにすぎません。 実際に目にするカレンダーのように1日ごとに整理された情報がサマリーです。サマリーにまとめられた日付情報には、すべて優先順位が割り当てられます。 割り当てられた優先順位にしたがって、その日が休日かどうか、画面に表示するときの色が決定します。 また、この優先順位がその日に表示される名称の表示順になります。

日付情報の優先順位について

日付情報の優先順位はいくつかの段階があり、次の順番で解決されます。

1. マージ時の優先順位
2. 日付情報データタイプの優先順位
3. 日付情報同士の優先順位

マージ時の優先順位

• カレンダーに日付情報セットをマージするときに優先順位を一意に決定します。
• カレンダーと日付情報セットのリレーションに対してソートキーが割り振られます。
  （日付情報セット本体のソートキーではありません）

日付情報データタイプの優先順位

• 平日が最優先されます。
  平日は、2つ以上の日付情報が同じ日に割り当てられたとき、休日が含まれていても休日として扱わない場合に使用します。
• 休日が2番目に優先されます。
  その日が休日である場合に設定します。
• 名称が3番目に優先されます。
  名称は、平日/休日の判定に関与しないデータタイプです。

日付情報同士の優先順位

• ソートキーが優先順位になります。
• ソートキーも同じ場合は、日付情報セットIDを判定に使用します。
• 日付情報セットIDも同じ場合は、日付情報IDを判定に使用します。

バージョン:

8.0.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getColor() この日の表示色を取得します。
Calendar	getCurrentDate() このモデルが有効な日付です。
List<String>	getDayInfoNames(Locale locale) この日に登録されている日付情報の名前をすべて取得します。
List<DayInfo>	getDayInfos() この日に登録されているすべての日付情報を取得します。
List<Locale>	getLocales() この日付情報サマリークラスが持つロケールをすべて取得します。
boolean	isHoliday() この日が休日かどうかを取得します。

メソッドの詳細

getColor

String getColor()

この日の表示色を取得します。
日付情報の優先順位で、最優先と決定された日付情報の表示色です。
表示色は、#から始まる6桁のRGB形式16進数色コードです。（例 : #FF8822）

戻り値:

表示色

getCurrentDate

Calendar getCurrentDate()

このモデルが有効な日付です。

戻り値:

日付

getDayInfoNames

List<String> getDayInfoNames(Locale locale)

この日に登録されている日付情報の名前をすべて取得します。
並び順は、日付情報の優先順位です。
このメソッドは表示用のショートカットメソッドです。
リンクに使用する場合など、日付情報のIDが必要な場合は getDayInfos() を使用します。

パラメータ:

locale - ロケール

戻り値:

日付情報名

getDayInfos

List<DayInfo> getDayInfos()

この日に登録されているすべての日付情報を取得します。
並び順は、日付情報の優先順位です。

戻り値:

日付情報リスト

getLocales

List<Locale> getLocales()

この日付情報サマリークラスが持つロケールをすべて取得します。
保持している日付情報の中には、このロケールの国際化情報をすべて持っているとは限りません。

戻り値:

ロケールリスト

isHoliday

boolean isHoliday()

この日が休日かどうかを取得します。

戻り値:

true:休日 false:平日