メソッドの概要

返却値の型 メソッド名
ResultObject addFile (FileshareFileRegistoration parameter)
ファイルを追加します。
ResultObject addItem (FileshareRegistration parameter)
ファイル共有アイテムを追加します。
ResultObject countFile (ItemKey itemKey)
ファイル数を取得します.
ResultObject deleteFileCompletely (ItemKey itemKey, FileKey fileKey)
ファイルを完全削除します。
ResultObject deleteFileLogical (FileshareFileDeleteLogical parameter)
ファイルを論理削除します。
ResultObject deleteItem (ItemKey itemKey)
ファイル共有アイテムを削除します。
void downloadZip (ItemKey itemKey, FileKey[] fileKeys)
ZIP形式に圧縮したファイルをダウンロードします。
ResultObject findFileList (ItemKey itemKey, Boolean isDelete)
ファイルを取得します。
ResultObject findFile (ItemKey itemKey, FileKey fileKey)
ファイルを取得します。
ResultObject findHistoryList (ItemKey itemKey, FileKey fileKey)
ファイル履歴を取得します。
ResultObject findHistory (ItemKey itemKey, FileKey fileKey, Number version)
ファイル履歴を取得します。
ResultObject findItem (ItemKey itemKey)
ファイル共有アイテムを取得します。
ResultObject findSpecifiedFileList (ItemKey itemKey, FileKey[] fileKeys)
ファイルを取得します。
ResultObject restore (FileshareFileRestore parameter)
ファイルを復元します。
ResultObject updateFileEditType (FileshareEditTypeUpdate parameter)
ファイルの編集種別を更新します。
ResultObject updateFile (FileshareUpload parameter)
ファイルを更新します。
ResultObject updateItemDescription (ItemKey itemKey, String description)
ファイル共有アイテムの説明を更新します。

メソッドの詳細

ResultObject addFile (FileshareFileRegistoration parameter)
ファイルを追加します。

追加処理に失敗した場合、スキップして次のファイルを登録します。

パラメータ
parameter : FileshareFileRegistoration
ファイル情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、登録したファイル FileShareFile[] を設定します。
ResultObject addItem (FileshareRegistration parameter)
ファイル共有アイテムを追加します。

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

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

パラメータ
parameter : FileshareRegistration
ファイル共有情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FileShareFile を設定します。
ResultObject countFile (ItemKey itemKey)
ファイル数を取得します.

指定したアイテムに登録されているファイル数を取得します。

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ファイル件数 を設定します。
ResultObject deleteFileCompletely (ItemKey itemKey, FileKey fileKey)
ファイルを完全削除します。

指定したファイルを履歴含めて、すべてを削除します。

パラメータ
itemKey : ItemKey
アイテムキー
fileKey : FileKey
ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject deleteFileLogical (FileshareFileDeleteLogical parameter)
ファイルを論理削除します。

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

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

パラメータ
parameter : FileshareFileDeleteLogical
ファイル論理削除情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject deleteItem (ItemKey itemKey)
ファイル共有アイテムを削除します。

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

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

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
void downloadZip (ItemKey itemKey, FileKey[] fileKeys)
ZIP形式に圧縮したファイルをダウンロードします。

jp.co.intra_mart.common.aid.jsdk.javax.servlet.http.HTTPContext# HTTPContextより取得した javax.servlet.http.HttpServletResponse# HttpServletResponseのファイル出力用ストリームを利用してダウンロードを行います。
指定したファイルが存在しない場合、対象データの圧縮処理はスキップし、次のファイルの圧縮処理を実行します。

パラメータ
itemKey : ItemKey
アイテムキー
fileKeys : FileKey[]
ファイルキー
返却値
void
ResultObject findFileList (ItemKey itemKey, Boolean isDelete)
ファイルを取得します。

指定した削除フラグ条件に該当するデータを取得します。
該当データがない場合、空のリストを返却します。

パラメータ
itemKey : ItemKey
アイテムキー
isDelete : Boolean
true : 未削除のファイルのみ / false : 削除ファイルのみ / NULL : 両方とも取得対象
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FileShareFile[] を設定します。
ResultObject findFile (ItemKey itemKey, FileKey fileKey)
ファイルを取得します。

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

パラメータ
itemKey : ItemKey
アイテムキー
fileKey : FileKey
ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FileShareFile を設定します。
ResultObject findHistoryList (ItemKey itemKey, FileKey fileKey)
ファイル履歴を取得します。

指定したファイルの履歴をすべて取得します。

パラメータ
itemKey : ItemKey
アイテムキー
fileKey : FileKey
ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FileshareHistory[] を設定します。
ResultObject findHistory (ItemKey itemKey, FileKey fileKey, Number version)
ファイル履歴を取得します。

指定したバージョンのファイル履歴を取得します。
該当するデータがない場合、NULLを返却します。

パラメータ
itemKey : ItemKey
アイテムキー
fileKey : FileKey
ファイルキー
version : Number
履歴バージョン
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FileshareHistory を設定します。
ResultObject findItem (ItemKey itemKey)
ファイル共有アイテムを取得します。

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

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Fileshare を設定します。
ResultObject findSpecifiedFileList (ItemKey itemKey, FileKey[] fileKeys)
ファイルを取得します。

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

パラメータ
itemKey : ItemKey
アイテムキー
fileKeys : FileKey[]
ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FileShareFile[] を設定します。
ResultObject restore (FileshareFileRestore parameter)
ファイルを復元します。

指定したバージョンのファイルを復元します。

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

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

パラメータ
parameter : FileshareFileRestore
復元情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateFileEditType (FileshareEditTypeUpdate parameter)
ファイルの編集種別を更新します。

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

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

パラメータ
parameter : FileshareEditTypeUpdate
ファイル編集情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateFile (FileshareUpload parameter)
ファイルを更新します。

新しいバージョンとしてファイルを更新します。

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

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

パラメータ
parameter : FileshareUpload
ファイル更新情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateItemDescription (ItemKey itemKey, String description)
ファイル共有アイテムの説明を更新します。

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

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

パラメータ
itemKey : ItemKey
アイテムキー
description : String
説明
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。