3.7.14 setHoldAttrメソッド
(1) 説明
取得したいユニットの保留状態を設定します。
メソッドを呼び出さなかった場合は,「NO(保留予定を検索条件にしない)」(デフォルト)となります。
(2) 形式
public void setHoldAttr(HoldAttr holdAttr)
(3) 実行権限
なし。
(4) 引数
引数名 |
省略 |
説明 |
---|---|---|
holdAttr |
不可 |
取得したいユニットの保留状態を定数で指定します。 指定できる値と内容については,「付録A.6 (6)HoldAttr」を参照してください。 デフォルト(メソッドを呼び出さなかった場合)は,「NO(保留予定を検索条件にしない)」となります。 |
(5) 戻り値
なし。
(6) 例外
なし。
(7) 注意事項
-
ユニットの保留状態を設定した場合は,待ち状態の世代だけでなく,保留中の世代,および実行が終了した世代も検索対象になります。実行が終了した世代も検索対象になるため,再実行した場合に保留される世代についても検索できます。
-
待ち状態の世代だけ,実行が終了した世代だけ,または特定の世代だけを検索対象にしたい場合は,setGenerationメソッドやsetStatusメソッドで同時に設定して,検索対象の世代を特定して検索してください。