jp.co.intra_mart.product.collaboration.schedule.caldav.service

インタフェース CaldavService

public interface CaldavService

CalDAV 通信でスケージュール機能へアクセスするためのサービスです。

予定として取り扱うスケジュール情報は以下のとおりです。

• スケジュール
• イベント
• 定期スケジュール
• 定期イベント

取得処理について

取得対象期間となる開始日時および終了日時の指定方法は以下の通りです。

• 開始日時 : 取得対象となる先頭日の 0 時
• 終了日時 : 取得対象となる最終日の翌日の 0 時
• タイムゾーン : 取得対象となる日時を表すタイムゾーン

指定された日時について、システムデフォルトのタイムゾーンに変換して取得処理を行います。

e.g.
香港時間での 2014/10 の予定を取得する場合、下記のように指定します。

2014/10/01 00:00:00 - 2014/11/01 00:00:00 [ Asia/Hong_Kong (GMT +08:00) ]

システムデフォルトのタイムゾーンが日本標準時の場合は、取得時に下記のように変換されます。

2014/10/01 01:00:00 - 2014/11/01 01:00:00 [ Asia/Tokyo (GMT +09:00) ]

導入されたバージョン:

8.0.8

バージョン:

8.0.8

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	delete(String refCd) 予定を削除します。
VCalendarState	findState(String userCd, ReferenceCode refCd, jp.co.intra_mart.foundation.i18n.datetime.DateTime start, jp.co.intra_mart.foundation.i18n.datetime.DateTime end) 予定状態を取得します。
VCalendarState[]	findStates(String userCd, jp.co.intra_mart.foundation.i18n.datetime.DateTime start, jp.co.intra_mart.foundation.i18n.datetime.DateTime end) 予定状態を取得します。
VCalendarState[]	findStates(String userCd, ReferenceCodeContainer container, jp.co.intra_mart.foundation.i18n.datetime.DateTime start, jp.co.intra_mart.foundation.i18n.datetime.DateTime end) 予定状態を取得します。
VCalendarData	findVCalendar(String userCd, ReferenceCode refCd, jp.co.intra_mart.foundation.i18n.datetime.DateTime start, jp.co.intra_mart.foundation.i18n.datetime.DateTime end) 予定（VCALENDAR データ）を取得します。
VCalendarData[]	findVCalendars(String userCd, jp.co.intra_mart.foundation.i18n.datetime.DateTime start, jp.co.intra_mart.foundation.i18n.datetime.DateTime end) 予定（VCALENDAR データ）を取得します。
VCalendarData[]	findVCalendars(String userCd, ReferenceCodeContainer container, jp.co.intra_mart.foundation.i18n.datetime.DateTime start, jp.co.intra_mart.foundation.i18n.datetime.DateTime end) 予定（VCALENDAR データ）を取得します。
PutVEventResult	put(String refCd, VCalendar vcalednar) 予定を登録・更新します。

メソッドの詳細

delete

int delete(String refCd)
    throws InvalidParameterException,
           AuthenticationException

予定を削除します。

refCd が繰り返しスケジュールコード、または、繰り返しイベントコードの場合、繰り返し内のすべての情報が削除されます。
refCd が繰り返しの一部スケジュール、かたは、イベントの場合、除外して削除されます。

パラメータ:

refCd - 削除対象の参照コード（スケジュールコード、イベントコード、繰り返しスケジュールコード、繰り返しイベントコードのいずれか）

戻り値:

削除件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - 編集権限がない場合に発生します。

findState

VCalendarState findState(String userCd,
                         ReferenceCode refCd,
                         jp.co.intra_mart.foundation.i18n.datetime.DateTime start,
                         jp.co.intra_mart.foundation.i18n.datetime.DateTime end)
                  throws InvalidParameterException

予定状態を取得します。

指定されたユーザが参加者となっている予定について、コードと期間を指定して予定の状態を取得します。
該当する予定が存在しない場合は null を返却します。

パラメータ:

userCd - ユーザコード

refCd - 参照コード

start - 開始日時

end - 終了日時

戻り値:

予定状態

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

findStates

VCalendarState[] findStates(String userCd,
                            jp.co.intra_mart.foundation.i18n.datetime.DateTime start,
                            jp.co.intra_mart.foundation.i18n.datetime.DateTime end)
                     throws InvalidParameterException

予定状態を取得します。

指定されたユーザが参加者となっている予定について、期間内のすべての予定の状態を取得します。
該当する予定が存在しない場合は空の配列を返却します。

パラメータ:

userCd - ユーザコード

start - 開始日時

end - 終了日時

戻り値:

予定状態一覧

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

findStates

