IM-ERP Real Connect

BapiControllerオブジェクト

コンポーネント情報
since	5.0

コンポーネント概要

BAPIコントローラクラス。

ソリューション特化型APIにて設定されたBAPI処理実行パラメータを保持し、
BAPI実行時はプロパティファイル設定の内容に従ってJCOパラメータに展開します｡
展開後、BAPI処理を実行し、実行結果を保持します｡
ソリューション特化型APIは、実行結果を当クラスの公開アクセサメソッドを
使用して取得します｡

コンストラクタの概要

BapiController (String `propertyName`) コンストラクタ。
BapiController (String `propertyName`, ConnectionManager `connectionManager`) コンストラクタ。
BapiController (String `propertyName`, SapClient `sapClient`) コンストラクタ。

メソッドの概要

返却値の型	メソッド名
void	addAutoCommitCondition (String `autoCommitConditon`) 非推奨オートコミットさせる条件を指定します。 addIgnoreErrMsgReturnType()に置き換えられました。
void	addIgnoreErrMsgReturnType (String `ignoreErrMsgReturnType`) エラーメッセージを無視するRETURN-TYPEを追加します。
void	clear () セットしたパラメータ、ストラクチャ、テーブル、
Object	executeBapi () BAPI処理を実行します。
Array	getAutoCommitConditions () 非推奨オートコミットさせる条件を取得します。 getIgnoreErrMsgReturnTypes()に置き換えられました。
String	getErrCode () コンストラクタでエラー時のエラーコードを取得します。
String	getErrDesc () コンストラクタでエラー時の実行時エラー内容を取得します。
Object	getErrMessage () ＢＡＰＩの実行結果のエラーメッセージを取得します。
String	getErrMsg () コンストラクタでエラー時のエラーメッセージを取得します。
Object	getExportParam (String `key`) export(Export)情報を返します。
Array	getIgnoreErrMsgReturnTypes () エラーメッセージを無視するRETURN-TYPEを取得します。
Object	getMessage () 設定されたエラーメッセージを無視するRETURN-TYPE情報に一致したメッセージ情報を全て返します。
Object	getMessage (String `type`) 引数に一致したType情報のメッセージ情報全て取得します。
Array	getReturnCodeTypes () BapiReturn のType情報を取得します。
Object	getReturnList () ＢＡＰＩ実行結果の一覧を取得します。(Table用)
Object	getReturn () ＢＡＰＩ実行結果を取得します。(Structure用)
Object	getStructureParam (String `paramName`) structure(Export)情報を返します。
Object	getTableParam (String `paramName`) table(Export)情報を返します。
Object	isSuccess () ＢＡＰＩ実行が正常に行われたか判定します。
Object	putImportParam (String `key`, String `val`) BAPI処理実行パラメータを格納します。
Object	putStructParam (String `key`, String `val`, String `structName`) BAPI処理実行パラメータを格納します。
Object	putTableParam (String `key`, String `val`, String `tableName`, Number `recordNo`) BAPI処理実行パラメータを格納します。
void	setAutoCommitConditions (Array `autoCommitConditions`) 非推奨オートコミットさせる条件を指定します。 setIgnoreErrMsgReturnTypes()に置き換えられました。
void	setIgnoreErrMsgReturnTypes (Array `ignoreErrMsgReturnTypes`) エラーメッセージを無視するRETURN-TYPEを設定します。

コンストラクタの詳細

BapiController (String propertyName)

コンストラクタ。

パラメータ

propertyName : String: BAPIコントローラが使用するプロパティファイル名

BapiController (String propertyName, ConnectionManager connectionManager)

コンストラクタ。

ConnectionManagerを使用することで、ConnectionManagerからトランザクションを制御でき、たとえば同一トランザクション内で複数の登録・更新処理を実行することができます。
なお、BapiController#executeBapi()実行後に必ずConnectionManager#commit() またはConnectionManager#rollback()を実行してください。
上記2メソッド内でSAPへのコネクションの開放も実行されるので確実にどちらかのメソッドを呼ぶようにコーディングする必要があります。

