intra-mart(R)
5.0

jp.co.intra_mart.foundation.sap.common.general_purpose
クラス BapiController

java.lang.Object
  拡張jp.co.intra_mart.foundation.sap.common.general_purpose.BapiController
すべての実装インタフェース:
Serializable

public class BapiController
extends Object
implements Serializable

BAPIコントローラクラス
機能は以下の通り

関連項目:
直列化された形式

コンストラクタの概要
BapiController(String propertyName)
          プロパティファイル名のメンバ変数への設定、プロパティファイルの読込と 各PropertyListの生成処理を行います。
BapiController(String propertyName, ConnectionManager connectionManager)
          コネクションマネージャのセット、 プロパティファイル名のメンバ変数への設定、プロパティファイルの読込と 各PropertyListの生成処理を行います。
 
メソッドの概要
 void clear()
           セットしたパラメータ、ストラクチャ、テーブル、BAPIの実行結果をクリアします。
 void executeBapi()
          BAPI実行部のメソッド。JCO.Connectionを生成し、JCO.Functionの生成、 BAPI引渡しパラメータの生成を行いBAPI実行を行います。またBAPI実行結果から BapiHashオブジェクトの生成とBapiHashListへの追加、 BapiReturnオブジェクトの生成とBapiReturnListへの追加を行います。
なお、このクラスのコンストラクタ呼び出し時にConnectionManagerを指定した場合、 トランザクション処理は自動的に実行されません。
 ArrayList getBapiHashList()
          BapiHashの一覧を取得します。
 ArrayList getBapiReturnList()
          BapiReturnの一覧を取得します。
 String getErrMessage()
          BAPIの実行結果でBapiReturnのType情報が正常("S" / "")以外のBapiReturn オブジェクトのメッセージ情報を全て返します。
 ArrayList getExpExpList()
          プロパティ情報(export(Export))の一覧を取得します。
 String getExportParam(String propKey)
          export(Export)情報を返します。
 ArrayList getExpStrList()
          プロパティ情報(structure(Export))の一覧を取得します。
 ArrayList getExpTblList()
          プロパティ情報(table(Export))の一覧を取得します。
 ArrayList getImpImpList()
          プロパティ情報(import(Import))の一覧を取得します。
 ArrayList getImpStrList()
          プロパティ情報(structure(Import))一覧を取得します。
 ArrayList getImpTblList()
          プロパティ情報(table(Import))の一覧を取得します。
 Properties getProperty()
          プロパティファイル情報を取得します。
 String getPropertyName()
          プロパティファイル名を取得します。
 BapiReturn getReturn()
          BAPI実行結果を取得します。
 Iterator getReturnList()
          BAPI実行結果の一覧を取得します。
 HashMap getStructureParam(String paramName)
          structure(Export)情報を返します。
 Iterator getTableParam(String paramName)
          table(Export)情報を返します。
 boolean isSuccess()
          BAPI実行が正常に行われたか判定します。BAPI実行結果であるBapiReturn のType情報が正常("S" / "")であった場合"true"をそれ以外は"false"を返します。
 void putImportParam(String key, String val)
          引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import", パラメタ属性="import")を生成し、一覧に格納します。
 void putStructParam(String key, String val, String structName)
          引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import", パラメタ属性="structure",パラメタ名=第3引数)を生成し、一覧に格納します。
 void putTableParam(String key, String val, String tableName, int recordNo)
          引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import", パラメタ属性="table",パラメタ名=第3引数,レコード番号=第4引数)を生成し、 一覧に格納します。
 void setBapiHashList(ArrayList bapiHashList)
          BapiHashの一覧を設定します。
 void setBapiReturnList(ArrayList bapiReturnList)
          BapiReturnの一覧を設定します。
 void setExpExpList(ArrayList expExpList)
          プロパティ情報(export(Export))の一覧を設定します。
 void setExpStrList(ArrayList expStrList)
          プロパティ情報(structure(Export))の一覧を設定します。
 void setExpTblList(ArrayList expTblList)
          プロパティ情報(table(Export))の一覧を設定します。
 void setImpImpList(ArrayList impImpList)
          プロパティ情報(import(Import))の一覧を設定します。
 void setImpStrList(ArrayList impStrList)
          プロパティ情報(structure(Import))の一覧を設定します。
 void setImpTblList(ArrayList impTblList)
          プロパティ情報(table(Import))の一覧を設定します。
 void setProperty(Properties property)
          プロパティファイル情報を設定します。
 void setPropertyName(String propertyName)
          プロパティファイル名を設定します。
 String toString()
          デバッグ用のメソッドです。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

BapiController

