Accel Collaboration

iac_todo.TodoServiceオブジェクト

コンポーネント情報
version	8.0.1

コンポーネント概要

jp.co.intra_mart.product.collaboration.todo.service.TodoService# の実装クラスです。
このクラスからTodo情報にアクセスする機能を提供します。

メソッドの概要

返却値の型	メソッド名
ResultObject	addMultiple (TodoMultiple `todoMulti`) ToDoを複数追加します。
ResultObject	add (Todo `todo`) ToDoを追加します。
ResultObject	delete (TodoKey `todoKey`) ToDoを削除します。
ResultObject	findAttachFile (FileKeyKey `key`) ダウンロード用の添付ファイルパスを取得します。
ResultObject	findList (TodoSearchFilter `filter`, PagingParameter `target`) ToDoを取得します。
ResultObject	findRange (RangeFilter `filter`) ToDoを取得します。
ResultObject	find (TodoKey[] `keys`) ToDoを取得します。
ResultObject	updateStar (TodoKey `todoKey`, Boolean `isStar`) スターを更新します。
ResultObject	updateStatus (TodoKey `todoKey`, Boolean `isComplete`) ToDoのステータスを更新します。
ResultObject	updateTodoSortKey (TodoSortKeyUpdate `parameter`) ToDoの表示順序を更新します。
ResultObject	update (Todo `todo`) ToDoを更新します。

メソッドの詳細

ResultObject addMultiple (TodoMultiple todoMulti)

ToDoを複数追加します。

ToDo複数登録のタイトル数分、ToDoを登録します。
タイトル以外はすべて同じ情報が登録されます。

パラメータ

todoMulti : TodoMultiple: ToDo複数登録情報

返却値

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

ResultObject add (Todo todo)

ToDoを追加します。

パラメータ

todo : Todo: ToDo情報

返却値

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

ResultObject delete (TodoKey todoKey)

ToDoを削除します。

ワークスペース機能のチェックリストアイテムのタスクと連携している場合、タスクも削除します。

パラメータ

todoKey : TodoKey: ToDoキー

返却値

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

ResultObject findAttachFile (FileKeyKey key)

ダウンロード用の添付ファイルパスを取得します。

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

パラメータ

key : FileKeyKey: 添付ファイルキー

返却値

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

ResultObject findList (TodoSearchFilter filter, PagingParameter target)

ToDoを取得します。

指定した検索条件に該当するデータをページ情報分取得します。
該当データがない場合、空の配列を返却します。

パラメータ

filter : TodoSearchFilter: 検索条件

target : PagingParameter: ページ情報

返却値

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

ResultObject findRange (RangeFilter filter)

ToDoを取得します。

指定した日付範囲のToDoを取得します。
該当するデータがない場合、空の配列を返却します。

パラメータ

filter : RangeFilter: 検索条件

返却値

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

ResultObject find (TodoKey[] keys)

ToDoを取得します。

該当データがない場合、空の配列を返却します。

パラメータ

keys : TodoKey[]: ToDoキー

返却値

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

ResultObject updateStar (TodoKey todoKey, Boolean isStar)

スターを更新します。

パラメータ

todoKey : TodoKey: ToDoキー

isStar : Boolean: true : スターあり / false : スターなし

返却値

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

ResultObject updateStatus (TodoKey todoKey, Boolean isComplete)

ToDoのステータスを更新します。

ワークスペース機能のチェックリストアイテムと連携している場合、連携先のタスクも更新します。

パラメータ

todoKey : TodoKey: ToDoキー

isComplete : Boolean: true : 完了 / false : 未完了

返却値

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

ResultObject updateTodoSortKey (TodoSortKeyUpdate parameter)

ToDoの表示順序を更新します。

パラメータ

parameter : TodoSortKeyUpdate: ToDo表示順更新情報

返却値

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

ResultObject update (Todo todo)

ToDoを更新します。

ワークスペース機能のチェックリストアイテムと連携している場合、連携先のタスクも更新します。

パラメータ

todo : Todo: ToDo情報

返却値

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