Hitachi

JP1 Version 10 JP1/Automatic Job Management System 3 - Software Development Kit APIリファレンス


3.7.4 setSearchTargetメソッド

〈この項の構成〉

(1) 説明

取得対象の範囲を設定します。

メソッドを呼び出さなかった場合は,「DEFINITION_AND_STATUS(定義と状態)」(デフォルト)となります。

(2) 形式

public void setSearchTarget(SearchTargetType searchTarget)

(3) 実行権限

なし。

(4) 引数

引数名

省略

説明

searchTarget

不可

取得対象の範囲を指定します。

ユニットの定義だけを取得対象とするか,ユニットの実行状態や世代数などを考慮して,ユニットの定義および状態を取得対象とするかを設定します。

指定できる値と内容については,「付録A.6 (8)SearchTargetType」を参照してください。

デフォルト(メソッドを呼び出さなかった場合)は,「DEFINITION_AND_STATUS(定義と状態)」となります。

なお,「DEFINITION(定義)」を指定した場合は,次のユニット状態に関する設定は無視されます。

(5) 戻り値

なし。

(6) 例外

なし。