【注意】トランザクション制御が記述されているBAPIもあります。その場合、BapiController#executeBapi()実行後にここまでのコネクションマネージャーで実行したすべての処理が commitまたはrollbackされます。
※ただし、コネクションはリリースされませんので、リリースされるようにConnectionManager#commit()または ConnectionManager#rollback()を実行してください。
この振る舞いを変更するには、BAPI自体をカスタマイズする必要があります。

パラメータ

propertyName : String: BAPIコントローラが使用するプロパティファイル名

connectionManager : ConnectionManager: コネクションマネージャー

BapiController (String propertyName, SapClient sapClient)

コンストラクタ。

SapClientを使用することで、任意の接続先へ登録・更新処理を実行することができます。
なお、任意の接続先へ１トランザクション内の複数APIを処理したい場合は、 ConnectionManager#を参照して下さい。

【注意】トランザクション制御が記述されているBAPIもあります。その場合、BapiController#executeBapi()実行後にここまでのコネクションマネージャーで実行したすべての処理が commitまたはrollbackされます。
この振る舞いを変更するには、BAPI自体をカスタマイズする必要があります。

パラメータ

propertyName : String: BAPIコントローラが使用するプロパティファイル名

sapClient : SapClient: Sapクライアント

メソッドの詳細

void addAutoCommitCondition (String autoCommitConditon) 非推奨

addIgnoreErrMsgReturnType()に置き換えられました。

オートコミットさせる条件を指定します。

BapiReturn のType情報に対して、オートコミットさせる文字列の条件を設定します。

パラメータ

autoCommitConditon : String: オートコミットさせる条件

返却値

void

void addIgnoreErrMsgReturnType (String ignoreErrMsgReturnType)

エラーメッセージを無視するRETURN-TYPEを追加します。

BapiReturn のType情報に対して、エラーメッセージを無視するRETURN-TYPEを設定します。

パラメータ

ignoreErrMsgReturnType : String: エラーメッセージを無視するRETURN-TYPE値

返却値

void

void clear ()

セットしたパラメータ、ストラクチャ、テーブル、 BAPIの実行結果をクリアします。

返却値

void

Object executeBapi ()

BAPI処理を実行します。

JCO.Connectionを生成し､JCO.Functionの生成、
BAPI引渡しパラメータの生成を行いBAPI処理を実行します｡
またBAPI実行結果から、BapiHashオブジェクトの生成とBapiHashListへの追加、
BapiReturnオブジェクトの生成とBapiReturnListへの追加を行います｡

なお、このクラスのコンストラクタ呼び出し時にConnectionManagerを指定した場合、トランザクション処理は自動的に実行されません。呼び出し側で明示的にConnectionManager#commit() またはConnectionManager#rollbackを実行する必要があります。また、SAPとのコネクションも上記2メソッド内で行われますので、確実に呼び出すように実装しなくてはなりません。

【注意】ConnectionManagerを指定した場合の注意点

トランザクション制御が記述されているBAPIもあります。その場合、本メソッド実行後にここまでのコネクションマネージャーで実行したすべての処理がcommitまたはrollbackされます。
※ただし、コネクションはリリースされませんので、リリースされるようにConnectionManager#commit()または ConnectionManager#rollback()を実行してください。
この振る舞いを変更するには、BAPI自体をカスタマイズする必要があります。

返却値

Object

Object 空文字列 ""
（成功時の返却値は String になります。）

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 1：認証系システムエラー 2：認証系アプリケーションエラー 3：汎用系システムエラー 4：汎用系アプリケーションエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Array getAutoCommitConditions () 非推奨

getIgnoreErrMsgReturnTypes()に置き換えられました。

オートコミットさせる条件を取得します。

BapiReturn のType情報に対して、オートコミットさせる文字列からなる条件を取得します。

返却値

Array: Array オートコミットさせる条件 (文字列の要素からなるArrayオブジェクト)

String getErrCode ()

コンストラクタでエラー時のエラーコードを取得します。

