uCosminexus 電子フォームワークフロー APIリファレンス

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

getDownOrgInfo

形式

public BLCDictionary getDownOrgInfo(java.lang.String p_belongto,
                                  java.util.ArrayList p_attrlist,
                                  java.lang.String p_sortkey)
                           throws BLCException

機能

指定した組織に属するすべての下位組織の情報を取得します。結果は,新しいBLCDictionaryクラスオブジェクトに格納されます。

パラメータ

p_belongto

組織IDを指定します。最上位組織の組織情報を取得する場合は,"$root"を指定してください。組織IDは,1〜128バイトで指定してください。

p_attrlist

取得属性を指定します。1個以上指定してください。指定できる属性を次に示します。

属性名 意味
CDORG 組織コード
NMORG 組織略称
NMORGFULL 組織名
CDPARENTORG 上位組織コード
ユ−ザ追加カラム名 ユ−ザ追加情報

p_sortkey

ソート条件を,ご使用になるRDBMSのORDER BY句に指定できる式で指定します。500文字以内で指定してください。500文字を超えた場合,SQL発行時にエラーになることがあります。

ソートしない場合は,nullオブジェクトまたは空文字("")を指定してください。

ソート条件の指定形式例を次に示します。

形式例
属性名△ソートモード[,属性名△ソートモード,・・・・]
注 △は半角スペースです。
  • 指定可能な属性名は,データベースのBLC_ORG_Vビューに定義されているカラム名です。
  • ソートモードは次のどちらかを指定してください。
    モード 意味
    ASC 昇順
    DESC 降順
注 指定できる形式は,ご使用になるRDBMSによって異なります。詳細は,ご使用になるRDBMSのORDER BY句に指定できる式を確認してください。

戻り値

取得した組織情報。

キーの意味とオブジェクト種別について,次に示します。

キー名 意味 オブジェクト種別 備考
blc_org_total 取得情報数 Integer 取得属性の指定に関係なく取得できます。
blc_org_cd_$n 組織コード String 取得属性の指定に関係なく取得できます。
blc_org_ab_$n 組織略称 String 取得属性にNMORGを指定した場合だけ取得できます。
blc_org_nmfull_$n 組織名 String 取得属性にNMORGFULLを指定した場合だけ取得できます。
blc_org_cdup_$n 上位組織コード String 取得属性にCDPARENTORGを指定した場合だけ取得できます。
最上位組織の場合,"$root"が返却されます。
blc_org_"ユ−ザ追加カラム名"_$n ユ−ザ追加情報 Object 取得属性に指定したカラム名だけ取得できます。
blc_org_cnt_"組織コード" 逆引き用情報番号 String 取得属性の指定に関係なく取得できます。
blc_org_abnm_"組織コード" 組織略称 String 取得属性にNMORGを指定していない場合は,空文字("")が返却されます。

(凡例)

$n 取得情報番号(1〜取得数)。


指定した組織IDの組織がデータベース(BLC_ORG_Vビュー)に登録されていない場合でも,キー名「blc_org_total」に値が0のIntegerオブジェクトが設定されて,正常終了します。

指定した組織IDの組織下に組織が登録されていない場合でも,キー名「blc_org_total」に値が0のIntegerオブジェクトが設定されて,正常終了します。

例外

BLCException

BLC内で次のどれかの原因のエラーが発生しました。