Job (Create! FormRemoteObject API)

java.lang.Object
- net.createform.ro.Job

```
public class Job
extends java.lang.Object
```
CreateForm 実行ジョブを表すオブジェクトです。

関連項目:

CreateForm.newJob(), CreateForm.newJob(String), CreateForm.newJobWithId(String), CreateForm.newJobWithId(String, String), CreateForm.lookupJob(String)

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addOpt(java.lang.String key)` CreateForm の実行オプションを追加します。
`void`	`addOpt(java.lang.String key, java.lang.String value)` CreateForm の実行オプションを追加します。
`void`	`clearOpts()` CreateForm の実行オプションを全て削除します。
`JobResult`	`execute()` ジョブを実行します。
`java.lang.String`	`getCommandline()` CreateForm の実行オプション文字列を返します。
`JobDescriptor`	`getDescriptor()` ジョブ ID やプロパティ情報を返します。
`int`	`getExpiration()` 設定されている有効期限日数を返します。
`java.lang.String`	`getId()` ジョブ ID を返します。
`CreateFormMode`	`getMode()` 設定されている CreateForm の実行モードを返します。
`java.lang.String`	`getProperty(java.lang.String key)` プロパティを返します。
`java.lang.String`	`getProperty(java.lang.String key, java.lang.String defaultValue)` プロパティを返します。
`JobResult`	`getResult()` ジョブの実行結果を表す JobResult オブジェクトを返します。
`JobSource`	`getSource()` 入力データソースを表す JobSource オブジェクトを返します。
`JobStatus`	`getStatus()` ジョブの状態を表す JobStatus オブジェクトを返します。
`JobStatus`	`post()` ジョブを実行します。
`void`	`remove()` ジョブの情報をサーバ上から削除します。
`void`	`removeOpt(java.lang.String key)` 指定された CreateForm 実行オプションを削除します。
`void`	`removeProperty(java.lang.String key)` 指定されたプロパティを削除します。
`void`	`setExpiration(int days)` ジョブの有効期限日数を設定します。
`void`	`setMode(CreateFormMode mode)` CreateForm の実行モードを設定します。
`void`	`setOpts(java.lang.String opts)` CreateForm の実行オプション文字列を設定します。
`void`	`setProperty(java.lang.String key, java.lang.String value)` プロパティを登録します。
`JobResult`	`waitResult()` ジョブの実行が終了するまで処理をブロックします。
`JobResult`	`waitResult(long timeout)` ジョブの実行が終了するまで処理をブロックします。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - getDescriptor
```
public JobDescriptor getDescriptor()
```
    ジョブ ID やプロパティ情報を返します。
    
    戻り値:
    
    ジョブ ID やプロパティ情報
  - setProperty
```
public void setProperty(java.lang.String key,
                        java.lang.String value)
```
    プロパティを登録します。
    
    パラメータ:
    
    key - プロパティのキー
    
    value - プロパティの値
  - getProperty
```
public java.lang.String getProperty(java.lang.String key)
```
    プロパティを返します。指定されたキーに該当するプロパティが存在しない場合は null を返します。
    
    パラメータ:
    
    key - プロパティのキー
    
    戻り値:
    
    プロパティの値
  - getProperty
```
public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)
```
    プロパティを返します。指定されたキーに該当するプロパティが存在しない場合は defaultValue を返します。
    
    パラメータ:
    
    key - プロパティのキー
    
    defaultValue - キーが存在しない場合に返す値
    
    戻り値:
    
    プロパティの値
  - removeProperty
```
public void removeProperty(java.lang.String key)
```
    指定されたプロパティを削除します。
    
    パラメータ:
    
    key - 削除するプロパティのキー
  - execute
```
public JobResult execute()
                  throws RemoteObjectException
```
    ジョブを実行します。このメソッドではジョブの実行が終了するまで処理をブロックします。
    
    戻り値:
    
    ジョブの実行結果
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
    
    関連項目:
    
    post()
  - post
```
public JobStatus post()
               throws RemoteObjectException
```
    ジョブを実行します。このメソッドではジョブの実行の終了を待たずに処理を返します。実行結果を取得するためには getResult() や waitResult() メソッドで JobResult オブジェクトを取得する必要があります。
    
    戻り値:
    
    ジョブの状態
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
    
    関連項目:
    
    execute(), getResult(), waitResult(), getStatus()
  - getStatus
```
public JobStatus getStatus()
```
    ジョブの状態を表す JobStatus オブジェクトを返します。
    
    戻り値:
    
    ジョブの状態
  - getResult
```
public JobResult getResult()
                    throws RemoteObjectException