コンストラクタでエラーが発生した場合のエラーコードを取得します。
コンストラクタでエラーが発生しなかった場合は、常に "0" を返します。

エラーコード表

エラーコード	説明
"1"	認証系システムエラー
"2"	認証系アプリケーションエラー
"3"	汎用系システムエラー

返却値

String: String エラーコード

String getErrDesc ()

コンストラクタでエラー時の実行時エラー内容を取得します。

コンストラクタでエラーが発生した場合の実行時エラー内容を取得します。
コンストラクタでエラーが発生しなかった場合は、常に null を返します。

返却値

String: String 実行時エラー内容

Object getErrMessage ()

ＢＡＰＩの実行結果のエラーメッセージを取得します。

ＢＡＰＩ実行結果であるBapiReturnのType情報が正常(デフォルト値: "S" / "")以外の BapiReturnオブジェクトのメッセージ情報を全て返します。
全て正常の場合はnullが返却されます｡正常と判断させる条件はプロパティファイル、またはsetIgnoreErrMsgReturnTypes(Array), addIgnoreErrMsgReturnType(String)でカスタマイズできます。

返却値

Object

Object SAPのエラーメッセージ
（成功時の返却値は String になります。）

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

String getErrMsg ()

コンストラクタでエラー時のエラーメッセージを取得します。

コンストラクタでエラーが発生した場合のエラーメッセージを取得します。
コンストラクタでエラーが発生しなかった場合は、常に null を返します。

返却値

String: String エラーメッセージ

Object getExportParam (String key)

export(Export)情報を返します。

入力／出力区分、パラメータ属性、パラメータ名、プロパティファイルのキー情報で
一覧から該当するBapiHashオブジェクトを検索して、値を返します｡

パラメータ

key : String: 検索条件となるPropertyKey

返却値

Object

Object 引数のキーに対応する値
（成功時の返却値は String になります。）

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Array getIgnoreErrMsgReturnTypes ()

エラーメッセージを無視するRETURN-TYPEを取得します。

BapiReturn のType情報に対して、エラーメッセージを無視するRETURN-TYPEを取得します。

返却値

Array: Array エラーメッセージを無視するRETURN-TYPE値のリスト

Object getMessage ()

設定されたエラーメッセージを無視するRETURN-TYPE情報に一致したメッセージ情報を全て返します。

ＢＡＰＩ実行結果であるBapiReturnのType情報が正常(デフォルト値: "S" / "")と判断されたType情報のメッセージ情報を全て返します。

メッセージは、以下のように、オートコミット条件に設定されたType情報に一致した各メッセージが MESSAGE1, MESSAGE2と改行文字で区切られた形式になります。

MESSAGE1 : メッセージ1

MESSAGE2 : メッセージ2

メッセージがない場合、nullが返却されます｡

返却値

Object

Object オートコミット条件に一致したType情報のメッセージ情報
（成功時の返却値は String になります。）

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Object getMessage (String type)

引数に一致したType情報のメッセージ情報全て取得します。

ＢＡＰＩの実行結果において、引数に一致するType情報のメッセージ情報を全て返します。メッセージは、以下のように、一致したType情報の各メッセージが MESSAGE1, MESSAGE2と改行文字で区切られた形式になります。

MESSAGE1 : メッセージ1

MESSAGE2 : メッセージ2

メッセージがない場合、nullが返却されます｡

引数に指定するType情報は、一般に以下のようになります。

S：正常終了
W：警告
I：情報
E：エラー

※上記のType情報は、BAPIに依存します。

パラメータ

type : String: エラーコードタイプ

返却値

Object

Object 引数で指定したタイプ情報のBAPI実行時のメッセージ情報
（成功時の返却値は String になります。）

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Array getReturnCodeTypes ()

BapiReturn のType情報を取得します。

BapiReturn のType情報を文字列の要素からなるArrayオブジェクトを取得します。
BapiReturn のType情報は、一般的に以下となります。

S：正常終了
W：警告
I：情報
E：エラー

※上記のBapiReturn のType情報は、BAPIに依存します。

返却値

Array: Array のType情報

Object getReturnList ()

