ScriptRunnerResult

java.lang.Object
- com.appresso.ds.common.script.ScriptRunnerResult

すべての実装されたインタフェース:

java.io.Externalizable, java.io.Serializable
```
public final class ScriptRunnerResult
extends java.lang.Object
implements java.io.Externalizable
```
スクリプトの実行結果を表すクラスです。

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`STATUS_COMPONENT_PROCESS_FAILED` コンポーネントの実行に失敗したときに返される終了ステータスです。
`static int`	`STATUS_CONNECTION_ERROR` 接続に失敗したときに返される終了ステータスです。
`static int`	`STATUS_INTERRUPTED` スクリプトの実行が中断されたときに返される終了ステータスです。
`static int`	`STATUS_INVALID_INPUT_PARAM` スクリプトの入力値が不正なときに返される終了ステータスです。
`static int`	`STATUS_READ_TIMEOUT_ERROR` スクリプトが終了する前に、タイムアウトに指定した時間を経過したときに返される終了ステータスです。
`static int`	`STATUS_REQUIRED_CAPABILITY_ABSENT` 操作に必要な権限がないときに返される終了ステータスです。
`static int`	`STATUS_SCRIPT_LOAD_FAILED` スクリプトのロードに失敗したときに返される終了ステータスです。
`static int`	`STATUS_SCRIPT_ROLLEDBACK` スクリプトがロールバックされたときに返される終了ステータスです。
`static int`	`STATUS_SCRIPT_TRANSACTION_FAILED` トランザクションの失敗によりスクリプトの実行が失敗したときに返される終了ステータスです。
`static int`	`STATUS_SUCCEEDED` システム規定のスクリプトの実行成功を表す値です。
`static int`	`STATUS_THREAD_MANAGEMENT_ERROR` スレッド管理で問題が発生したときに返される終了ステータスです。
`static int`	`STATUS_UNEXPECTED_ERROR` 予期しない問題でスクリプトの実行が失敗したときに返される終了ステータスです。
`static int`	`STATUS_UNKNOWN` 特定できない原因でスクリプトの実行が失敗したときに返される終了ステータスです。
`static int`	`THRESHOLD_MAX_USER_EXIT_STATUS` ユーザ定義の終了ステータスの上限値です。
`static int`	`THRESHOLD_MIN_USER_EXIT_STATUS` ユーザ定義の終了ステータスの下限値です。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

ScriptRunnerResult()
コンストラクタです。

