販売伝票ステータス一覧 照会 API (SalesOrderGetStatusController)¶
販売伝票ステータス一覧を照会するためには、SalesOrderGetStatusController クラスの持つ各メソッドを利用する必要があります。引数、戻り値についての詳細な情報は、API リストを参照してください。
各メソッドの説明¶
コンストラクタ / メソッド名 説明 SalesOrderGetStatusController コンストラクタ(引数無し) SalesOrderGetStatusController コンストラクタ(第 1 引数あり)。ConnectionManager を使う場合に使用する。第 1 引数で「ConnectionManager」を設定する。SalesOrderGetStatusController コンストラクタ(第 1 引数あり)。SAPClient の接続情報を使う場合に使用する。第 1 引数で「SAPClient」(オブジェクト)を設定する。setSalesdocument import 項目:販売管理伝票番号を設定します。 setTblParam テーブル型の各項目に値を設定する。第1引数にテーブル名、第2引数に項目名第3引数に値、第4引数にレコード番号を設定する。executeBapi BapiController により販売伝票ステータスを取得します。 getBapiReturnErrMessage BAPI実行結果である BapiReturn の Type 情報が正常(デフォルト値: “S” / “”)以外の BapiReturn オブジェクトのメッセージ情報を全て返します。全て正常の場合は null が返却されます。getBapiReturnMessage BAPI実行結果である BapiReturn の Type 情報が正常(デフォルト値: “S” / “”)と判断された Type 情報のメッセージ情報を全て返します。メッセージが存在しない場合は null が返却されます。getSalesdocument import 項目:販売管理伝票番号を取得します。 getStatusInfoList ステータス情報情報を取得します。
サンプルプログラム¶
//■販売伝票ステータス一覧 var statusInfoList; var statusInfoCount; function init(request) { //-------------------------------------------------------------------------- //変数宣言 //-------------------------------------------------------------------------- var objCon; var objResult; //-------------------------------------------------------------------------- //インスタンス生成 // 説明 1 //-------------------------------------------------------------------------- objCon = new SalesOrderGetStatusController(); //-------------------------------------------------------------------------- // 単一項目セット // 説明 2 //-------------------------------------------------------------------------- objCon.setSalesdocument("0000000023"); //販売管理伝票番号 //-------------------------------------------------------------------------- // executeBapi実行 // 説明 4 //-------------------------------------------------------------------------- objResult = objCon.executeBapi(); //-------------------------------------------------------------------------- // エラー判定 //-------------------------------------------------------------------------- if(objResult["ERR_CODE"] != null) { //インスタンス生成時に例外が発生した場合 //エラーメッセージを出力 Debug.browse(objResult); } //オブジェクトを取得 // 説明 5 statusInfoList = objCon.getStatusInfoList(); statusInfoCount = statusInfoList.length; }
販売伝票ステータス一覧照会 API のインスタンス生成(説明1)
SalesOrderGetStatusController クラスのインスタンスを生成します。引数は不要です。インスタンスを生成すると、販売伝票ステータス一覧 BAPI(BAPI_SALESORDER_GETSTATUS)の import 型の import、table パラメータに値を設定することができます。import の各項目に値を設定(説明2)
import パラメータの項目に値を設定する場合は、set メソッドを使用します。メソッドについては各 API のAPI リストを参照ください。table の各項目に値を設定(説明3)
table パラメータの項目に値を設定する場合は、setTblParam メソッドを使用します。第1引数のtable名称は固定値になっています。後述のとおりに名称を設定して下さい。第2引数の項目名称は SAP の各属性の項目名称を設定してください。table 名称、項目名称は英字の大文字、小文字は厳密に区別されます。第3引数に値、第四引数にレコード番号を設定します。
SAP table セットする固有名称 STATUSINFO ( ステータス情報 ) StatusInfo 販売伝票ステータス一覧照会(説明4)
SalesOrderGetStatusController クラスの executeBapi メソッドを実行すると、各項目にセットされた値で SAPより販売伝票ステータス一覧データとして照会されます。販売伝票ステータス一覧 BAPI(BAPI_SALESORDER_GETSTATUS)の実行後に RETURN パラメータの内容も取得します。サンプルプログラムの中で記載されたデータ取得メソッドの詳細説明については、以下を参照してください。(説明5)
Type 情報が正常(デフォルト値: “S” / “”)以外の BapiReturn を取得
SalesOrderGetStatusController クラスの getBapiReturnErrMessage メソッドを使用すると、取得したBapiReturn の Type 情報が正常(デフォルト値: “S” / “”)以外の BapiReturn オブジェクトのメッセージ情報を取得することが可能です。全て正常の場合は null を取得します。項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。Type 情報が正常(デフォルト値: “S” / “”)の BapiReturn を取得
SalesOrderGetStatusController クラスの getBapiReturnMessage メソッドを使用すると、取得したBapiReturn の Type 情報が正常(デフォルト値: “S” / “”)と判断された Type 情報のメッセージ情報を取得することが可能です。メッセージが存在しない場合は null を取得します。項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。販売管理伝票番号情報を取得
SalesOrderGetStatusController クラスの getSalesdocument メソッドを使用すると、設定した販売管理伝票番号情報を取得することが可能です。ステータス情報情報を取得
SalesOrderGetStatusController クラスの getStatusInfoList メソッドを使用すると、取得したステータス情報情報を取得することが可能です。項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。コラム
サンプルプログラム実行結果では、SAP テスト環境のデータが取得されています。SAP標準では該当データが存在しません。