CdbrDocument::GetRelationListメソッド

機能

文書のリレーション情報の一覧取得

形式

DmaBoolean GetRelationList(
 pDmaBoolean             pbContinue,
 DmaInteger32            lClassType,
 DmaInteger32            lPropDefListCount,
 SDBR_PROPDEF*           pPropDefList,
 DmaInteger32            lRelPropDefListCount,
 SDBR_PROPDEF*           pRelPropDefList,
 DmaInteger32            lRelationListCount,
 SDBR_RELATIONLIST**     ppRelationList,
 DmaInteger32            lRelationendType,
 DmaInteger32            lRelationendStatus)

// プロパティ定義情報構造体
struct SDBR_PROPDEF {
  DmaId             PropId;        //プロパティ識別子
};

// プロパティ構造体
struct SDBR_PROP {
  DmaId              PropId;        //プロパティ識別子
  DmaInteger32       lType;         //データ型
  DmaInteger32       lCardinality;  //基本単位
  DmaInteger32       lCount;        //値の個数
  union {                           //プロパティの値
    pDmaBoolean      pbBoolean;       //Boolean型
    pDmaInteger32    plInteger32;     //Integer32型
    pDmaId           pId;             //ID型
    pDmapv           ppObject;        //Object型
    ppDmaString_T    ppString;        //String型
   } uniValue;
};

// プロパティリスト構造体
struct SDBR_PROPLIST {
  DmaInteger32       lCount;        //プロパティ情報の個数
  SDBR_PROP*         pItem;         //プロパティ情報
};

// リレーションリスト構造体
struct SDBR_RELATIONLIST {
 DmaInteger32       lCount; //リレーションしている数
 SDBR_RELATIONINFO* pItem;  //リレーション情報構造体へのポインタ
};

// リレーション情報構造体
struct SDBR_RELATIONINFO {
 pDmaString_T   pOIID;       //文書オブジェクトのOIID
 DmaInteger32   lType;       //オブジェクトの種別
 pDmaString_T   pRelId;      //リレーション識別子
 SDBR_PROPLIST  PropList;    //オブジェクトのプロパティリスト
 SDBR_PROPLIST  RelPropList; //リレーションのプロパティリスト
};

詳細

文書間リレーションで関連づけられている文書の一覧情報を取得するメソッドです。

引数lRelationendTypeにDBR_RELATIONEND_HEADを設定することによって,このオブジェクトに関連づけされているリレーション先文書の一覧情報を取得できます。また,lRelationendTypeにDBR_RELATIONEND_TAILを設定することによって,このオブジェクトをリレーション先に持つリレーション元文書の一覧情報を取得できます。

初回取得時は,引数pbContinueにDMA_FALSEを設定してメソッドをコールします。1回のメソッドのコールで一覧の取得が完了しなかった場合,引数pbContinueにDMA_TRUEが設定されます。残りの要素は,引数pbContinueにDMA_TRUEを設定して取得します。引数pbContinueがDMA_FALSEになるまで,繰り返してこのメソッドをコールしてください。

リレーション先のオブジェクトが削除されていて,RemoveRelationメソッドで文書間リレーションが解除されないままの場合,リレーション情報は残っている状態になります。この場合も,引数lRelationendStatusにDBR_RELATIONEND_STATUS_NOT_EXISTまたはDBR_RELATIONEND_STATUS_ALLを設定することによって,削除されたオブジェクトのリレーション情報を取得できます。オブジェクトが削除されていてリレーション情報だけが残っている場合,リレーション情報構造体である,SDBR_RELATIONINFO構造体の内容は,pOIID = NULL,lType = DBR_CLASS_UNKNOWN,PropList.lCount = 0,PropList.pItem = NULLになり,pRelIdとRelPropListだけに正当な値が設定されます。

なお,このメソッドで取得したリレーション識別子は,トランザクションが終了するまで有効とは限りません。ほかのトランザクションから削除されたり,リレーションのプロパティを変更されたりする可能性があります。

引数

pbContinue(入力/出力)

リストの取得方法を示す値を格納する領域を指定します。

DMA_TRUEを指定すると,オブジェクトに対する前回のメソッドのコールで取得した要素の次の要素から取得します。DMA_FALSEまたはDMA_UNKNOWNを指定すると,前回取得した要素の残りを破棄して,新たに先頭から取得します。

なお,オブジェクトの生成後初めてメソッドをコールした場合,または前回の読み出しですべて取得した場合は,DMA_FALSEが指定されたものとして動作します。

前回の読み出しと異なる引数を持つメソッドがコールされた場合は,pbContinueの値を無視し,前回取得の残りを破棄して新たに先頭から取得します。

正常終了すると,メソッドを継続してコールする必要があるかどうかを示す次の値が設定されます。

lClassType(入力)

指定されたクラス識別子の要素だけを取得します。ただし,関連づけの対象オブジェクトがすでに削除されていて,リレーションだけが残っているリレーション情報についてはlClassTypeの指定とは無関係にすべて取得されます。

指定できるクラス識別子を次に示します。

