|
IM-ERP Real Connect | |||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectjp.co.intra_mart.foundation.sap.common.general_purpose.BapiController
public class BapiController
BAPIコントローラクラス。
機能は以下の通り。
| フィールドの概要 | |
|---|---|
static String[] |
DEFAULT_IGNORE_ERR_MSG_RETURN_TYPES
エラーメッセージを無視するRETURN-TYPEの設定。 |
| コンストラクタの概要 | |
|---|---|
BapiController(String propertyName)
プロパティファイル名のメンバ変数への設定、プロパティファイルの読込と 各PropertyListの生成処理を行います。 |
|
BapiController(String propertyName,
ConnectionManager connectionManager)
コネクションマネージャのセット、プロパティファイル名のメンバ変数への設定、 プロパティファイルの読込と各PropertyListの生成処理を行います。 ConnectionManagerを使用することで、
ConnectionManagerからトランザクションを制御でき、
たとえば同一トランザクション内で複数の登録・更新処理を実行することができます。 |
|
BapiController(String propertyName,
SapClient sapClient)
サップクライアントのセット、プロパティファイル名のメンバ変数への設定、 プロパティファイルの読込と各PropertyListの生成処理を行います。 SapClientを使用することで、SapClientにて指定した
SAPアプリケーションサーバ接続が可能となります。 |
|
| メソッドの概要 | |
|---|---|
void |
addAutoCommitCondition(String autoCommitConditon)
推奨されていません。 addIgnoreErrMsgReturnType(java.lang.String)に置き換えられました。 |
void |
addIgnoreErrMsgReturnType(String ignoreErrMsgReturnType)
エラーメッセージを無視するRETURN-TYPEを追加します。 |
void |
clear()
セットしたパラメータ、ストラクチャ、テーブル、BAPIの実行結果をクリアします。 |
void |
executeBapi()
BAPIを実行します。 |
List<String> |
getAutoCommitConditions()
推奨されていません。 getIgnoreErrMsgReturnTypes()に置き換えられました。 |
List<BapiHash> |
getBapiHashList()
BapiHashの一覧を取得します。 |
List<BapiReturn> |
getBapiReturnList()
BapiReturnの一覧を取得します。 |
String |
getErrMessage()
BAPIの実行結果のエラーメッセージを取得します。 |
List<LineProperty> |
getExpExpList()
プロパティ情報(export(Export))の一覧を取得します。 |
String |
getExportParam(String propKey)
export(Export)情報を返します。 |
List<LineProperty> |
getExpStrList()
プロパティ情報(structure(Export))の一覧を取得します。 |
List<LineProperty> |
getExpTblList()
プロパティ情報(table(Export))の一覧を取得します。 |
List<String> |
getIgnoreErrMsgReturnTypes()
エラーメッセージを無視するRETURN-TYPEを取得します。 |
List<LineProperty> |
getImpImpList()
プロパティ情報(import(Import))の一覧を取得します。 |
List<LineProperty> |
getImpStrList()
プロパティ情報(structure(Import))一覧を取得します。 |
List<LineProperty> |
getImpTblList()
プロパティ情報(table(Import))の一覧を取得します。 |
String |
getMessage()
設定されたエラーメッセージを無視するRETURN-TYPE情報に一致したメッセージ情報を全て返します。 |
String |
getMessage(String type)
引数に一致したType情報のメッセージ情報全て取得します。 |
Properties |
getProperty()
プロパティファイル情報を取得します。 |
String |
getPropertyName()
プロパティファイル名を取得します。 |
BapiReturn |
getReturn()
BAPI実行結果を取得します。 |
Iterator<String> |
getReturnCodeTypes()
BapiReturn のType情報を取得します。 |
Iterator<BapiReturn> |
getReturnList()
BAPI実行結果の一覧を取得します。 |
Map<String,String> |
getStructureParam(String paramName)
structure(Export)情報を返します。 |
Iterator<Map<String,String>> |
getTableParam(String paramName)
table(Export)情報を返します。 |
boolean |
isSuccess()
BAPI実行が正常に行われたか判定します。 BAPI実行結果であるBapiReturndのType情報が 正常(デフォルト値: "S" / "")であった場合"true"をそれ以外は"false"を返します。 正常と判断させる条件はプロパティファイル、 または setIgnoreErrMsgReturnTypes(List)、
addIgnoreErrMsgReturnType(String)でカスタマイズできます。 |
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 |
setAutoCommitConditions(List<String> autoCommitConditions)
推奨されていません。 setIgnoreErrMsgReturnTypes()に置き換えられました。 |
void |
setBapiHashList(List<BapiHash> bapiHashList)
BapiHashの一覧を設定します。 |
void |
setBapiReturnList(List<BapiReturn> bapiReturnList)
BapiReturnの一覧を設定します。 |
void |
setExpExpList(List<LineProperty> expExpList)
プロパティ情報(export(Export))の一覧を設定します。 |
void |
setExpStrList(List<LineProperty> expStrList)
プロパティ情報(structure(Export))の一覧を設定します。 |
void |
setExpTblList(List<LineProperty> expTblList)
プロパティ情報(table(Export))の一覧を設定します。 |
void |
setIgnoreErrMsgReturnTypes(List<String> list)
エラーメッセージを無視するRETURN-TYPEを設定します。 |
void |
setImpImpList(List<LineProperty> list)
プロパティ情報(import(Import))の一覧を設定します。 |
void |
setImpStrList(List<LineProperty> impStrList)
プロパティ情報(structure(Import))の一覧を設定します。 |
void |
setImpTblList(List<LineProperty> 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 |
| フィールドの詳細 |
|---|
public static final String[] DEFAULT_IGNORE_ERR_MSG_RETURN_TYPES
| コンストラクタの詳細 |
|---|
public BapiController(String propertyName)
throws SAPGeneralSystemException,
SAPAuthSystemException,
SAPGeneralAppException
propertyName - BAPIコントローラが使用するプロパティファイル名
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外
public BapiController(String propertyName,
ConnectionManager connectionManager)
throws SAPGeneralSystemException,
SAPAuthSystemException,
SAPGeneralAppException
ConnectionManagerを使用することで、
ConnectionManagerからトランザクションを制御でき、
たとえば同一トランザクション内で複数の登録・更新処理を実行することができます。executeBapi()実行後に必ずConnectionManager.commit()
またはConnectionManager.rollback()を
実行してください。executeBapi()実行後にここまでの
コネクションマネージャーで実行したすべての処理がcommitまたは
rollbackされます。ConnectionManager.commit()または
ConnectionManager.rollback()を実行してください。
propertyName - BAPIコントローラが使用するプロパティファイル名connectionManager - 生成したConnectionManagerオブジェクト
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外
public BapiController(String propertyName,
SapClient sapClient)
throws SAPGeneralSystemException,
SAPAuthSystemException,
SAPGeneralAppException
SapClientを使用することで、SapClientにて指定した
SAPアプリケーションサーバ接続が可能となります。
propertyName - BAPIコントローラが使用するプロパティファイル名sapClient - SAPへの接続情報が格納されたオブジェクト
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外| メソッドの詳細 |
|---|
public void putImportParam(String key,
String val)
throws SAPGeneralSystemException,
SAPGeneralAppException
key - BapiHashに設定するHashMapのキーval - BapiHashに設定するHashMapの値
SAPGeneralSystemException - 汎用系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理
public void putStructParam(String key,
String val,
String structName)
throws SAPGeneralSystemException,
SAPGeneralAppException
key - BapiHashに設定するHashMapのキーval - BapiHashに設定するHashMapの値structName - BapiHashに設定するparamTypeの値
SAPGeneralSystemException - 汎用系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理
public void putTableParam(String key,
String val,
String tableName,
int recordNo)
throws SAPGeneralSystemException,
SAPGeneralAppException
key - BapiHashに設定するHashMapのキーval - BapiHashに設定するHashMapの値tableName - BapiHashに設定するparamTypeの値recordNo - BapiHashに設定するrecordNoの値
SAPGeneralSystemException - 汎用系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理
public void executeBapi()
throws SAPGeneralSystemException,
SAPGeneralAppException,
SAPAuthSystemException,
SAPAuthAppException
ConnectionManagerを指定した場合、 トランザクション処理は自動的に実行されません。呼び出し側で明示的にConnectionManager.commit()
またはConnectionManager.rollback()を実行する必要があります。また、SAPとのコネクションも 上記2メソッド内で行われますので、確実に呼び出すように実装しなくてはなりません。 ConnectionManagerを指定した場合の注意点ConnectionManager.commit()または ConnectionManager.rollback()を実行してください。
SAPGeneralSystemException - 汎用系システム例外処理
SAPAuthSystemException - 認証系システム例外処理
SAPGeneralAppException - 汎用系アプリケーション例外処理
SAPAuthAppException - 認証系アプリケーション例外処理
public boolean isSuccess()
throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes(List)、
addIgnoreErrMsgReturnType(String)でカスタマイズできます。
SAPGeneralSystemException - 汎用系システム例外処理
public String getErrMessage()
throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes(List),
addIgnoreErrMsgReturnType(String)でカスタマイズできます。
SAPGeneralSystemException - 汎用系システム例外処理
public String getMessage()
throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes(List),
addIgnoreErrMsgReturnType(String)でカスタマイズできます。
SAPGeneralSystemException - 汎用系システム例外処理
public String getMessage(String type)
throws SAPGeneralSystemException
| MESSAGE1 : メッセージ1 |
| MESSAGE2 : メッセージ2 |
| : |
type - エラーコードタイプ
SAPGeneralSystemException - 汎用系システム例外処理
public String getExportParam(String propKey)
throws SAPGeneralSystemException
propKey - 検索条件となるPropertyKey
SAPGeneralSystemException - 汎用系システム例外処理
public Map<String,String> getStructureParam(String paramName)
throws SAPGeneralSystemException
paramName - 検索条件となるParamName
SAPGeneralSystemException - 汎用系システム例外処理
public Iterator<Map<String,String>> getTableParam(String paramName)
throws SAPGeneralSystemException
paramName - 検索条件となるParamName
SAPGeneralSystemException - 汎用系システム例外処理public Iterator<BapiReturn> getReturnList()
public BapiReturn getReturn()
public List<BapiHash> getBapiHashList()
public Properties getProperty()
public String getPropertyName()
public List<LineProperty> getImpImpList()
public List<LineProperty> getImpStrList()
public List<LineProperty> getImpTblList()
public List<LineProperty> getExpExpList()
public List<LineProperty> getExpStrList()
public List<LineProperty> getExpTblList()
public List<BapiReturn> getBapiReturnList()
public void setBapiHashList(List<BapiHash> bapiHashList)
bapiHashList - BapiHashListpublic void setProperty(Properties property)
property - Propertypublic void setPropertyName(String propertyName)
propertyName - propertyNamepublic void setImpImpList(List<LineProperty> list)
list - impImpListpublic void setImpStrList(List<LineProperty> impStrList)
impStrList - impStrListpublic void setImpTblList(List<LineProperty> impTblList)
impTblList - impTblListpublic void setExpExpList(List<LineProperty> expExpList)
expExpList - expExpListpublic void setExpStrList(List<LineProperty> expStrList)
expStrList - expStrListpublic void setExpTblList(List<LineProperty> expTblList)
expTblList - expTblListpublic void setBapiReturnList(List<BapiReturn> bapiReturnList)
bapiReturnList - bapiReturnListpublic String toString()
Object 内の toStringpublic void clear()
セットしたパラメータ、ストラクチャ、テーブル、BAPIの実行結果をクリアします。
BapiControllerを複数回使用する場合、一度putImportParam()などを実行した後に 同じパラメータをセットする前に実行する必要があります。
実行例は次のようになります。
BapiController bapiController = new BapiController(...); bapiController.putImportParam(...); bapiController.putStructParam(...); ... executeBapi(); //クリア bapiController.clear(); //BapiControllerを再利用する bapiController.putImportParam(...); bapiController.putStructParam(...); ... executeBapi();
public List<String> getAutoCommitConditions()
getIgnoreErrMsgReturnTypes()に置き換えられました。
String型の要素からなるListオブジェクト)public void addAutoCommitCondition(String autoCommitConditon)
addIgnoreErrMsgReturnType(java.lang.String)に置き換えられました。
autoCommitConditon - オートコミットさせる条件
public void setAutoCommitConditions(List<String> autoCommitConditions)
throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes()に置き換えられました。
List の要素は文字列 String で登録します。
autoCommitConditions - オートコミットさせる条件リスト
SAPGeneralSystemException - 引数にString型以外の要素が
含まれている場合にスローされます。public List<String> getIgnoreErrMsgReturnTypes()
public void addIgnoreErrMsgReturnType(String ignoreErrMsgReturnType)
ignoreErrMsgReturnType - エラーメッセージを無視するRETURN-TYPE値
public void setIgnoreErrMsgReturnTypes(List<String> list)
throws SAPGeneralSystemException
List の要素は文字列 String で登録します。
list - エラーメッセージを無視するRETURN-TYPE値のリスト
SAPGeneralSystemException - 引数にString型以外の要素が
含まれている場合にスローされます。public Iterator<String> getReturnCodeTypes()
String型の要素からなる
Iteratorオブジェクトを取得します。
|
IM-ERP Real Connect | |||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||