public interface FileshareService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 操作可能なアイテムについて ]
操作ユーザが操作したいアイテムのワークスペースメンバーである必要があります。
修飾子とタイプ | メソッドと説明 |
---|---|
List<FileShareFile> |
addFile(FileshareFileRegistoration parameter)
ファイルを追加します。
|
Fileshare |
addItem(FileshareRegistration parameter)
ファイル共有アイテムを追加します。
|
int |
countFile(ItemKey itemKey)
ファイル数を取得します.
|
int |
deleteFileCompletely(ItemKey itemKey,
FileKey fileKey)
ファイルを完全削除します。
|
int |
deleteFileLogical(FileshareFileDeleteLogical parameter)
ファイルを論理削除します。
|
int |
deleteItem(ItemKey itemKey)
ファイル共有アイテムを削除します。
|
void |
downloadZip(ItemKey itemKey,
FileKey[] fileKeys)
ZIP形式に圧縮したファイルをダウンロードします。
|
FileShareFile |
findFile(ItemKey itemKey,
FileKey fileKey)
ファイルを取得します。
|
List<FileShareFile> |
findFileList(ItemKey itemKey,
Boolean isDelete)
ファイルを取得します。
|
FileshareHistory |
findHistory(ItemKey itemKey,
FileKey fileKey,
int version)
ファイル履歴を取得します。
|
List<FileshareHistory> |
findHistoryList(ItemKey itemKey,
FileKey fileKey)
ファイル履歴を取得します。
|
Fileshare |
findItem(ItemKey itemKey)
ファイル共有アイテムを取得します。
|
List<FileShareFile> |
findSpecifiedFileList(ItemKey itemKey,
FileKey[] fileKeys)
ファイルを取得します。
|
int |
restore(FileshareFileRestore parameter)
ファイルを復元します。
|
int |
updateFile(FileshareUpload parameter)
ファイルを更新します。
|
int |
updateFileEditType(FileshareEditTypeUpdate parameter)
ファイルの編集種別を更新します。
|
int |
updateItemDescription(ItemKey itemKey,
String description)
ファイル共有アイテムの説明を更新します。
|
List<FileShareFile> addFile(FileshareFileRegistoration parameter) throws InvalidParameterException, AuthenticationException, OperationException
追加処理に失敗した場合、スキップして次のファイルを登録します。
parameter
- ファイル情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Fileshare addItem(FileshareRegistration parameter) throws InvalidParameterException, AuthenticationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
parameter
- ファイル共有情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。int countFile(ItemKey itemKey) throws InvalidParameterException, AuthenticationException, OperationException
指定したアイテムに登録されているファイル数を取得します。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int deleteFileCompletely(ItemKey itemKey, FileKey fileKey) throws InvalidParameterException, AuthenticationException, OperationException
指定したファイルを履歴含めて、すべてを削除します。
itemKey
- アイテムキーfileKey
- ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int deleteFileLogical(FileshareFileDeleteLogical parameter) throws InvalidParameterException, OperationException, AuthenticationException
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
parameter
- ファイル論理削除情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int deleteItem(ItemKey itemKey) throws InvalidParameterException, OperationException, AuthenticationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。void downloadZip(ItemKey itemKey, FileKey[] fileKeys) throws InvalidParameterException, AuthenticationException, OperationException
HTTPContext
より取得した
HttpServletResponse
のファイル出力用ストリームを利用してダウンロードを行います。
指定したファイルが存在しない場合、対象データの圧縮処理はスキップし、次のファイルの圧縮処理を実行します。
itemKey
- アイテムキーfileKeys
- ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。FileShareFile findFile(ItemKey itemKey, FileKey fileKey) throws InvalidParameterException, AuthenticationException, OperationException
該当データがない場合、NULL
を返却します。
itemKey
- アイテムキーfileKey
- ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。List<FileShareFile> findFileList(ItemKey itemKey, Boolean isDelete) throws InvalidParameterException, AuthenticationException, OperationException
指定した削除フラグ条件に該当するデータを取得します。
該当データがない場合、空のリストを返却します。
itemKey
- アイテムキーisDelete
- true : 未削除のファイルのみ / false : 削除ファイルのみ / NULL
: 両方とも取得対象InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。FileshareHistory findHistory(ItemKey itemKey, FileKey fileKey, int version) throws InvalidParameterException, AuthenticationException, OperationException
指定したバージョンのファイル履歴を取得します。
該当するデータがない場合、NULL
を返却します。
itemKey
- アイテムキーfileKey
- ファイルキーversion
- 履歴バージョンInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。List<FileshareHistory> findHistoryList(ItemKey itemKey, FileKey fileKey) throws InvalidParameterException, AuthenticationException, OperationException
指定したファイルの履歴をすべて取得します。
itemKey
- アイテムキーfileKey
- ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Fileshare findItem(ItemKey itemKey) throws InvalidParameterException, AuthenticationException
該当データがない場合、NULL
を返却します。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。List<FileShareFile> findSpecifiedFileList(ItemKey itemKey, FileKey[] fileKeys) throws InvalidParameterException, AuthenticationException, OperationException
該当データがない場合、空のリストを返却します。
itemKey
- アイテムキーfileKeys
- ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int restore(FileshareFileRestore parameter) throws InvalidParameterException, OperationException, AuthenticationException
指定したバージョンのファイルを復元します。
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
parameter
- 復元情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateFile(FileshareUpload parameter) throws InvalidParameterException, AuthenticationException, OperationException
新しいバージョンとしてファイルを更新します。
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
parameter
- ファイル更新情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateFileEditType(FileshareEditTypeUpdate parameter) throws InvalidParameterException, AuthenticationException, OperationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
parameter
- ファイル編集情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateItemDescription(ItemKey itemKey, String description) throws InvalidParameterException, AuthenticationException, OperationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
itemKey
- アイテムキーdescription
- 説明InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION