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

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

getItem

形式

public BLCDictionary getItem(java.lang.String p_uid,
                             java.lang.String p_targetbp,
                             int p_topnum,
                             int p_getnum,
                             java.lang.String p_strsortkey,
                             java.lang.String p_strsortmode)
                      throws BLCException

機能

指定したユーザの受信ボックス内の作業の情報を取得します。結果は,新しいBLCDictionaryクラスオブジェクトに格納されます。

パラメータ

p_uid

対象ユーザのユーザIDを指定します。ユーザIDは,1〜128バイトで指定してください。

p_targetbp

業務で絞り込む場合は,業務の名称を指定します。業務で絞り込まない場合は,nullオブジェクトまたは空文字("")を指定します。業務の名称は,1〜128バイトで指定してください。

p_topnum

取得開始位置を指定します。1以上の値を指定してください。

p_getnum

取得数を指定します。1以上の値を指定してください。

p_strsortkey

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

パラメータ「p_strsortmode」の指定がnullオブジェクトまたは空文字("")の場合,このパラメータの指定は無視されます。

キー名 意味
NMBP 業務名称
NMUPDATEWI 更新作業名
CDAPPLICANT 申請者ID
NMAPPLICANT 申請者氏名
NMAPPLICANTBELONGTO 申請者組織略称
DTCREATE 開始日時
DTLIMIT 処理期限
ProcessInstanceName 申請ID
WorkDefinitionName 作業名
CreationDate 到着日時
Participant 所有者のユーザID
NMPARTICIPANT 作業者氏名
NMSTATUS 案件状態
NMPARBELONGTO 作業者組織略称
CDBEFOREPARTICIPANT 前回作業者ID
NMBEFOREPARTICIPANT 前回作業者氏名
NMBEFOREPARTICIPANTBELONGTO 前回作業者組織略称
DTUPDATE 前回作業日時
NMITEM1 項目値1
NMITEM2 項目値2
NMITEM3 項目値3
NMITEM4 項目値4
NMITEM5 項目値5
NMITEM6 項目値6
NMITEM7 項目値7
NMITEM8 項目値8
NMITEM9 項目値9
NMITEM10 項目値10

p_strsortmode

ソートモードとして,次のどちらかを指定します。ソートしない場合はnullオブジェクトまたは空文字("")を指定してください。

パラメータ「p_strsortkey」の指定がnullオブジェクトまたは空文字("")の場合,このパラメータの指定は無視されます。

モード 意味
ASC 昇順
DESC 降順

戻り値

受信ボックス内の案件情報。

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

キー名 意味 オブジェクト種別
blc_inbox_startnum 取得開始位置 Integer
blc_inbox_getnum 取得数 Integer
blc_inbox_total 受信ボックス内の全作業数 Integer
blc_inbox_nmpi_$n 申請ID String
blc_inbox_nmwidef_$n 作業名 String
blc_inbox_nmbp_$n 業務名称 String
blc_inbox_nmupdatewi_$n 更新作業名 String
blc_inbox_cdapplicant_$n 申請者ID String
blc_inbox_nmapplicant_$n 申請者氏名 String
blc_inbox_abapplicantorg_$n 申請者所属組織略称 String
blc_inbox_dtcreate_$n 開始日時 String
blc_inbox_dtarive_$n 到着日時 String
blc_inbox_dtlimit_$n 処理期限 String
blc_inbox_cdwi_$n WorkItemID String
blc_inbox_cdpi_$n ProcessInstanceID String
blc_inbox_cdpart_$n 所有者のユーザID String
blc_inbox_nmparticipant_$n 作業者氏名 String
blc_inbox_nmstatus_$n 案件状態 String
blc_inbox_nmparbelongto_$n 作業者組織略称 String
blc_inbox_cdbeforeparticipant_$n 前回作業者ID String
blc_inbox_nmbeforeparticipant_$n 前回作業者氏名 String
blc_inbox_nmbeforeparticipantbelongto_$n 前回作業者組織略称 String
blc_inbox_dtupdate_$n 前回作業日時 String
blc_inbox_nmitem1_$n 項目値1 String
blc_inbox_nmitem2_$n 項目値2 String
blc_inbox_nmitem3_$n 項目値3 String
blc_inbox_nmitem4_$n 項目値4 String
blc_inbox_nmitem5_$n 項目値5 String
blc_inbox_nmitem6_$n 項目値6 String
blc_inbox_nmitem7_$n 項目値7 String
blc_inbox_nmitem8_$n 項目値8 String
blc_inbox_nmitem9_$n 項目値9 String
blc_inbox_nmitem10_$n 項目値10 String

(凡例)

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


指定したユーザの受信ボックスに作業が存在しない場合でも,キー名「blc_inbox_getnum」に値が0のIntegerオブジェクトが設定されて,正常終了します。

指定したユーザが作業者として登録されているCSCIWの作業が150件以上存在する場合,ソート結果は保証されません。

このメソッドでは,指定したユーザがデータベースに登録されているかどうかに関係なく,指定したユーザの受信ボックスの作業情報が返却されます。このため,データベースから削除したユーザを指定した場合でも,指定したユーザの受信ボックスの作業情報を取得できます。

パラメータ「p_topnum」で指定した取得開始位置が,対象ユーザの受信ボックスの作業総数よりも大きい場合は,次に示す計算式によって取得開始位置が変更された情報が,返却されます。

計算式
取得開始位置
= 1+((受信ボックスの作業総数+取得要求数-1)/取得要求数-1) * 取得要求数

返却された情報の取得開始位置は,キー名「blc_inbox_startnum」の返却値で確認してください。

例外

BLCException

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