コンストラクタ
コンストラクタと説明
`ScriptRunnerResult()` コンストラクタです。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addFailure(java.lang.Throwable t)` 失敗の原因を追加します。
`java.lang.String`	`getExecutionID()` 実行 ID を取得します。
`int`	`getExitStatus()` 終了ステータスを取得します。
`Failure`	`getFailure()` 失敗の内容を取得します。
`java.util.Map`	`getResultData()` 戻り値を取得します。
`ScriptPK`	`getScriptPK()` ScriptPK を取得します。
`boolean`	`isSucceeded()` 実行に成功したかどうかを取得します。
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`setExecutionID(java.lang.String newExecutionID)` 実行 ID を設定します。
`void`	`setExitStatus(int newExitStatus)` 終了ステータスを設定します。
`void`	`setResultData(java.util.Map newResultData)` 戻り値を設定します。
`void`	`setScriptPK(ScriptPK newScriptPK)` ScriptPK を設定します。
`void`	`writeExternal(java.io.ObjectOutput out)`

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

- フィールドの詳細
  - THRESHOLD_MAX_USER_EXIT_STATUS
```
public static final int THRESHOLD_MAX_USER_EXIT_STATUS
```
    ユーザ定義の終了ステータスの上限値です。
    
    関連項目:
    
    定数フィールド値
  - THRESHOLD_MIN_USER_EXIT_STATUS
```
public static final int THRESHOLD_MIN_USER_EXIT_STATUS
```
    ユーザ定義の終了ステータスの下限値です。
    
    関連項目:
    
    定数フィールド値
  - STATUS_SUCCEEDED
```
public static final int STATUS_SUCCEEDED
```
    システム規定のスクリプトの実行成功を表す値です。
    
    関連項目:
    
    定数フィールド値
  - STATUS_COMPONENT_PROCESS_FAILED
```
public static final int STATUS_COMPONENT_PROCESS_FAILED
```
    コンポーネントの実行に失敗したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_SCRIPT_LOAD_FAILED
```
public static final int STATUS_SCRIPT_LOAD_FAILED
```
    スクリプトのロードに失敗したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_INVALID_INPUT_PARAM
```
public static final int STATUS_INVALID_INPUT_PARAM
```
    スクリプトの入力値が不正なときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_SCRIPT_ROLLEDBACK
```
public static final int STATUS_SCRIPT_ROLLEDBACK
```
    スクリプトがロールバックされたときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_INTERRUPTED
```
public static final int STATUS_INTERRUPTED
```
    スクリプトの実行が中断されたときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_SCRIPT_TRANSACTION_FAILED
```
public static final int STATUS_SCRIPT_TRANSACTION_FAILED
```
    トランザクションの失敗によりスクリプトの実行が失敗したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_REQUIRED_CAPABILITY_ABSENT
```
public static final int STATUS_REQUIRED_CAPABILITY_ABSENT
```
    操作に必要な権限がないときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_UNKNOWN
```
public static final int STATUS_UNKNOWN
```
    特定できない原因でスクリプトの実行が失敗したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_UNEXPECTED_ERROR
```
public static final int STATUS_UNEXPECTED_ERROR
```
    予期しない問題でスクリプトの実行が失敗したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_CONNECTION_ERROR
```
public static final int STATUS_CONNECTION_ERROR
```
    接続に失敗したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_THREAD_MANAGEMENT_ERROR
```
public static final int STATUS_THREAD_MANAGEMENT_ERROR
```
    スレッド管理で問題が発生したときに返される終了ステータスです。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
  - STATUS_READ_TIMEOUT_ERROR
```
public static final int STATUS_READ_TIMEOUT_ERROR
```
    スクリプトが終了する前に、タイムアウトに指定した時間を経過したときに返される終了ステータスです。このステータスが返されても、サーバ側でスクリプトが動作している可能性があります。スクリプトの状態はサーバ側で確認する必要があります。値は変更される場合があります。
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - ScriptRunnerResult
```
public ScriptRunnerResult()
```
    コンストラクタです。
- メソッドの詳細
  - getExecutionID
```
public java.lang.String getExecutionID()
```
    実行 ID を取得します。
    
    戻り値:
    
    実行 ID
  - setExecutionID
```
public void setExecutionID(java.lang.String newExecutionID)
```
    実行 ID を設定します。
    
    パラメータ:
    
    newExecutionID - 実行 ID
  - getScriptPK
```
public ScriptPK getScriptPK()
```
    ScriptPK を取得します。
    
    戻り値:
    
    ScriptPK
    
    関連項目:
    
    ScriptPK
  - setScriptPK
```
public void setScriptPK(ScriptPK newScriptPK)
```
    ScriptPK を設定します。
    
    パラメータ:
    
    newScriptPK - ScriptPK
    
    関連項目:
    
    ScriptPK
  - isSucceeded
```
public boolean isSucceeded()
```
    実行に成功したかどうかを取得します。
    
    戻り値:
    
    true の場合は成功，false の場合は失敗
  - getExitStatus
```
public int getExitStatus()
```
    終了ステータスを取得します。終了ステータスは下記のようになっています。
    - 10000 以上 : システム定義成功終了ステータス
    - 1 - 9999 : ユーザ定義成功終了ステータス
    - 0 : システム規定の成功終了ステータス
    - -9999 - -1 : ユーザ定義失敗終了ステータス
    - -10000 以下: システム規定の失敗終了ステータス
    戻り値:
    
    終了ステータス
  - setExitStatus
```
public void setExitStatus(int newExitStatus)
```
    終了ステータスを設定します。
    
    パラメータ:
    
    newExitStatus - 終了ステータス
  - getResultData
```
public java.util.Map getResultData()
```
    戻り値を取得します。
    
    戻り値:
    
    戻り値を格納したマップ
  - setResultData
```
public void setResultData(java.util.Map newResultData)
```
    戻り値を設定します。
    
    パラメータ:
    
    newResultData - 戻り値を格納したマップ
  - getFailure
```
public Failure getFailure()
```
    失敗の内容を取得します。失敗がなかった場合には null が戻ります。
    
    戻り値:
    
    失敗の内容
    
    関連項目:
    
    Failure
  - addFailure
```
public void addFailure(java.lang.Throwable t)
```
    失敗の原因を追加します。
    
    パラメータ:
    
    t - 失敗の原因
    
    関連項目:
    
    Failure
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    定義:
    
    writeExternal インタフェース内 java.io.Externalizable
    
    例外:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    定義:
    
    readExternal インタフェース内 java.io.Externalizable
    
    例外:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

クラス ScriptRunnerResult

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

THRESHOLD_MAX_USER_EXIT_STATUS

THRESHOLD_MIN_USER_EXIT_STATUS

STATUS_SUCCEEDED

STATUS_COMPONENT_PROCESS_FAILED

STATUS_SCRIPT_LOAD_FAILED

STATUS_INVALID_INPUT_PARAM

STATUS_SCRIPT_ROLLEDBACK

STATUS_INTERRUPTED

STATUS_SCRIPT_TRANSACTION_FAILED

STATUS_REQUIRED_CAPABILITY_ABSENT

STATUS_UNKNOWN

STATUS_UNEXPECTED_ERROR

STATUS_CONNECTION_ERROR

STATUS_THREAD_MANAGEMENT_ERROR

STATUS_READ_TIMEOUT_ERROR

コンストラクタの詳細

ScriptRunnerResult

メソッドの詳細

getExecutionID

setExecutionID

getScriptPK

setScriptPK

isSucceeded

getExitStatus

setExitStatus

getResultData

setResultData

getFailure

addFailure

writeExternal

readExternal