jp.co.intra_mart.product.collaboration.filelibrary.service

インタフェース FileService

public interface FileService

ファイルに対する操作を提供するサービスです。

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

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
FileDetail[]	addFile(FolderKey folderKey, FileDetail[] files, DeliveryType deliveryType) ファイルを追加します。
Boolean	checkEditAcl(FileKey key) ファイルに対して編集可能な権限を保持しているかチェックします。
FileDetail	copyFileFromPublicStorage(FolderKey toFolderKey, FileDetail fromFile, String toFileName, DeliveryType deliveryType) ファイルをコピーします。
Integer	deleteFile(FileKey[] keys) ファイルを削除します。
void	downloadZipFile(FileKey[] keys) ZIP形式に圧縮したファイルをダウンロードします。
FileDetail	find(FileKey key) ファイルを取得します。
FileDetailListItem[]	findAclFileDetail(PagingParameter target) アクセス権のあるファイルを取得します。
FileView[]	findFile(FolderKey folderKey) フォルダ内のファイルを取得します。
FileDetailListItem[]	findFileDetail(FolderKey folderKey, PagingParameter target) フォルダ内のファイルを取得します。
DownloadFile[]	findFilePath(FileKey[] keys) ダウンロード用のファイルパスを取得します。
FileView[]	searchFile(FileFilter filter) ファイルを検索します。
FileDetailListItem[]	searchFileDetail(FileFilter filter, PagingParameter target) ファイルを検索します。
Integer	updateFile(FileDetail file, DeliveryType deliveryType) ファイルを更新します。

メソッドの詳細

addFile

FileDetail[] addFile(FolderKey folderKey,
                     FileDetail[] files,
                     DeliveryType deliveryType)
              throws InvalidParameterException,
                     AuthenticationException,
                     OperationException

ファイルを追加します。

パラメータ:

folderKey - フォルダキー

files - ファイル情報

deliveryType - 配信種別

戻り値:

追加したファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

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

checkEditAcl

Boolean checkEditAcl(FileKey key)
              throws InvalidParameterException

ファイルに対して編集可能な権限を保持しているかチェックします。

フォルダに対して登録権限がある場合、編集可能なアクセス権があると判断します。
アクセス権限のないファイルを指定した場合、falseが返却されます。

パラメータ:

key - ファイルキー

戻り値:

true : 編集可能な権限を保持している。 / false : 編集可能な権限を保持していない。

例外:

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

copyFileFromPublicStorage

FileDetail copyFileFromPublicStorage(FolderKey toFolderKey,
                                     FileDetail fromFile,
                                     String toFileName,
                                     DeliveryType deliveryType)
                              throws InvalidParameterException,
                                     AuthenticationException,
                                     OperationException

ファイルをコピーします。

指定したフォルダ配下にファイルをコピーします。
ここでは、PublicStorageを移動元として対象のフォルダにファイルをコピーします。
コピー先のフォルダに対してアクセス権がない場合、コピーできません。

パラメータ:

toFolderKey - コピー先のフォルダキー

fromFile - コピー元のファイル情報

toFileName - コピーファイル名

deliveryType - 配信種別

戻り値:

コピーしたファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

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

deleteFile

Integer deleteFile(FileKey[] keys)
            throws InvalidParameterException,
                   AuthenticationException

ファイルを削除します。

パラメータ:

keys - ファイルキー

戻り値:

処理件数

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

downloadZipFile

void downloadZipFile(FileKey[] keys)
              throws InvalidParameterException,
                     AuthenticationException,
                     OperationException

ZIP形式に圧縮したファイルをダウンロードします。

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

パラメータ:

keys - ファイルキー

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

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

find

FileDetail find(FileKey key)
         throws InvalidParameterException,
                AuthenticationException

ファイルを取得します。

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

パラメータ:

key - ファイルキー

戻り値:

ファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

findAclFileDetail

FileDetailListItem[] findAclFileDetail(PagingParameter target)
                                throws InvalidParameterException

アクセス権のあるファイルを取得します。

アクセス権のあるファイルをページ情報分取得します。
該当するデータがない場合、空の配列を返却します。

パラメータ:

target - ページ情報

戻り値:

ファイル情報

例外:

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

findFile

FileView[] findFile(FolderKey folderKey)
             throws InvalidParameterException,
                    AuthenticationException

フォルダ内のファイルを取得します。

指定したフォルダ内のファイルをすべて取得します。
該当データがない場合、空の配列を返却します。

パラメータ:

folderKey - フォルダキー

戻り値:

ファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

findFileDetail

FileDetailListItem[] findFileDetail(FolderKey folderKey,
                                    PagingParameter target)
                             throws InvalidParameterException,
                                    AuthenticationException

フォルダ内のファイルを取得します。

指定したフォルダ内のファイルをページ情報分取得します。
該当データがない場合、空の配列を返却します。

パラメータ:

folderKey - フォルダキー

target - ページ情報

戻り値:

ファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

findFilePath

DownloadFile[] findFilePath(FileKey[] keys)
                     throws InvalidParameterException,
                            AuthenticationException

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

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

パラメータ:

keys - ファイルキー

戻り値:

ファイルのダウンロード情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

searchFile

FileView[] searchFile(FileFilter filter)
               throws InvalidParameterException,
                      AuthenticationException

ファイルを検索します。

指定した検索条件に該当するファイルを取得します。
該当するデータがない場合、空の配列を返却します。

パラメータ:

filter - 検索条件

戻り値:

ファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

searchFileDetail

FileDetailListItem[] searchFileDetail(FileFilter filter,
                                      PagingParameter target)
                               throws InvalidParameterException,
                                      AuthenticationException

ファイルを検索します。

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

パラメータ:

filter - 検索条件

target - ページ情報

戻り値:

ファイル情報

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

updateFile

Integer updateFile(FileDetail file,
                   DeliveryType deliveryType)
            throws InvalidParameterException,
                   AuthenticationException,
                   OperationException

ファイルを更新します。

パラメータ:

file - ファイル情報

deliveryType - 配信種別

戻り値:

処理件数

例外:

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

AuthenticationException - アクセス権違反した場合に発生します。

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