Accel Collaboration

iac_eventcalendar.EventcalendarServiceオブジェクト

コンポーネント情報
version	8.0.15
since	8.0.1

コンポーネント概要

イベントカレンダーアイテムに対する操作を提供するサービスです。

[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。

[ 操作可能なアイテムについて ]
操作ユーザが操作したいアイテムのワークスペースメンバーである必要があります。

メソッドの概要

返却値の型	メソッド名
ResultObject	addEvent (EventcalendarEventRegistration `parameter`) イベントを追加します。
ResultObject	addItem (EventcalendarRegistration `parameter`) イベントカレンダーアイテムを追加します。
ResultObject	addSchedule (EventcalendarEventRegistration `parameter`) スケジュールを追加します。
ResultObject	deleteEvent (ItemKey `itemKey`, EventKey `eventKey`) イベントを削除します。
ResultObject	deleteItem (ItemKey `itemKey`) イベントカレンダーアイテムを削除します。
ResultObject	deleteSchedule (ItemKey `itemKey`, EventKey `eventKey`) スケジュールを削除します。
ResultObject	findEventListByUser (String[] `userCds`, DateTime `startDate`, DateTime `endDate`) イベントを取得します。
ResultObject	findEventList (ItemKey `itemKey`, DateTime `startDate`, DateTime `endDate`) イベントを取得します。
ResultObject	findEvent (ItemKey `itemKey`, EventKey `eventKey`) イベントを取得します。
ResultObject	findEventsList (ItemKey `itemKey`, DateTime `startDate`, DateTime `endDate`) ワークスペースカレンダー内のイベント及びスケジュールを取得します。
ResultObject	findItem (ItemKey `itemKey`) イベントカレンダーアイテムを取得します。
ResultObject	findSchedule (ItemKey `itemKey`, EventKey `eventKey`) スケジュールを取得します。
ResultObject	updateDescription (EventcalendarDescriptionUpdate `parameter`) アイテム説明を更新します。
ResultObject	updateEventDate (EventcalendarEventDateUpdate `parameter`) イベントの期間を更新します。
ResultObject	updateEvent (EventcalendarEventUpdate `parameter`) イベントを更新します。
Number	updateEvent (EventcalendarEventUpdate `param`, ScheduleConnectorModel `connectParam`) イベントを更新します。
ResultObject	updateItemSetting (EventcalendarItemSettingUpdate `parameter`) イベントカレンダーアイテムの編集種別を更新します。
ResultObject	updateScheduleDate (EventcalendarEventDateUpdate `parameter`) スケジュールの期間を更新します。
ResultObject	updateSchedule (EventcalendarEventUpdate `parameter`) スケジュールを更新します。
Number	updateSchedule (EventcalendarEventUpdate `param`, ScheduleConnectorModel `connectParam`) スケジュールを更新します。

メソッドの詳細

ResultObject addEvent (EventcalendarEventRegistration parameter)

イベントを追加します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarEventRegistration: イベント情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent を設定します。

ResultObject addItem (EventcalendarRegistration parameter)

イベントカレンダーアイテムを追加します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
ワークスペースのアイテム追加を許可されている

パラメータ

parameter : EventcalendarRegistration: イベントカレンダー情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、Eventcalendar を設定します。

ResultObject addSchedule (EventcalendarEventRegistration parameter)

スケジュールを追加します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarEventRegistration: スケジュール情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent を設定します。

ResultObject deleteEvent (ItemKey itemKey, EventKey eventKey)

イベントを削除します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

itemKey : ItemKey: アイテムキー

eventKey : EventKey: イベントキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject deleteItem (ItemKey itemKey)

イベントカレンダーアイテムを削除します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

itemKey : ItemKey: アイテムキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject deleteSchedule (ItemKey itemKey, EventKey eventKey)

スケジュールを削除します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

itemKey : ItemKey: アイテムキー

eventKey : EventKey: イベントキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject findEventListByUser (String[] userCds, DateTime startDate, DateTime endDate)

イベントを取得します。

指定したユーザがメンバーとなっているワークスペースにある、イベントカレンダーのイベントを指定した期間分取得します。
該当するイベントがない場合、空のリストを返却します。

パラメータ

userCds : String[]: ユーザコード

startDate : DateTime: 開始日

endDate : DateTime: 終了日

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent[] を設定します。

ResultObject findEventList (ItemKey itemKey, DateTime startDate, DateTime endDate)

イベントを取得します。

指定した期間に該当するイベントカレンダー内のイベントを取得します。
該当するイベントがない場合、空のリストを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

startDate : DateTime: 開始日

endDate : DateTime: 終了日

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent[] を設定します。

ResultObject findEvent (ItemKey itemKey, EventKey eventKey)

イベントを取得します。

指定したイベントアイテムカレンダーのイベントを取得します。
該当するイベントがない場合、NULLを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

eventKey : EventKey: イベントキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent を設定します。

ResultObject findEventsList (ItemKey itemKey, DateTime startDate, DateTime endDate)

ワークスペースカレンダー内のイベント及びスケジュールを取得します。

指定した期間に該当するワークスペースカレンダー内のイベント及びスケジュールを取得します。
該当するイベント及びスケジュールがない場合、空のリストを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

startDate : DateTime: 開始日

endDate : DateTime: 終了日

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent[] を設定します。

ResultObject findItem (ItemKey itemKey)

イベントカレンダーアイテムを取得します。

該当するデータがない場合、NULLを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、Eventcalendar を設定します。

ResultObject findSchedule (ItemKey itemKey, EventKey eventKey)

スケジュールを取得します。

指定したイベントアイテムカレンダーのスケジュールを取得します。
該当するイベントがない場合、NULLを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

eventKey : EventKey: イベントキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、EventcalendarEvent を設定します。

ResultObject updateDescription (EventcalendarDescriptionUpdate parameter)

アイテム説明を更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarDescriptionUpdate: アイテム説明更新情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateEventDate (EventcalendarEventDateUpdate parameter)

イベントの期間を更新します。

指定したイベントの開始日と終了日を更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarEventDateUpdate: イベント期間情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateEvent (EventcalendarEventUpdate parameter)

イベントを更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarEventUpdate: イベント情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

Number updateEvent (EventcalendarEventUpdate param, ScheduleConnectorModel connectParam)

イベントを更新します。
スケジュール機能と連携したイベントがある場合は同時に更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

[ スケジュール機能と連携したイベントの操作について ]
スケジュール機能と連携したイベントの操作は連携更新種別によって異なります。

jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#UPDATE UPDATE の場合、ワークスペースカレンダーのイベントと連携したスケジュール機能のイベントを更新します。
jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#ADD ADD の場合、ワークスペースカレンダーのイベントを更新し、連携したスケジュール機能のイベントを登録します。
jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#DELETE DELETE の場合、ワークスペースカレンダーのイベントを更新し、連携したスケジュール機能のイベントを削除します。
jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#NONE NONE の場合、スケジュール機能を操作しません。

パラメータ

param : EventcalendarEventUpdate: イベント情報

connectParam : ScheduleConnectorModel: 連携情報

返却値

Number: int 処理件数

ResultObject updateItemSetting (EventcalendarItemSettingUpdate parameter)

イベントカレンダーアイテムの編集種別を更新します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
アイテム登録者

パラメータ

parameter : EventcalendarItemSettingUpdate: 設定更新情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateScheduleDate (EventcalendarEventDateUpdate parameter)

スケジュールの期間を更新します。

指定したスケジュールの開始日と終了日を更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarEventDateUpdate: スケジュール期間情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateSchedule (EventcalendarEventUpdate parameter)

スケジュールを更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : EventcalendarEventUpdate: イベント情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

Number updateSchedule (EventcalendarEventUpdate param, ScheduleConnectorModel connectParam)

スケジュールを更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

[ スケジュール機能と連携したスケジュールの操作について ]
スケジュール機能と連携したスケジュールの操作は連携更新種別によって異なります。

jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#UPDATE UPDATE の場合、ワークスペースカレンダーのスケジュールと連携したスケジュール機能のスケジュールを更新します。
jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#ADD ADD の場合、ワークスペースカレンダーのスケジュールを更新し、連携したスケジュール機能のスケジュールを登録します。
jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#DELETE DELETE の場合、ワークスペースカレンダーのスケジュールを更新し、連携したスケジュール機能のスケジュールを削除します。
jp.co.intra_mart.product.collaboration.workspace.item.eventcalendar.enums.UpdateConnectType#NONE NONE の場合、スケジュール機能を操作しません。

パラメータ

param : EventcalendarEventUpdate: スケジュール情報

connectParam : ScheduleConnectorModel: 連携情報

返却値

Number: int 処理件数