pexa.share.calendar

インタフェース CommonCalendarFacade

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

Refreshable

既知のサブインタフェースのリスト:

CommonCalendarFacadeSession, CommonCalendarFacadeSessionLocal

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

CommonCalendarFacadeBase, CommonCalendarFacadeSessionBean

public interface CommonCalendarFacade
extends Refreshable

共通カレンダ機能を表すインタフェース。

共通カレンダ機能は、項目グループの"ITG_PEXA_000003 Calendar"で指定されている項目を持つカレンダマスタを参照し、 その内容及び呼出元から指定された引数から営業日に関する情報を取得する機能を提供します。

カレンダマスタは１データモデルにまとめることも出来ますし、複数データモデルに分けることも出来ます。 例えば、自社の営業日カレンダ、取引先の営業日カレンダ、銀行の営業日カレンダといった、複数種類の 営業日カレンダを一つのデータモデルに押し込めて検索条件で絞り込んでも良いですし、それぞれを別々の データモデルに分けて登録し、呼出元がそれらを選択して参照することも可能です。 引数で指定するcalendarNameは、カレンダマスタモデル名ではなく、calendar.entryファイルで指定された カレンダ論理名です。このカレンダ論理名はカレンダマスタ名及び検索条件フィルタがマッピングされるので、 呼出元は参照したいデータのモデル名や検索条件は気にせず最小限の指定で機能を呼び出せます。

calendar.entryファイルの記述例

 (calendar
     (自社カレンダ
         resource    "利用会社カレンダマスタ"
         [filter
             filter  "利用会社No = \@LoginUserInfo/利用会社No"
             ,
             filter  "RemovedFlag = NOT_REMOVED"
         ]
     )
     (得意先カレンダ
         resource     "法人顧客カレンダマスタ"
         [filter
             filter   "法人顧客No = \@法人顧客No"
             ,
             filter  "RemovedFlag = NOT_REMOVED"
         ]
     )
 )
 

バージョン:

$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) 営業日であるかを判定する。

インタフェースから継承されたメソッド pexa.share.util.res.Refreshable

refresh

メソッドの詳細

getBeforeBusinessDay

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

過去方向の営業日を取得する。 calendar引数で指定されたカレンダに対して、 base引数を基準日として、 offset引数営業日前の日付を返します。 カレンダに検索条件が指定されている場合はfilterSession引数を元に適用します。

パラメータ:

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

filterSession - カレンダマスタ検索条件に与えるセッション値

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

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

戻り値:

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

例外:

CalendarException - 営業日の取得に失敗

java.rmi.RemoteException - 原因不明エラー

getAfterBusinessDay

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

未来方向の営業日を取得する。 calendar引数で指定されたカレンダに対して、 base引数を基準日として、 offset引数営業日後の日付を返します。 カレンダに検索条件が指定されている場合はfilterSession引数を元に適用します。

パラメータ:

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

filterSession - カレンダマスタ検索条件に与えるセッション値

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

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

戻り値:

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

例外:

CalendarException - 営業日の取得に失敗

java.rmi.RemoteException - 原因不明エラー

getBusinessDayOfFromTo

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

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

パラメータ:

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

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

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

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

戻り値:

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

例外:

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

java.rmi.RemoteException

getHoliDayListOfFromTo

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

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

パラメータ:

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

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

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

戻り値:

休日リスト

例外:

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

java.rmi.RemoteException

isBusinessDay

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

営業日であるかを判定する。 カレンダに検索条件が指定されている場合はfilterSession引数を元に適用します。

パラメータ:

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

filterSession - カレンダマスタ検索条件に与えるセッション値

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

戻り値:

指定日が営業日ならtrue

例外:

CalendarException - 営業日の取得に失敗

java.rmi.RemoteException - 原因不明エラー