3.14 DbjReferencePathInfoインターフェース

DbjReferencePathInfoインターフェースは,リファレンスファイル文書のパス情報を扱うインターフェースです。リファレンスファイル文書のパス情報を取得,設定するメソッドを提供します。

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

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

プロパティ名データ型getterメソッドsetterメソッド
contentOperateModeint型getContentOperateModesetContentOperateMode
deleteRootPathString型getDeleteRootPathsetDeleteRootPath
entryString型getEntrysetEntry
targetPathString型getTargetPathsetTargetPath
プロパティ詳細
  • contentOperateModeプロパティ
    コンテンツのパス操作モードを表します。
    初期値はDbjDef.OPERATEMODE_NONEです。コンテンツロケーションをコンテンツの相対パスで管理する場合は,DbjDef.OPERATEMODE_USER_RELATIVE_CONTENTを指定します。コンテンツがないオブジェクトを作成する場合は,DbjDef.OPERATEMODE_NONEを指定します。
  • deleteRootPathプロパティ
    リファレンスファイル文書を削除する場合に,コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの,削除するディレクトリのルートパスを表します。
    削除の対象となるディレクトリは,コンテンツロケーション(dbrProp_ContentLocationプロパティ)で示されるパス上の格納ディレクトリから,deleteRootPathプロパティで指定したディレクトリの下位までの間にあるディレクトリです。最下位層のディレクトリから順に削除し,エラーとなった時点で処理を終了します。
    deleteRootPathプロパティに指定したパスがコンテンツロケーションのパスと一致していない場合はエラーになります。
    初期値はnullです。nullを指定した場合,登録されているコンテンツ,およびDocumentBrokerがコンテンツを管理するためのディレクトリが削除されます。
    なお,deleteRootPathプロパティの指定は,コンテンツが登録されているオブジェクトに対してだけ有効になります。
    また,deleteRootPathプロパティに指定できるのは,DbjSession#setReferencePathメソッドで指定したコンテンツ格納先ベースパスから,コンテンツ格納先ベースパスとtargetPathプロパティで示されるコンテンツ格納先パスの間のパスです。コンテンツ格納先ベースパスより上位のパス,およびDocumentBrokerがコンテンツを管理するためのディレクトリのパスは指定できません。
  • entryプロパティ
    登録するコンテンツのパスまたはダウンロード先のパスを表します。
    初期値はnullです。
  • targetPathプロパティ
    サーバ上のコンテンツの格納先となるディレクトリのパス(コンテンツ格納先パス)を表します。初期値はnullです。
    コンテンツロケーション(dbrProp_ContentLocationプロパティ)には,targetPathプロパティで指定したパス,DocumentBrokerがコンテンツを管理するためのディレクトリのパス,およびentryプロパティで指定したファイル名を結合した値が格納されます。このとき,区切り文字には半角の「/」が設定されます。

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

<この節の構成>
3.14.1 getContentOperateMode(コンテンツのパス操作モードの取得)
3.14.2 getDeleteRootPath(削除するディレクトリのルートパスの取得)
3.14.3 getEntry(登録するコンテンツのパスまたはダウンロード先のパスの取得)
3.14.4 getTargetPath(コンテンツ格納先パスの取得)
3.14.5 setContentOperateMode(コンテンツのパス操作モードの設定)
3.14.6 setDeleteRootPath(削除するディレクトリのルートパスの設定)
3.14.7 setEntry(登録するコンテンツのパスまたはダウンロード先のパスの設定)
3.14.8 setTargetPath(コンテンツ格納先パスの設定)