3.3 DbjCheckOutInfoインターフェース

DbjCheckOutInfoインターフェースは,バージョン付きオブジェクトのチェックアウト情報を扱うインターフェースです。バージョン付きオブジェクトのチェックアウト情報を取得するメソッドを提供します。チェックアウト中の場合は,チェックアウトしたユーザのユーザ識別子および仮のバージョン識別子を取得できます。

プロパティ一覧
DbjCheckOutInfoインターフェースで扱うプロパティの一覧と,各プロパティに対するgetterメソッドを表3-2に示します。

表3-2 DbjCheckOutInfoインターフェースで扱うプロパティ

プロパティ名データ型getterメソッド
checkOutboolean型isCheckOut
checkOutUserIdString型getCheckOutUserId
checkOutVersionIdString型getCheckOutVersionId
プロパティ詳細
  • checkOutプロパティ
    バージョン付きオブジェクトがチェックアウト中かどうかを表します。
    チェックアウト中の場合はtrueとなり,チェックアウトしていない場合はfalseとなります。
  • checkOutUserIdプロパティ
    チェックアウトしたユーザのユーザ識別子を表します。
    チェックアウト中の場合にだけ有効です。チェックアウトしていない場合はnullとなります。
  • checkOutVersionIdプロパティ
    チェックアウト中の仮のバージョン識別子を表します。
    チェックアウト中の場合にだけ有効です。チェックアウトしていない場合はnullとなります。

以降,DbjCheckOutInfoインターフェースのメソッドについて説明します。

<この節の構成>
3.3.1 getCheckOutUserId(チェックアウトしたユーザのユーザ識別子の取得)
3.3.2 getCheckOutVersionId(仮のバージョン識別子の取得)
3.3.3 isCheckOut(チェックアウト中かどうかの判定)