CreateForm (Create! FormRemoteObject API)

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

```
public class CreateForm
extends java.lang.Object
```
CreateForm サーバを表現する、全ての操作の基本となるオブジェクトです。コンストラクタは提供されていません。以下のように getInstance() メソッドを使用してオブジェクトを取得する必要があります。
```
 CreateForm server = CreateForm.getInstance();
 
```

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`cleanup()` サーバにクリーンアップ処理を要求します。
`int`	`getConnectionRetry()` CreateForm サーバへの接続の再試行回数を返します。
`int`	`getConnectionTimeout()` CreateForm サーバへの接続タイムアウト時間(単位：ミリ秒)を返します。
`static CreateForm`	`getInstance()` デフォルトの CreateForm サーバインスタンスを返します。
`static CreateForm`	`getInstance(java.lang.String hostname, int port)` 指定された接続情報を使用して CreateForm サーバインスタンスを生成し返します。
`protected java.util.ResourceBundle`	`getResourceBundle()`
`protected void`	`initialize(java.lang.String hostname, int port)`
`boolean`	`isAvailable()` CreateForm 分散実行サーバにアクセス可能な状態かを返します。
`boolean`	`isSSLEnable()` CreateForm サーバへSSL接続する場合は true を返します。
`java.util.List<JobDescriptor>`	`listJobs()` サーバ上に登録されているジョブ ID のリストを返します。
`java.util.List<JobDescriptor>`	`listJobs(java.util.Collection<java.lang.String> keys)` サーバ上に登録されているジョブ ID とプロパティのリストを返します。
`java.util.List<JobDescriptor>`	`listJobs(JobListFilter filter)` サーバ上に登録されているジョブ ID のリストを返します。
`Job`	`lookupJob(java.lang.String jobId)` 指定されたジョブ ID の CreateForm 実行ジョブオブジェクトを取得します。
`static void`	`main(java.lang.String[] args)`
`Job`	`newJob()` CreateForm 実行ジョブを新規に作成します。
`Job`	`newJob(java.lang.String context)` 指定されたコンテキスト情報を使用する CreateForm 実行ジョブを新規に作成します。
`protected Job`	`newJob(java.lang.String context, java.lang.String id)`
`Job`	`newJobWithId(java.lang.String id)` CreateForm 実行ジョブを指定されたジョブ ID を割り当てて新規に作成します。
`Job`	`newJobWithId(java.lang.String context, java.lang.String id)` 指定されたコンテキスト情報を使用する CreateForm 実行ジョブを指定されたジョブ ID を割り当てて新規に作成します。
`void`	`setConnectionRetry(int connectionRetry)` CreateForm サーバへの接続の再試行回数を設定します。
`void`	`setConnectionTimeout(int connectionTimeout)` CreateForm サーバへの接続タイムアウト時間(単位：ミリ秒)を設定します。
`void`	`setSSLEnable(boolean sslEnable)` CreateForm サーバへSSL接続を使用するかどうかを設定します。
`void`	`sonar()` CreateForm 分散実行サーバがアクセス可能な状態かを調べます。

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

- メソッドの詳細
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    例外:
    
    java.lang.Exception
  - getInstance
```
public static CreateForm getInstance()
```
    デフォルトの CreateForm サーバインスタンスを返します。サーバへの接続情報などは createform.properties ファイルから取得されます。
    
    戻り値:
    
    CreateForm インスタンス
  - getInstance
```
public static CreateForm getInstance(java.lang.String hostname,
                                     int port)
```
    指定された接続情報を使用して CreateForm サーバインスタンスを生成し返します。
    
    パラメータ:
    
    hostname - 接続ホスト名
    
    port - 接続ポート番号
    
    戻り値:
    
    CreateForm インスタンス
  - newJob
```
public Job newJob()
           throws RemoteObjectException
```
    CreateForm 実行ジョブを新規に作成します。
    
    戻り値:
    
    CreateForm 実行ジョブオブジェクト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - newJob
```
public Job newJob(java.lang.String context)
           throws RemoteObjectException
```
    指定されたコンテキスト情報を使用する CreateForm 実行ジョブを新規に作成します。
    
    パラメータ:
    
    context - コンテキスト情報
    
    戻り値:
    
    CreateForm 実行ジョブオブジェクト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - newJobWithId
```
public Job newJobWithId(java.lang.String id)
                 throws RemoteObjectException
```
    CreateForm 実行ジョブを指定されたジョブ ID を割り当てて新規に作成します。
    
    パラメータ:
    
    id - ジョブ ID
    
    戻り値:
    
    CreateForm 実行ジョブオブジェクト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - newJobWithId