ＢＡＰＩ実行結果の一覧を取得します。(Table用)

table型のBAPI実行結果（RETURNパラメータ）の一覧を取得します。

返却値

Object

Object BAPI実行結果（RETURNパラメータ）が格納された配列
（成功時の返却値は Array になります。）

BAPI実行結果情報オブジェクトの構成は以下のとおりです。

BAPI実行結果情報オブジェクト (Object)	TYPE メッセージタイプ (String)
	ID メッセージクラス (String)
	CODE メッセージコード (String)
	NUMBER メッセージ番号 (String)
	MESSAGE メッセージテキスト (String)
	LOG_NO ログ番号 (String)
	LOG_MSG_NO メッセージシリアル番号 (String)
	MESSAGE_V1 メッセージ変数 (String)
	MESSAGE_V2 メッセージ変数 (String)
	MESSAGE_V3 メッセージ変数 (String)
	MESSAGE_V4 メッセージ変数 (String)
	PARAMETER パラメータ名 (String)
	ROW パラメータの行 (String)
	FIELD パラメータの項目 (String)
	SYSTEM メッセージが発行された論理システム (String)

取得した銀行情報オブジェクトの配列は、２次元配列になっています。
値を取得する際に指定する配列のキー値は以下の通りです。

[idx]["TYPE"]　→　配列内のidx番目のBAPI実行結果の「メッセージType」
[idx]["ID"]　→　配列内のidx番目のBAPI実行結果の「メッセージクラス」
[idx]["CODE"]　→　配列内のidx番目のBAPI実行結果の「メッセージコード」
[idx]["NUMBER"]　→　配列内のidx番目のBAPI実行結果の「メッセージ番号」
[idx]["MESSAGE"]　→　配列内のidx番目のBAPI実行結果の「メッセージテキスト」
[idx]["LOG_NO"]　→　配列内のidx番目のBAPI実行結果の「ログ番号」
[idx]["LOG_MSG_NO"]　→　配列内のidx番目のBAPI実行結果の「メッセージシリアル番号」
[idx]["MESSAGE_V1"]　→　配列内のidx番目のBAPI実行結果の「メッセージ変数」
[idx]["MESSAGE_V2"]　→　配列内のidx番目のBAPI実行結果の「メッセージ変数」
[idx]["MESSAGE_V3"]　→　配列内のidx番目のBAPI実行結果の「メッセージ変数」
[idx]["MESSAGE_V4"]　→　配列内のidx番目のBAPI実行結果の「メッセージ変数」
[idx]["PARAMETER"]　→　配列内のidx番目のBAPI実行結果の「パラメータ名」
[idx]["ROW"]　→　配列内のidx番目のBAPI実行結果の「パラメータの行」
[idx]["FIELD"]　→　配列内のidx番目のBAPI実行結果の「パラメータの項目」
[idx]["SYSTEM"]　→　配列内のidx番目のBAPI実行結果の「メッセージが発行された論理システム」

※ idxは0～n （配列サイズ-1）

Object getReturn ()

ＢＡＰＩ実行結果を取得します。(Structure用)

structure型のBAPI実行結果（RETURNパラメータ）を取得します。

返却値

Object

BAPI実行結果情報オブジェクト (Object)	TYPE メッセージタイプ (String)
	ID メッセージクラス (String)
	CODE メッセージコード (String)
	NUMBER メッセージ番号 (String)
	MESSAGE メッセージテキスト (String)
	LOG_NO ログ番号 (String)
	LOG_MSG_NO メッセージシリアル番号 (String)
	MESSAGE_V1 メッセージ変数 (String)
	MESSAGE_V2 メッセージ変数 (String)
	MESSAGE_V3 メッセージ変数 (String)
	MESSAGE_V4 メッセージ変数 (String)
	PARAMETER パラメータ名 (String)
	ROW パラメータの行 (String)
	FIELD パラメータの項目 (String)
	SYSTEM メッセージが発行された論理システム (String)

Object getStructureParam (String paramName)

structure(Export)情報を返します。

