jp.ne.mki.wedge.rule.common.value
クラス PutOptionalData

java.lang.Object
  |
  +--jp.ne.mki.wedge.rule.base.AbstractBase
        |
        +--jp.ne.mki.wedge.rule.base.AbstractCommon
              |
              +--jp.ne.mki.wedge.rule.common.value.PutOptionalData

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

CommonInterface, RuleEngineInterface

public class PutOptionalData

extends AbstractCommon

OptionalDataの設定

OptionalDataを設定します。
OptionalDataは、各エンジン間でデータの送受信を行うための、
ビジネスルールとなります。
(VisualFrameの場合、PostNameMatch等を使用した時に、
自動的にその値を HttpRequestに設定をする形となります。)

パラメータには 設定したOptionalDataをどのエンジンに送信するか…を指定します。
MODULE_RUNAPSERVERを指定した場合は RunApServerへ、
MODULE_RUNDBSERVERを指定した場合は RunDBServerへ向けて、
データを送信することとなります。
(RunDBServerに送信をするときは、RunApServerを経由するため、
RunApServer内でもそのデータを取得することが可能です。)
宛先を特定せず、全てのエンジンに受け渡したい場合は、
MODULE_ALLを指定することも可能です。

[I/O RECORD]

InputRecord	OutputRecord
設定するデータ(複数指定)

[RULE PARAMETER]

Parameter	■ 送信先の指定 ALL RUNCLIENT RUNAPSERVER RUNDBSERVER HTMLGATEWAY RUNSERVLET RUNBATCHSERVER ■ VisualFrameの場合 REQUEST_HEADER REQUEST_BODY

バージョン:

1.2.0

フィールドの概要

(パッケージプライベート) int

target

クラス jp.ne.mki.wedge.rule.base.AbstractBase から継承したフィールド

controlRecord, engineManager, errorMessage, executeType, id, inputRecord, logicalName, outputRecord, physicalName, ruleParameter, ruleType, serverParameter, userConstant

インタフェース jp.ne.mki.wedge.rule.base.interfaces.CommonInterface から継承したフィールド

CANCEL, ERROR, EXECUTE_BOTH, EXECUTE_CLIENT, EXECUTE_DEBUG, EXECUTE_HTMLGATEWAY, EXECUTE_SERVER, EXECUTE_SERVERDC, IO_ERROR, IO_ERROR_EXECUTE_PARAMETER, IO_ERROR_IN, IO_ERROR_IO_MUST_SAME_COUNT, IO_ERROR_ITEM_TYPE, IO_ERROR_OUT, IO_ERROR_PARAMETER, NONE, OK, PARAMETER_DELIMITER, SKIP, USER_ERROR

コンストラクタの概要

PutOptionalData()

メソッドの概要

int	execute() 処理を実行。
void	exit() 終了処理。
int	getIOParameter() IOパラメータ取得。

クラス jp.ne.mki.wedge.rule.base.AbstractCommon から継承したメソッド

getManager, log, setHtmlManager, setManager, setServerControlData, setWedgeLog, showErrorDialog, terminate, writeErrorLog, writeLog, writeLog, writeLog

クラス jp.ne.mki.wedge.rule.base.AbstractBase から継承したメソッド

callDispose, createErrorMessage, dataClearOfOutRecord, dataClearOfRecord, dispose, executeRule, getAppAccount, getAppAuthority, getAppMenu, getAppPassword, getClassErrorName, getClientId, getConnectionId, getConnectionPoolId, getConstantKeys, getConstantValue, getConstantValueAsStringArray, getDbAccessCount, getDbErrorCode, getDbErrorMessage, getDbStatus, getDbUpdatedRecordCount, getEngineManager, getErrorMessage, getErrorMessage, getErrorMessage, getExceptionMessage, getExecuteType, getId, getInRecord, getInRecord, getInRecord, getInRecordCount, getIpAddress_G_Index, getIpAddress_P_Index, getLogicalErrorName, getLogicalName, getOutputHtml, getOutRecord, getOutRecord, getOutRecord, getOutRecordCount, getPhysicalErrorName, getPhysicalName, getProjectId, getQueryEndLine, getQueryMaxCount, getQueryPageCount, getQueryStartLine, getReturnString, getRowSize, getRowSizeOfInRecord, getRuleParameter, getRuleParameters, getRuleParameters, getRuleParameters, getRuleType, getRuleTypeName, getServerMessage, getServerParameter, getServerStatus, getServerSubName, getServerSubRevision, getServerTran, getUpdateErrorLine, getUpdateTargetCount, getWebServerIpAddress, isExecutable, isJDK15, logDebug, logError, logError, logFatal, logFatal, logInfo, logTrace, logWarn, logWarn, loopInOutRecord, loopInOutRecordSub, loopInRecord, loopInRecordSub, loopOutRecord, loopOutRecordSub, setControlRecord, setErrorMessage, setErrorMessageMustInRecord, setErrorMessageMustOutRecord, setErrorMessageMustParamIsNumber, setExecuteType, setFatalError, setId, setInRecord, setLogicalName, setOutputHtml, setOutRecord, setPhysicalName, setPropertyFromEngine, setRuleParameter, setRuleType, setServerParameter, setUserConstant, showErrorDialogAddRuleName, writeTraceLog

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

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

target

int target

コンストラクタの詳細

PutOptionalData

public PutOptionalData()

メソッドの詳細

getIOParameter

public int getIOParameter()
                   throws java.lang.Throwable

インタフェース CommonInterface の記述:

IOパラメータ取得。execute の前に実行される。

インタフェース jp.ne.mki.wedge.rule.base.interfaces.CommonInterface からコピーされたタグ:

戻り値:

int OK=処理続行、IO_ERROR=入出力レコードエラー、IO_ERROR_IN=入力レコードエラー、IO_ERROR_OUT=出力レコードエラー、 IO_ERROR_IO_MUST_SAME_COUNT=入力レコード数と出力レコー数の非合致エラー、IO_ERROR_PARAMETER=パラメータエラー、 IO_ERROR_EXECUTE_PARAMETER=実行リストパラメータエラー

execute

public int execute()
            throws java.lang.Throwable

インタフェース CommonInterface の記述:

処理を実行。

インタフェース jp.ne.mki.wedge.rule.base.interfaces.CommonInterface からコピーされたタグ:

戻り値:

int OK=処理続行、ERROR=異常終了、CANCEL=処理を中断(正常終了)、SKIP=次行を実行しない、USER_ERROR=戻り値をユーザ側で任意に設定

exit

public void exit()
          throws java.lang.Throwable

インタフェース CommonInterface の記述:

終了処理。保持していた変数などを開放する処理を記述します。
execute の後に実行されます。
正常終了・異常終了などに関わらず必ず実行されます。