```
public Job newJobWithId(java.lang.String context,
                        java.lang.String id)
                 throws RemoteObjectException
```
    指定されたコンテキスト情報を使用する CreateForm 実行ジョブを指定されたジョブ ID を割り当てて新規に作成します。
    
    パラメータ:
    
    context - コンテキスト情報
    
    id - ジョブ ID
    
    戻り値:
    
    CreateForm 実行ジョブオブジェクト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - lookupJob
```
public Job lookupJob(java.lang.String jobId)
              throws RemoteObjectException
```
    指定されたジョブ ID の CreateForm 実行ジョブオブジェクトを取得します。該当するジョブがサーバ上に存在しない場合は null を返します。
    
    パラメータ:
    
    jobId - ジョブ ID
    
    戻り値:
    
    CreateForm 実行ジョブ
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - isAvailable
```
public boolean isAvailable()
```
    CreateForm 分散実行サーバにアクセス可能な状態かを返します。
    
    戻り値:
    
    サーバが利用可能な場合は true
  - sonar
```
public void sonar()
           throws RemoteObjectException
```
    CreateForm 分散実行サーバがアクセス可能な状態かを調べます。アクセスできない場合は RemoteObjectException を throw します。
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - listJobs
```
public java.util.List<JobDescriptor> listJobs()
                                       throws RemoteObjectException
```
    サーバ上に登録されているジョブ ID のリストを返します。
    
    戻り値:
    
    ジョブ ID のリスト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - listJobs
```
public java.util.List<JobDescriptor> listJobs(JobListFilter filter)
                                       throws RemoteObjectException
```
    サーバ上に登録されているジョブ ID のリストを返します。
    
    パラメータ:
    
    filter - ジョブ ID を抽出するフィルタ
    
    戻り値:
    
    ジョブ ID のリスト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - listJobs
```
public java.util.List<JobDescriptor> listJobs(java.util.Collection<java.lang.String> keys)
                                       throws RemoteObjectException
```
    サーバ上に登録されているジョブ ID とプロパティのリストを返します。
    
    パラメータ:
    
    keys - 取得するプロパティ名のリスト
    
    戻り値:
    
    ジョブ ID のリスト
    
    例外:
    
    RemoteObjectException - サーバとの接続でエラーが発生した場合
  - cleanup
```
public void cleanup()
             throws RemoteObjectException
```
    サーバにクリーンアップ処理を要求します。
    
    例外:
    
    RemoteObjectException
  - newJob
```
protected Job newJob(java.lang.String context,
                     java.lang.String id)
              throws RemoteObjectException
```
    例外:
    
    RemoteObjectException
  - getResourceBundle
```
protected java.util.ResourceBundle getResourceBundle()
```
  - initialize
```
protected void initialize(java.lang.String hostname,
                          int port)
```
  - isSSLEnable
```
public boolean isSSLEnable()
```
    CreateForm サーバへSSL接続する場合は true を返します。
    
    戻り値:
    
    SSL接続する場合は true
    
    導入されたバージョン:
    
    11.00.0
  - setSSLEnable
```
public void setSSLEnable(boolean sslEnable)
```
    CreateForm サーバへSSL接続を使用するかどうかを設定します。
    
    パラメータ:
    
    sslEnable - SSL接続する場合は true
    
    導入されたバージョン:
    
    11.00.0
  - getConnectionRetry
```
public int getConnectionRetry()
```
    CreateForm サーバへの接続の再試行回数を返します。
    
    戻り値:
    
    接続の再試行回数
    
    導入されたバージョン:
    
    11.00.0
  - setConnectionRetry
```
public void setConnectionRetry(int connectionRetry)
```
    CreateForm サーバへの接続の再試行回数を設定します。 0 以下の数値を設定した場合は接続の再試行を行いません。
    
    パラメータ:
    
    connectionRetry - 接続の再試行回数
    
    導入されたバージョン:
    
    11.00.0
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    CreateForm サーバへの接続タイムアウト時間(単位：ミリ秒)を返します。
    
    戻り値:
    
    接続タイムアウト時間(単位：ミリ秒)
    
    導入されたバージョン:
    
    11.00.0
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    CreateForm サーバへの接続タイムアウト時間(単位：ミリ秒)を設定します。
    
    パラメータ:
    
    connectionTimeout - 接続タイムアウト時間(単位：ミリ秒)
    
    導入されたバージョン:
    
    11.00.0

クラス CreateForm

メソッドのサマリー

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

メソッドの詳細

main

getInstance

getInstance

newJob

newJob

newJobWithId

newJobWithId

lookupJob

isAvailable

sonar

listJobs

listJobs

listJobs

cleanup

newJob

getResourceBundle

initialize

isSSLEnable

setSSLEnable

getConnectionRetry

setConnectionRetry

getConnectionTimeout

setConnectionTimeout