pexa.share.calendar

インタフェース CommonCalendar

既知の実装クラスのリスト:

CommonCalendarFacadeAdaptor

public interface CommonCalendar

カレンダ機能の実体に対するラッパーを表すインタフェース。

バージョン:

$Revision: 9242 $ $Date:: 2019-03-05 13:40:34 #$

作成者:

morishita

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.util.Date	getAfterBusinessDay(Key calendarName, Session filterSession, java.util.Date base, int offset) 未来方向の営業日を取得する。
java.util.Date	getBeforeBusinessDay(Key calendarName, Session filterSession, java.util.Date base, int offset) 過去方向の営業日を取得する。
java.lang.Integer	getBusinessDayOfFromTo(Key calendarName, Session filterSession, java.util.Date from, java.util.Date to) 引数で指定されたfromの日付とtoの日付の間に営業日が何日間あるかをjava.lang.Integerで返す。
java.util.Collection	getHoliDayListOfFromTo(Key calendarName, Session filterSession, java.util.Date from, java.util.Date to) 引数で指定されたfromの日付とtoの日付の間に休日リストをjava.util.Collectionで返す。
boolean	isBusinessDay(Key calendarName, Session filterSession, java.util.Date date) 営業日であるかを判定する。

メソッドの詳細

getBeforeBusinessDay

java.util.Date getBeforeBusinessDay(Key calendarName,
                                    Session filterSession,
                                    java.util.Date base,
                                    int offset)
                             throws CalendarException

過去方向の営業日を取得する。 calendar引数で指定されたカレンダに対して、 filter検索条件で絞り込んだ上で、 base引数を基準日として、 offset引数営業日前の日付を返します。

パラメータ:

calendarName - 検索対象のカレンダマスタモデル名(Key)

filterSession - フィルタ用セッション

base - 営業日を取得するに当たっての基準日

offset - 基準日から何日前を取得したいのかの指定

戻り値:

カレンダマスタの内容に従って求められた営業日

例外:

CalendarException - 営業日の取得に失敗

getAfterBusinessDay

java.util.Date getAfterBusinessDay(Key calendarName,
                                   Session filterSession,
                                   java.util.Date base,
                                   int offset)
                            throws CalendarException

未来方向の営業日を取得する。 calendar引数で指定されたカレンダに対して、 filter検索条件で絞り込んだ上で、 base引数を基準日として、 offset引数営業日後の日付を返します。

パラメータ:

calendarName - 検索対象のカレンダマスタモデル名(Key)

filterSession - フィルタ用セッション

base - 営業日を取得するに当たっての基準日

offset - 基準日から何日後を取得したいのかの指定

戻り値:

カレンダマスタの内容に従って求められた営業日

例外:

CalendarException - 営業日の取得に失敗

getBusinessDayOfFromTo

java.lang.Integer getBusinessDayOfFromTo(Key calendarName,
                                         Session filterSession,
                                         java.util.Date from,
                                         java.util.Date to)
                                  throws CalendarException

引数で指定されたfromの日付とtoの日付の間に営業日が何日間あるかをjava.lang.Integerで返す。 filter検索条件で絞り込んだ上で、 from引数とto引数の間に、 営業日が何日間あるかを返す。

パラメータ:

calendarName - 検索対象のカレンダマスタモデル名(Key)

filterSession - フィルタ用セッション

from - 営業日の日数を知りたい未来日側の日付。

base - 営業日の日数を知りたい過去日側の日付。

戻り値:

カレンダマスタの内容に従って求められた営業日日数

例外:

CalendarException - 営業日日数の取得に失敗

getHoliDayListOfFromTo

java.util.Collection getHoliDayListOfFromTo(Key calendarName,
                                            Session filterSession,
                                            java.util.Date from,
                                            java.util.Date to)
                                     throws CalendarException

引数で指定されたfromの日付とtoの日付の間に休日リストをjava.util.Collectionで返す。 filter検索条件で絞り込んだ上で、 from引数とto引数の間に、 営業日が何日間あるかを返す。

パラメータ:

filterSession - フィルタ用セッション

from - 休日を知りたい未来日側の日付。

to - 休日を知りたい過去日側の日付。

戻り値:

休日リスト

例外:

CalendarException - 休日リスト取得に失敗

isBusinessDay

boolean isBusinessDay(Key calendarName,
                      Session filterSession,
                      java.util.Date date)
               throws CalendarException

営業日であるかを判定する。

パラメータ:

calendarName - 検索対象のカレンダマスタモデル名(Key)

filterSession - フィルタ用セッション

date - 営業日かを判定したい日付

戻り値:

指定日が営業日ならtrue

例外:

CalendarException - 営業日の取得に失敗