public BapiController(String propertyName,
                      ConnectionManager connectionManager)
               throws SAPGeneralSystemException,
                      SAPAuthSystemException,
                      SAPGeneralAppException
コネクションマネージャのセット、 プロパティファイル名のメンバ変数への設定、プロパティファイルの読込と 各PropertyListの生成処理を行います。

パラメータ:
propertyName - BAPIコントローラが使用するプロパティファイル名
connectionManager - コネクション管理オブジェクト
例外:
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外

BapiController

public BapiController(String propertyName)
               throws SAPGeneralSystemException,
                      SAPAuthSystemException,
                      SAPGeneralAppException
プロパティファイル名のメンバ変数への設定、プロパティファイルの読込と 各PropertyListの生成処理を行います。

パラメータ:
propertyName - BAPIコントローラが使用するプロパティファイル名
例外:
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外
メソッドの詳細

putImportParam

public void putImportParam(String key,
                           String val)
                    throws SAPGeneralSystemException,
                           SAPGeneralAppException
引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import", パラメタ属性="import")を生成し、一覧に格納します。

パラメータ:
key - BapiHashに設定するHashMapのキー
val - BapiHashに設定するHashMapの値
例外:
SAPGeneralSystemException - 汎用系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理

putStructParam

public void putStructParam(String key,
                           String val,
                           String structName)
                    throws SAPGeneralSystemException,
                           SAPGeneralAppException
引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import", パラメタ属性="structure",パラメタ名=第3引数)を生成し、一覧に格納します。

パラメータ:
key - BapiHashに設定するHashMapのキー
val - BapiHashに設定するHashMapの値
structName - BapiHashに設定するparamTypeの値
例外:
SAPGeneralSystemException - 汎用系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理

putTableParam

public void putTableParam(String key,
                          String val,
                          String tableName,
                          int recordNo)
                   throws SAPGeneralSystemException,
                          SAPGeneralAppException
引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import", パラメタ属性="table",パラメタ名=第3引数,レコード番号=第4引数)を生成し、 一覧に格納します。

パラメータ:
key - BapiHashに設定するHashMapのキー
val - BapiHashに設定するHashMapの値
tableName - BapiHashに設定するparamTypeの値
recordNo - BapiHashに設定するrecordNoの値
例外:
SAPGeneralSystemException - 汎用系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理

executeBapi

public void executeBapi()
                 throws SAPGeneralSystemException,
                        SAPGeneralAppException,
                        SAPAuthSystemException,
                        SAPAuthAppException
BAPI実行部のメソッド。JCO.Connectionを生成し、JCO.Functionの生成、 BAPI引渡しパラメータの生成を行いBAPI実行を行います。またBAPI実行結果から BapiHashオブジェクトの生成とBapiHashListへの追加、 BapiReturnオブジェクトの生成とBapiReturnListへの追加を行います。
なお、このクラスのコンストラクタ呼び出し時にConnectionManagerを指定した場合、 トランザクション処理は自動的に実行されません。呼び出し側で明示的にConnectionManager#commit またはConnectionManager#rollbackを実行する必要があります。また、R/3とのコネクションも 上記2メソッド内で行われますので、確実に呼び出すように実装しなくてはなりません。

例外:
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理
SAPAuthAppException - 認証系アプリケーション例外処理

isSuccess

public boolean isSuccess()
                  throws SAPGeneralSystemException
BAPI実行が正常に行われたか判定します。BAPI実行結果であるBapiReturn のType情報が正常("S" / "")であった場合"true"をそれ以外は"false"を返します。

戻り値:
bapiSuccess BAPI実行結果
例外:
SAPGeneralSystemException - 汎用系システム例外処理

getErrMessage

public String getErrMessage()
                     throws SAPGeneralSystemException
BAPIの実行結果でBapiReturnのType情報が正常("S" / "")以外のBapiReturn オブジェクトのメッセージ情報を全て返します。全て正常("S" / "")の場合は nullが返却されます。

戻り値:
buffer BAPI実行結果エラーとなった全てのメッセージ情報
例外:
SAPGeneralSystemException - 汎用系システム例外処理

getExportParam

public String getExportParam(String propKey)
                      throws SAPGeneralSystemException
export(Export)情報を返します。入力/出力区分、パラメータ属性、パラメータ名、 プロパティファイルのキー情報で一覧から該当するBapiHashオブジェクト を検索して、値を返します。

パラメータ:
propKey - 検索条件となるPropertyKey
戻り値:
rtnVal 引数のキーに対応する値
例外:
SAPGeneralSystemException - 汎用系システム例外処理

getStructureParam

public HashMap getStructureParam(String paramName)
                          throws SAPGeneralSystemException