```
    ジョブの実行結果を表す JobResult オブジェクトを返します。
    
    戻り値:
    
    ジョブの実行結果
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - waitResult
```
public JobResult waitResult()
                     throws RemoteObjectException
```
    ジョブの実行が終了するまで処理をブロックします。 post() メソッドと組み合わせて使用します。
    
    戻り値:
    
    ジョブの実行結果
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - waitResult
```
public JobResult waitResult(long timeout)
                     throws RemoteObjectException
```
    ジョブの実行が終了するまで処理をブロックします。 post() メソッドと組み合わせて使用します。
    
    パラメータ:
    
    timeout - タイムアウトまでの時間（ミリ秒）、0 以下の値を指定すると無制限
    
    戻り値:
    
    ジョブの実行結果
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - remove
```
public void remove()
            throws RemoteObjectException
```
    ジョブの情報をサーバ上から削除します。削除されたジョブは CreateForm.lookupJob() メソッドで参照することができなくなります。
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - getId
```
public java.lang.String getId()
```
    ジョブ ID を返します。
    
    戻り値:
    
    ジョブ ID
  - setMode
```
public void setMode(CreateFormMode mode)
```
    CreateForm の実行モードを設定します。
    
    パラメータ:
    
    mode - 実行モード
  - getMode
```
public CreateFormMode getMode()
```
    設定されている CreateForm の実行モードを返します。
    
    戻り値:
    
    実行モード
  - setOpts
```
public void setOpts(java.lang.String opts)
```
    CreateForm の実行オプション文字列を設定します。実行オプション文字列は「-D/path/to/directory -sstylefile」のようなコマンドラインオプション文字列です。
    
    パラメータ:
    
    opts - 実行オプション文字列
  - clearOpts
```
public void clearOpts()
```
    CreateForm の実行オプションを全て削除します。
    
    関連項目:
    
    addOpt(String, String), addOpt(String), setOpts(String), removeOpt(String)
  - addOpt
```
public void addOpt(java.lang.String key,
                   java.lang.String value)
```
    CreateForm の実行オプションを追加します。実行オプション文字列は「-D/path/to/directory -sstylefile」のようなコマンドラインオプション文字列です。使用例：
```
 job.addOpt("s", "stylefile");
 job.addOpt("q", "qdffile");
 
```
    パラメータ:
    
    key - 実行オプションのキー
    
    value - 実行オプションの値
  - addOpt
```
public void addOpt(java.lang.String key)
```
    CreateForm の実行オプションを追加します。実行オプション文字列は「-D/path/to/directory -sstylefile -vum」のようなコマンドラインオプション文字列です。使用例：
```
 job.addOpt("vum");
 
```
    パラメータ:
    
    key - 実行オプションのキー
  - removeOpt
```
public void removeOpt(java.lang.String key)
```
    指定された CreateForm 実行オプションを削除します。実行オプション文字列は「-D/path/to/directory -sstylefile」のようなコマンドラインオプション文字列です。使用例：
```
 job.removeOpt("o"); // "-o" オプションを削除
 
```
    パラメータ:
    
    key - 削除するプロパティのキー
  - getCommandline
```
public java.lang.String getCommandline()
```
    CreateForm の実行オプション文字列を返します。実行オプション文字列は「-D/path/to/directory -sstylefile」のようなコマンドラインオプション文字列です。
    
    戻り値:
    
    実行オプション文字列
  - getSource
```
public JobSource getSource()
```
    入力データソースを表す JobSource オブジェクトを返します。
    
    戻り値:
    
    JobSource オブジェクト
  - setExpiration
```
public void setExpiration(int days)
```
    ジョブの有効期限日数を設定します。「0」が指定された場合、そのジョブの再実行は行えません。「-1」が指定された場合、無期限に再実行が可能となります。
    
    パラメータ:
    
    days - 有効期限日数
  - getExpiration
```
public int getExpiration()
```
    設定されている有効期限日数を返します。
    
    戻り値:
    
    有効期限日数

クラス Job

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

getDescriptor

setProperty

getProperty

getProperty

removeProperty

execute

post

getStatus

getResult

waitResult

waitResult

remove

getId

setMode

getMode

setOpts

clearOpts

addOpt

addOpt

removeOpt

getCommandline

getSource

setExpiration

getExpiration