uCosminexus DocumentBroker Version 5 リファレンス API

[目次][用語][索引][前へ][次へ]

5.14 DbjReferencePathInfoインターフェース

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

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

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

プロパティ名 データ型 getterメソッド setterメソッド
contentOperateMode int型 getContentOperateMode setContentOperateMode
deleteRootPath String型 getDeleteRootPath setDeleteRootPath
entry String型 getEntry setEntry
targetPath String型 getTargetPath setTargetPath
プロパティ詳細
  • contentOperateModeプロパティ
    コンテンツのパス操作モードを設定します。
    初期値はDbjDef.OPERATEMODE_NONE(コンテンツがないオブジェクトを作成する)です。
  • deleteRootPathプロパティ
    リファレンスファイル文書を削除する場合に,コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの,削除するディレクトリのルートパスを設定します。
    初期値はnull(登録されているコンテンツ,およびDocumentBrokerがコンテンツを管理するためのディレクトリを削除する)です。
    なお,deleteRootPathプロパティの指定は,コンテンツが登録されているオブジェクトに対してだけ有効になります。
    また,deleteRootPathプロパティに指定できるのは,DbjSession#setReferencePathメソッドで指定したコンテンツ格納先ベースパスから,コンテンツ格納先ベースパスとtargetPathプロパティで示されるコンテンツ格納先パスの間のパスです。コンテンツ格納先ベースパスより上位のパス,およびDocumentBrokerがコンテンツを管理するためのディレクトリのパスは指定できません。
  • entryプロパティ
    登録するコンテンツのパスまたはダウンロード先のパスを設定します。
    初期値はnullです。
    コンテンツをストリーム形式でアップロードする場合は,DbjUploadInfoのfileStreamプロパティに設定してください。なお,このプロパティに値が設定されている場合は,DbjUploadInfoのfileStreamプロパティの値は無視されます。
  • targetPathプロパティ
    サーバ上のコンテンツの格納先となるディレクトリのパス(コンテンツ格納先パス)を設定します。
    初期値はnullです。
    なお,コンテンツロケーション(dbrProp_ContentLocationプロパティ)には,targetPathプロパティで指定したパス,DocumentBrokerがコンテンツを管理するためのディレクトリのパス,およびentryプロパティで指定したファイル名を結合した値が格納されます。このとき,区切り文字には半角の「/」が設定されます。

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

<この節の構成>
5.14.1 getContentOperateMode(コンテンツのパス操作モードの取得)
5.14.2 getDeleteRootPath(削除するディレクトリのルートパスの取得)
5.14.3 getEntry(登録するコンテンツのパスまたはダウンロード先のパスの取得)
5.14.4 getTargetPath(コンテンツ格納先パスの取得)
5.14.5 setContentOperateMode(コンテンツのパス操作モードの設定)
5.14.6 setDeleteRootPath(削除するディレクトリのルートパスの設定)
5.14.7 setEntry(登録するコンテンツのパスまたはダウンロード先のパスの設定)
5.14.8 setTargetPath(コンテンツ格納先パスの設定)