structure(Export)情報を返します。入力/出力区分、パラメータ属性、パラメータ名 で一覧から該当するBapiHashオブジェクトを検索して返します。

パラメータ:
paramName - 検索条件となるParamName
戻り値:
retMap 検索結果となるBapiHash
例外:
SAPGeneralSystemException - 汎用系システム例外処理

getTableParam

public Iterator getTableParam(String paramName)
                       throws SAPGeneralSystemException
table(Export)情報を返します。入力/出力区分、パラメータ属性、パラメータ名 で一覧から該当するBapiHashオブジェクトを検索し、一覧に格納して返します。

パラメータ:
paramName - 検索条件となるParamName
戻り値:
retMap 検索結果となるBapiHash
例外:
SAPGeneralSystemException - 汎用系システム例外処理

getReturnList

public Iterator getReturnList()
BAPI実行結果の一覧を取得します。(Table用)

戻り値:
bapiReturnList

getReturn

public BapiReturn getReturn()
BAPI実行結果を取得します。(Structure用)

戻り値:
bapiRet

getBapiHashList

public ArrayList getBapiHashList()
BapiHashの一覧を取得します。

戻り値:
bapiHashList

getProperty

public Properties getProperty()
プロパティファイル情報を取得します。

戻り値:
property

getPropertyName

public String getPropertyName()
プロパティファイル名を取得します。

戻り値:
propertyName

getImpImpList

public ArrayList getImpImpList()
プロパティ情報(import(Import))の一覧を取得します。

戻り値:
impImpList

getImpStrList

public ArrayList getImpStrList()
プロパティ情報(structure(Import))一覧を取得します。

戻り値:
impStrList

getImpTblList

public ArrayList getImpTblList()
プロパティ情報(table(Import))の一覧を取得します。

戻り値:
impTblList

getExpExpList

public ArrayList getExpExpList()
プロパティ情報(export(Export))の一覧を取得します。

戻り値:
expExpList

getExpStrList

public ArrayList getExpStrList()
プロパティ情報(structure(Export))の一覧を取得します。

戻り値:
expStrList

getExpTblList

public ArrayList getExpTblList()
プロパティ情報(table(Export))の一覧を取得します。

戻り値:
expTblList

getBapiReturnList

public ArrayList getBapiReturnList()
BapiReturnの一覧を取得します。

戻り値:
bapiReturnList

setBapiHashList

public void setBapiHashList(ArrayList bapiHashList)
BapiHashの一覧を設定します。

パラメータ:
bapiHashList - BapiHashList

setProperty

public void setProperty(Properties property)
プロパティファイル情報を設定します。

パラメータ:
property - Property

setPropertyName

public void setPropertyName(String propertyName)
プロパティファイル名を設定します。

パラメータ:
propertyName - propertyName

setImpImpList

public void setImpImpList(ArrayList impImpList)
プロパティ情報(import(Import))の一覧を設定します。

パラメータ:
impImpList - impImpList

setImpStrList

public void setImpStrList(ArrayList impStrList)
プロパティ情報(structure(Import))の一覧を設定します。

パラメータ:
impStrList - impStrList

setImpTblList

public void setImpTblList(ArrayList impTblList)
プロパティ情報(table(Import))の一覧を設定します。

パラメータ:
impTblList - impTblList

setExpExpList

public void setExpExpList(ArrayList expExpList)
プロパティ情報(export(Export))の一覧を設定します。

パラメータ:
expExpList - expExpList

setExpStrList

public void setExpStrList(ArrayList expStrList)
プロパティ情報(structure(Export))の一覧を設定します。

パラメータ:
expStrList - expStrList

setExpTblList

public void setExpTblList(ArrayList expTblList)
プロパティ情報(table(Export))の一覧を設定します。

パラメータ:
expTblList - expTblList

setBapiReturnList

public void setBapiReturnList(ArrayList bapiReturnList)
BapiReturnの一覧を設定します。

パラメータ:
bapiReturnList - bapiReturnList

toString

public String toString()
デバッグ用のメソッドです。

戻り値:
value すべての属性の値

clear

public void clear()

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

BapiControllerを複数回使用する場合、一度putImportParam()などを実行した後に 同じパラメータをセットする前に実行する必要があります。

実行例は次のようになります。

 BapiController bapiController = new BapiController(...);
 bapiController.putImportParam(...);
 bapiController.putStructParam(...);
 ...
 executeBapi();
 
 //クリア
 bapiController.clear();
 
 //BapiControllerを再利用する
 bapiController.putImportParam(...);
 bapiController.putStructParam(...);
 ...
 executeBapi();
 


intra-mart(R)
5.0

Copyright © 2000-2005 NTT DATA INTRAMART CO.,LTD. All Rights Reserved.