ファイルのチェックイン
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。
ファイルをチェックアウトして編集した後、他のユーザーが新しいバージョンを表示するには、ファイルをチェックインする必要があります。 そうすると、プライベートの作業コピーにアクセスできなくなります。 次回ファイルがチェックアウトされると、プライベート作業コピーの内容が上書きされます。
ファイルをチェックインするための DLAppService
メソッドは checkInFileEntry
です。
checkInFileEntry(long fileEntryId, boolean majorVersion, String changeLog,
ServiceContext serviceContext)
メソッドとそのパラメーターの詳細については、その Javadoc参照してください。 このメソッドは、プライベート作業コピーを使用して、ファイルの新しいバージョンを作成します。 アップデートファイルチュートリアル 説明しているように、 majorVersion
パラメーターの設定により、ファイルのバージョン番号の増分方法が決まります。
checkInFileEntry
を使用してファイルをチェックインするには、次の手順に従います。
-
DLAppService
への参照を取得します。@Reference private DLAppService _dlAppService;
詳細については、入門チュートリアルの「サービスリファレンス 取得
」のセクションを参照してください。
2 checkInFileEntry
メソッドの引数を設定するために必要なデータを取得します。 エンドユーザーによるアクションに応じてファイルをチェックインするのが一般的であるため、リクエストからデータを抽出できます。 この例では、 javax.portlet.ActionRequest
および ParamUtil
を介してこれを行いますが、任意の方法でデータを取得できます。
long fileEntryId = ParamUtil.getLong(actionRequest, "fileEntryId");
boolean majorVersion = ParamUtil.getBoolean(actionRequest, "majorVersion");
String changeLog = ParamUtil.getString(actionRequest, "changeLog");
ServiceContext serviceContext = ServiceContextFactory.getInstance(actionRequest);
ServiceContext
詳細については、チュートリアル ServiceContextについて参照してください。
3 前の手順のデータを使用して、サービス参照の checkInFileEntry
メソッドを呼び出します。
_dlAppService.checkInFileEntry(
fileEntryId, majorVersion, changeLog, serviceContext);
</ol>
この例の完全なコードは、Liferay DXPの EditFileEntryMVCActionCommand
クラスの checkInFileEntries
メソッドにあります。 このクラスは、Documents and Media APIを使用して、Documents and Mediaアプリがサポートするほぼすべての FileEntry
アクションを実装します。 また、この checkInFileEntries
メソッドと、残りの EditFileEntryMVCActionCommand
には、Documents and Mediaアプリの特定のニーズに合う追加のロジックが含まれていることに注意してください。