4.4.22 getRelList文書間リンク一覧の取得

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

Proxyオブジェクトのアクセス対象の文書に文書間リンクが設定されている文書の一覧情報を取得します。一覧情報を取得できるターゲットオブジェクトは,文書だけです。この場合,取得対象とするオブジェクトのオブジェクト種別を指定できます。また,引数(relationendType)の指定によって,取得するオブジェクトの情報をフィルタリングできます。

(2) 形式

DbjLinkObjList getRelList(
    Collection          propDefs,
    Collection          linkPropDefs,
    int                 relationendType,
    int                 objType,
    DbjFetchInfo        fetchInfo
)

(3) 引数

propDefs(入力)
要素はプロパティ名(String型)です。一覧で取得するリンク先オブジェクトのプロパティ名集合を指定します。取得するプロパティがない場合はnullを指定します。
linkPropDefs(入力)
要素はプロパティ名(String型)です。一覧で取得するリンクプロパティ名集合を指定します。取得するリンクプロパティがない場合はnullを指定します。
relationendType(入力)
取得するオブジェクトの条件を指定します。次に示す定数のどれかを指定できます。RELATIONEND_STATUS定数を指定しない場合は,リンク先のオブジェクトはすべて取得します。なお,DbjDef.RELATIONEND_HEADまたはDbjDef.RELATIONEND_TAILのどちらか一つは,必ず指定してください。
  • DbjDef.RELATIONEND_HEAD
    リンク先オブジェクトを取得します。RELATIONEND_TAILと同時に指定できません。
  • DbjDef.RELATIONEND_TAIL
    リンク元オブジェクトを取得します。RELATIONEND_HEADと同時に指定できません。
  • DbjDef.RELATIONEND_STATUS_EXIST
    リンク先オブジェクトがあるオブジェクトを取得します。
  • DbjDef.RELATIONEND_STATUS_NOT_EXIST
    リンク先オブジェクトが削除されて存在しないオブジェクトを取得します。
objType(入力)
一覧で取得するリンク元またはリンク先オブジェクトのオブジェクト種別を指定します。次に示す定数のどれかを指定できます。なお,論理和を使用した指定もできます。
  • DbjDef.OBJTYPE_DOC
    バージョンなし文書
  • DbjDef.OBJTYPE_VRDOC
    バージョン付き文書
  • DbjDef.OBJTYPE_ANY
    任意のオブジェクト種別
fetchInfo(入出力)
一覧で取得する場合の検索結果取得情報を指定します。全件を取得する場合,またはキャッシュ検索をしない場合はnullを指定します。全件を取得しない場合,maxFetchCountプロパティに指定されている件数を取得した後に,comparatorプロパティに指定したコンパレータによりソートされます。そのため,全件を取得する場合と,maxFetchCountプロパティを指定して検索した場合を比較すると,comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

(4) 戻り値

リンクオブジェクト一覧情報(DbjLinkObjListインターフェース)

(5) 例外

DbjAccessControlException
アクセス権エラーの場合
DbjCORBAException
CORBAエラーの場合
DbjDBException
DBエラーの場合
DbjException
Java クラスライブラリ固有のエラーの場合
DbjIllegalCacheStartIndexException
検索結果数より大きい値を引数fetchInfo(DbjFetchInfoインターフェース)のstartIndexプロパティに指定した場合
DbjIllegalObjectTypeException
指定オブジェクト種別が不適切の場合
DbjObjectNotFoundException
指定オブジェクトが存在しなかった場合
DbjSessionNotConnectException
セッションが接続されていなかった場合
IllegalArgumentException
引数fetchInfoの指定が不正の場合