VCalendarState[] findStates(String userCd,
                            ReferenceCodeContainer container,
                            jp.co.intra_mart.foundation.i18n.datetime.DateTime start,
                            jp.co.intra_mart.foundation.i18n.datetime.DateTime end)
                     throws InvalidParameterException

予定状態を取得します。

指定されたユーザが参加者となっている予定について、コードと期間を指定して予定の状態を取得します。
該当する予定が存在しない場合は空の配列を返却します。

パラメータ:

userCd - ユーザコード

container - 参照コードコンテナ

start - 開始日時

end - 終了日時

戻り値:

予定状態一覧

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

findVCalendar

VCalendarData findVCalendar(String userCd,
                            ReferenceCode refCd,
                            jp.co.intra_mart.foundation.i18n.datetime.DateTime start,
                            jp.co.intra_mart.foundation.i18n.datetime.DateTime end)
                     throws InvalidParameterException

予定（VCALENDAR データ）を取得します。

指定されたユーザが参加者となっている予定について、コードと期間を指定して取得します。
VEVENT には iAC で生成した UID が設定されます。
該当する予定が存在しない場合は null を返却します。

パラメータ:

userCd - ユーザコード

refCd - 参照コード

start - 開始日時

end - 終了日時

戻り値:

予定（VCALENDAR データ）

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

findVCalendars

VCalendarData[] findVCalendars(String userCd,
                               jp.co.intra_mart.foundation.i18n.datetime.DateTime start,
                               jp.co.intra_mart.foundation.i18n.datetime.DateTime end)
                        throws InvalidParameterException

予定（VCALENDAR データ）を取得します。

指定されたユーザが参加者となっている予定について、期間内のすべての予定を取得します。
VEVENT には iAC で生成した UID が設定されます。
該当する予定が存在しない場合は空の配列を返却します。

パラメータ:

userCd - ユーザコード

start - 開始日時

end - 終了日時

戻り値:

予定（VCALENDAR データ）一覧

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

findVCalendars

VCalendarData[] findVCalendars(String userCd,
                               ReferenceCodeContainer container,
                               jp.co.intra_mart.foundation.i18n.datetime.DateTime start,
                               jp.co.intra_mart.foundation.i18n.datetime.DateTime end)
                        throws InvalidParameterException

予定（VCALENDAR データ）を取得します。

指定されたユーザが参加者となっている予定について、コードと期間を指定して取得します。
VEVENT には iAC で生成した UID が設定されます。
該当する予定が存在しない場合は空の配列を返却します。

パラメータ:

userCd - ユーザコード

container - 参照コードコンテナ

start - 開始日時

end - 終了日時

戻り値:

予定（VCALENDAR データ）一覧

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

put

PutVEventResult put(String refCd,
                    VCalendar vcalednar)
             throws InvalidParameterException,
                    AuthenticationException,
                    OperationException

予定を登録・更新します。

指定された予定の UID から参照コード（スケジュールコードおよびイベントコード）を取得し、該当する予定の有無に応じて処理を行います。
該当する予定が存在しない場合は新規登録処理、存在する場合は更新登録となります。

DTSTART および DTEND の型により、以下のスケジュール種別判定を行います。
DTSTART と DTEND の型が一致しない場合は InvalidParameterException が発生します。

• DateTimeである場合、スケジュールとして処理されます。
• Dateである場合、イベントとして処理されます。

登録処理において、以下の方法で定期スケジュール/イベントの判定を行います。

• RRULE が設定されていない場合：通常スケジュール/イベント
• RRULE が設定されている場合：定期スケジュール/イベント

定期スケジュール・イベントで登録可能な最大期間、最大件数は、以下の設定ファイルの設定値となります。

• 最大期間 ： 定期スケジュール・イベント登録可能期間
• 最大件数 ： 定期スケジュール・イベント登録可能件数

定期スケジュール・イベントの繰り返し条件において、以下の場合は InvalidParameterException が発生します。

• 繰り返し種別が毎日/毎週/毎月以外の場合
• 繰り返し種別が毎日で、繰り返し間隔が1以外の場合
• 繰り返し種別が毎週で、繰り返し間隔が1～4以外の場合
• 繰り返し種別が毎月で、指定日が複数ある場合

定期スケジュール・イベントの更新において、開始日時、または、終了日時を変更する場合、定期スケジュール・イベントから除外して更新されます。

更新処理において、以下の場合は OperationException が発生します。

• スケジュール種別（スケジュール/イベント）が変更されている場合

パラメータ:

refCd - 参照コード（スケジュールコード、イベントコード、繰り返しスケジュールコード、繰り返しイベントコードのいずれか）

vcalednar - 登録・更新対象の予定

戻り値:

登録・更新結果

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権判定を行う場合で、アクセス権のない参加者および施設が存在する場合に発生します。

OperationException - データ不整合が起こる場合に発生します。