クラス識別子クラスの種別
DBR_CLASS_VERSIONABLEDOCUMENTCdbrVersionableDocumentクラス
DBR_CLASS_DOCUMENTCdbrDocumentクラス
DBR_CLASS_ALLすべてのクラス

それぞれのクラスの識別子をOR条件とした取得もできます。例えば,CdbrDocumentクラスとCdbrVersionableDocumentクラスの要素を取得したい場合は,次のように指定します。

DBR_CLASS_DOCUMENT | DBR_CLASS_VERSIONABLEDOCUMENT

すべてのクラスの要素を取得する場合は,DBR_CLASS_ALLを指定してください。

lPropDefListCount(入力)

文書間リレーション情報の一覧と同時に取得するプロパティの個数(引数pPropDefListに指定する配列の要素数)を0以上の値で指定します。プロパティを取得しない場合は0を指定します。負の値を指定した場合は,エラーになります。

pPropDefList(入力)

文書間リレーション情報の一覧と同時に取得するプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。プロパティを取得しない場合はNULLを指定してください。NULLは,lPropDefListCountが0の場合だけ指定できます。lPropDefListCountが正の整数のときにpPropDefListにNULLを指定すると,エラーになります。

SDBR_PROPDEF構造体に指定する内容については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。

lRelPropDefListCount(入力)

文書間リレーション情報の一覧と同時に取得するリレーションのプロパティの個数(引数pRelPropDefListに指定する配列の要素数)を0以上の値で指定します。プロパティを取得しない場合は0を指定します。負の値を指定した場合は,エラーになります。

pRelPropDefList(入力)

文書間リレーション情報の一覧と同時に取得するリレーションのプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。プロパティを取得しない場合はNULLを指定してください。NULLは,lRelPropDefListCountが0の場合だけ指定できます。lRelPropDefListCountが正の整数のときにpRelPropDefListにNULLを指定すると,エラーになります。

SDBR_PROPDEF構造体に指定する内容については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。

lRelationListCount(入力)

取得する文書間リレーション情報の数を1以上の値で指定します。0以下の値を指定するとエラーになります。

ppRelationList(出力)

取得した文書間リレーション情報一覧へのポインタである,SDBR_RELATIONLIST構造体が設定されます。ポインタを格納する領域を指定してください。**ppRelationListがポイントするメモリは,ライブラリが新たに確保したものです。このメモリは,ユーザプログラムでdbrDelete関数を使用して解放してください。なお,**ppRelationListを指定してメモリを解放すると,構造体のメンバ(**ppRelationList)->pItemおよびその先に確保されているメモリはすべて解放されます。したがってメソッドをコールした側がこれらのメンバのメモリを個別に解放する必要はありません。

SDBR_RELATIONLIST構造体およびSDBR_RELATIONINFO構造体に設定される内容については,「付録C.1(17) SDBR_RELATIONLIST構造体(リレーションリスト構造体)」および「付録C.1(16) SDBR_RELATIONINFO構造体(リレーション情報構造体)」を参照してください。

また,プロパティ情報が設定されるSDBR_PROPLIST構造体およびSDBR_PROP構造体については,「付録C.1(14) SDBR_PROPLIST構造体(プロパティリスト構造体)」および「付録C.1(12) SDBR_PROP構造体(プロパティ構造体)」を参照してください。

lRelationendType(入力)

このオブジェクトが文書間リレーションで関連づけているリレーション先オブジェクトの一覧を取得するか,このオブジェクトが文書間リレーションで関連づけられているリレーション元オブジェクトの一覧を取得するかを指定します。

次に示す値のどちらかを指定してください。

lRelationendStatus(入力)

関連づけの対象オブジェクトが存在しているリレーション情報の一覧を取得するか,すでに関連づけの対象オブジェクトが削除されていて,リレーションだけ残っているリレーション情報の一覧を取得するかを指定します。

次に示す値のどれかを指定してください。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBERR_DB_DEADLOCK_OCCURREDデータベースでデッドロックが発生しました。時間を置いて,再度実行してください。
ERR_DBERR_DB_FAILEDデータベースで障害が発生しました。syslogを参照して,障害の原因を取り除いてください。
ERR_DBERR_DB_LOCKEDオブジェクトがロックされています。時間を置いて,再度実行してください。
ERR_DBRERR_ACCESS_NOT_PERMITTEDアクセス権がありません。この操作は実行できません。
ERR_DBRERR_ACLIB_OBJECT_INVALIDクラスライブラリのオブジェクトは無効です。有効なクラスライブラリのオブジェクトを指定してください。
ERR_DBRERR_OBJECT_NOT_CONNECTオブジェクトは接続されていません。オブジェクトを接続してください。
ERR_DBRERR_OBJECT_REMOVEDオブジェクトはすでに削除されています。正しいオブジェクトを指定してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_PROPIDプロパティの識別子が不正です。正しいプロパティ識別子を指定してください。
ERR_DMADMARC_LOST_CONNECTION現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。文書空間に再接続してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトまたはクラスではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_TIMEOUT制限時間を超過しました。タイムアウトしました。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMAEDMRC_NOT_INTRANSACTIONトランザクション外でメソッドが呼ばれました。Beginメソッドの呼び出し後に,この操作を実行してください。