入力／出力区分、パラメータ属性、パラメータ名で、
一覧から該当するBapiHashオブジェクトを検索して返します｡

パラメータ

paramName : String: 検索条件となるParamName

返却値

Object

Object 検索結果となるBapiHash
存在しない場合はnullを返します。

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Object getTableParam (String paramName)

table(Export)情報を返します。

入力／出力区分、パラメータ属性、パラメータ名で、
一覧から該当するBapiHashオブジェクトを検索し、一覧に格納して返します｡

パラメータ

paramName : String: 検索条件となるParamName

返却値

Object

Object 検索結果となるBapiHash

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Object isSuccess ()

ＢＡＰＩ実行が正常に行われたか判定します。

ＢＡＰＩ実行結果であるBapiReturnのType情報が正常(S)であった場合"true"を、
それ以外は"false"を返します｡

返却値

Object

Object 処理結果判定
（成功時の返却値は Boolean になります。）

（失敗時） Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Object putImportParam (String key, String val)

BAPI処理実行パラメータを格納します。

引数に指定された条件でBapiHashオブジェクト
(入力／出力区分="import", パラメータ属性="import") を生成し､
一覧に格納します｡

パラメータ

key : String: BapiHashに設定するHashMapのキー

val : String: BapiHashに設定するHashMapの値

返却値

Object

Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー 4：汎用系アプリケーションエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Object putStructParam (String key, String val, String structName)

BAPI処理実行パラメータを格納します。

引数に指定された条件でBapiHashオブジェクト
(入力／出力区分="import", パラメータ属性="structure",パラメータ名=第３引数)を生成し､
一覧に格納します｡

パラメータ

key : String: BapiHashに設定するHashMapのキー

val : String: BapiHashに設定するHashMapの値

structName : String: BapiHashに設定するparamTypeの値

返却値

Object

Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー 4：汎用系アプリケーションエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

Object putTableParam (String key, String val, String tableName, Number recordNo)

BAPI処理実行パラメータを格納します。

引数に指定された条件でBapiHashオブジェクト
(入力／出力区分="import", パラメータ属性="table",パラメータ名=第３引数,レコード番号=第４引数)を生成し､
一覧に格納します｡

パラメータ

key : String: BapiHashに設定するHashMapのキー

val : String: BapiHashに設定するHashMapの値

tableName : String: BapiHashに設定するparamTypeの値

recordNo : Number: BapiHashに設定するrecordNoの値

返却値

Object

Object エラー情報オブジェクト

エラー情報オブジェクトの構成は以下のとおりです。

エラー情報オブジェクト (Object)	ERR_CODE エラーコード (String) 3：汎用系システムエラー 4：汎用系アプリケーションエラー詳細はjp.co.intra_mart.system.javascript.sapapi.ErrorJSHandler# をご覧ください。
	ERR_MSG アプリケーション例外(システム例外)のメッセージ概要 (String)
	ERR_DESC システム例外のメッセージ詳細 (String)

void setAutoCommitConditions (Array autoCommitConditions) 非推奨

setIgnoreErrMsgReturnTypes()に置き換えられました。

オートコミットさせる条件を指定します。

BapiReturn のType情報に対して、オートコミットさせる文字列条件を設定します。 autoCommitConditionsのArrayオブジェクトの各要素はString型です。

パラメータ

autoCommitConditions : Array: オートコミットさせる条件リスト (文字列の要素からなるArrayオブジェクト)

返却値

void

void setIgnoreErrMsgReturnTypes (Array ignoreErrMsgReturnTypes)

エラーメッセージを無視するRETURN-TYPEを設定します。

BapiReturn のType情報に対して、エラーメッセージを無視するRETURN-TYPEを設定します。この設定を変更することで、たとえば警告時にもコミットさせることができます。 ignoreErrMsgReturnTypesのArrayオブジェクトの各要素の型は文字列(String)です。

パラメータ

ignoreErrMsgReturnTypes : Array: エラーメッセージを無視するRETURN-TYPE値のリスト (文字列の要素からなるArrayオブジェクト)

返却値

void