jp.co.itarchitects.xFlow.action

クラス ApplyDataBuilder4XML

java.lang.Object

jp.co.itarchitects.xFlow.action.ApplyDataBuilder

jp.co.itarchitects.xFlow.action.ApplyDataBuilder4XML

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

java.io.Serializable

直系の既知のサブクラス:

SaveDataBuilder

public class ApplyDataBuilder4XML
extends ApplyDataBuilder

ApplyDataBuilder4XMLは、申請・下書きに必要な情報を管理・精査します。
フォーム形式が「フォーム」の場合に使用します。

申請・下書きに必要な情報を設定するためのdoInspectメソッド、doInspect4Saveメソッドには、 申請者のIDや申請件名に加え、以下のワークフローシステム固有の情報を、引数として渡す必要があります。

• 申請者の所属情報
• 申請フォームのキー
• 申請文書への入力データ

申請者の所属情報は、UserInfomationManagerを使って検索した OrganizationTableから取得できます。
同様に、申請フォームのキーは、BdfManagerを使って検索した BdfTableから取得できます。

申請文書への入力データはXML形式で指定します。
このXMLではルート要素を<DOCUMENT>とし、ルート要素の下に<DATA>という要素を設定します。
入力データは、<DATA>にフォーム上のオブジェクト名を要素の名前として設定します。
オブジェクト名は、処理対象のフォームがマルチフォームを使用しているかにより、指定方法が異なります。

【補足】
マルチフォームでは、申請内容にあわせて、申請時に手動でページを追加して申請することができます。 API申請においても、ページを追加した時と同じようにページを指定して申請することができます。
マルチフォームの設定はFormエディターで行います。マルチフォームの設定についての詳細はFormエディターのマニュアルを参照ください。

【XMLファイルについて】
・ファイル形式

XMLは以下のファイル形式で作成します。

項目	説明
拡張子	*.xml
エンコード	以下のエンコードのいずれかを使用します。 Shift-JIS MS932 UTF-8 ※ EUC_JP ※「UTF-8」使用時はBOMなし（UTF-8N）でファイルを作成してください。

・エスケープ文字

要素の内容にエスケープが必要な文字が含まれる場合、XML作成時にエスケープ文字に変換する必要があります。

エスケープが必要な文字	エスケープ文字
開始不等号（ < ）	&lt;
終了不等号（ > ）	&gt;
アンパサンド記号（ & ）	&amp;
ダブルクォーテーション（ " ）	&quot;
シングルコーテーション（ ' ）	&apos;

◇記載例

エスケープ前	エスケープ後
<TEXT>このデータには開始不等号( < )と終了不等号( > )が含まれています。</TEXT>	<TEXT>このデータには開始不等号( &lt; )と終了不等号( &gt; )が含まれています。</TEXT>

以下は、XMLの作成例です。

マルチフォーム設定なし

<DATA>の子要素として、フォーム上のオブジェクトと同じ名前の要素を作成し、オブジェクトへの入力内容を設定します。

<DOCUMENT>
<DATA>
<BUMON_ID>001</BUMON_ID>
<KINGAKU>20000</KINGAKU>
<NAIYOU>名刺入れ</NAIYOU>
</DATA>
</DOCUMENT>

マルチフォーム設定あり

Formエディターの[マルチフォーム] - [フォーム設定] - [マルチフォーム設定]がチェックされている状態、かつ、オブジェクトの
[HTMLタブ] - [マルチフォームでオブジェクトをページごとに区別する]がチェックされている場合、以下のタグ名の要素を作成
して<DATA>の子要素として配置します。

[オブジェクト名] + _ + [フォーム識別子] + _ + [ページ番号] - 1

【補足】

• [オブジェクト名] [フォーム識別子]は、Formエディターで設定した値です。
• [ページ番号]は、フォーム識別子ごとのページ番号です。（全体を通してのページ番号ではありません。）

[フォーム識別子]が「FORM02」のページを2ページ追加し、追加したページのオブジェクトを指定する場合。

ページ番号	オブジェクト	XMLで指定するオブジェクト名
1	KINGAKU	KINGAKU_FORM02_0
1	NAIYOU	NAIYOU_FORM02_0
2	KINGAKU	KINGAKU_FORM02_1
2	NAIYOU	NAIYOU_FORM02_1

<DOCUMENT>
<DATA>
<BUMON_ID>001</BUMON_ID>
<KINGAKU_FORM02_0>20000</KINGAKU_FORM02_0>
<NAIYOU_FORM02_0>名刺入れ</NAIYOU_FORM02_0>
<KINGAKU_FORM02_1>50000</KINGAKU_FORM02_1>
<NAIYOU_FORM02_1>モニター</NAIYOU_FORM02_1>
</DATA>
</DOCUMENT>

【補足】

• 指定したページが、マルチフォーム設定の[最小・最大ページ数]の最小ページ数未満となる場合は、最小ページ数まで空欄のページが追加されます。
• マルチフォーム設定の[最小・最大ページ数]の最大ページ数を超えたページ指定は無視されます。
• 申請データに指定したオブジェクトに未指定のページがある場合、未指定のページについては空欄となります。
  例えば、1ページと3ページのオブジェクトが指定されている場合、オブジェクトが指定されていない2ページの値は空欄になります。
• [HTMLタブ] - [マルチフォームでオブジェクトをページごとに区別する]にチェックのないオブジェクトについては、マルチフォームを使用しない場合と同様の方法で設定してください。

本クラスの使用方法については ApplyAgentをご参照ください。

関連項目:

ApplyAgent, 直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ApplyDataBuilder4XML()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	doInspect(java.lang.String applyerId, java.lang.String orgVersionCode, java.lang.String groupCode, java.lang.String authCode, java.lang.String applySubject, java.lang.String defineDataKey, org.w3c.dom.Document applyData2Workflow) 申請に必要な情報を検査し、設定します。
void	doInspect(java.lang.String applyerId, java.lang.String orgVersionCode, java.lang.String groupCode, java.lang.String authCode, java.lang.String applySubject, java.lang.String defineDataKey, java.io.File applyFile2Workflow) 申請に必要な情報を検査し、設定します。
void	doInspect4Save(java.lang.String applyerId, java.lang.String orgVersionCode, java.lang.String groupCode, java.lang.String authCode, java.lang.String defineDataKey, org.w3c.dom.Document applyData2Workflow) 下書きに必要な情報を検査し、設定します。
void	doInspect4Save(java.lang.String applyerId, java.lang.String orgVersionCode, java.lang.String groupCode, java.lang.String authCode, java.lang.String defineDataKey, java.io.File applyFile2Workflow) 下書きに必要な情報を検査し、設定します。
void	doInspect4Save(java.lang.String applyerId, java.lang.String orgVersionCode, java.lang.String groupCode, java.lang.String authCode, java.lang.String applySubject, java.lang.String defineDataKey, org.w3c.dom.Document applyData2Workflow) 下書きに必要な情報を検査し、設定します。
void	doInspect4Save(java.lang.String applyerId, java.lang.String orgVersionCode, java.lang.String groupCode, java.lang.String authCode, java.lang.String applySubject, java.lang.String defineDataKey, java.io.File applyFile2Workflow) 下書きに必要な情報を検査し、設定します。

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

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

コンストラクタの詳細

ApplyDataBuilder4XML

public ApplyDataBuilder4XML()

メソッドの詳細

doInspect

public void doInspect(java.lang.String applyerId,
                      java.lang.String orgVersionCode,
                      java.lang.String groupCode,
                      java.lang.String authCode,
                      java.lang.String applySubject,
                      java.lang.String defineDataKey,
                      org.w3c.dom.Document applyData2Workflow)
               throws XFlowException

申請に必要な情報を検査し、設定します。

パラメータ:

applyerId - 申請者のID

orgVersionCode - 申請者が所属する組織の組織コード

groupCode - 申請者が所属するグループのグループコード

authCode - 申請者の役職コード

applySubject - 申請件名

defineDataKey - 申請フォームのキー

applyData2Workflow - 申請文書への入力データを格納したDocumentオブジェクト

例外:

XFlowException - 申請に必要な情報が正しくない場合

doInspect

public void doInspect(java.lang.String applyerId,
                      java.lang.String orgVersionCode,
                      java.lang.String groupCode,
                      java.lang.String authCode,
                      java.lang.String applySubject,
                      java.lang.String defineDataKey,
                      java.io.File applyFile2Workflow)
               throws XFlowException

申請に必要な情報を検査し、設定します。

定義:

doInspect クラス内 ApplyDataBuilder

パラメータ:

applyerId - 申請者のID

orgVersionCode - 申請者が所属する組織の組織コード

groupCode - 申請者が所属するグループのグループコード

authCode - 申請者の役職コード

applySubject - 申請件名

defineDataKey - 申請フォームのキー

applyFile2Workflow - 申請文書への入力データを格納したファイル(XML形式)

例外:

XFlowException - 申請に必要な情報が正しくない場合

doInspect4Save

public void doInspect4Save(java.lang.String applyerId,
                           java.lang.String orgVersionCode,
                           java.lang.String groupCode,
                           java.lang.String authCode,
                           java.lang.String defineDataKey,
                           org.w3c.dom.Document applyData2Workflow)
                    throws XFlowException

下書きに必要な情報を検査し、設定します。

パラメータ:

applyerId - 申請者のID

orgVersionCode - 申請者が所属する組織の組織コード

groupCode - 申請者が所属するグループのグループコード

authCode - 申請者の役職コード

defineDataKey - 申請フォームのキー

applyData2Workflow - 申請文書への入力データを格納したDocumentオブジェクト

例外:

XFlowException - 申請に必要な情報が正しくない場合

doInspect4Save

public void doInspect4Save(java.lang.String applyerId,
                           java.lang.String orgVersionCode,
                           java.lang.String groupCode,
                           java.lang.String authCode,
                           java.lang.String applySubject,
                           java.lang.String defineDataKey,
                           org.w3c.dom.Document applyData2Workflow)
                    throws XFlowException

下書きに必要な情報を検査し、設定します。
申請件名は、旧バージョン形式のフォームでは設定されません。

パラメータ:

applyerId - 申請者のID

orgVersionCode - 申請者が所属する組織の組織コード

groupCode - 申請者が所属するグループのグループコード

authCode - 申請者の役職コード

applySubject - 申請件名(旧バージョン形式のフォームでは無視されます)

defineDataKey - 申請フォームのキー

applyData2Workflow - 申請文書への入力データを格納したDocumentオブジェクト

例外:

XFlowException - 申請に必要な情報が正しくない場合

doInspect4Save

public void doInspect4Save(java.lang.String applyerId,
                           java.lang.String orgVersionCode,
                           java.lang.String groupCode,
                           java.lang.String authCode,
                           java.lang.String defineDataKey,
                           java.io.File applyFile2Workflow)
                    throws XFlowException

下書きに必要な情報を検査し、設定します。

パラメータ:

applyerId - 申請者のID

orgVersionCode - 申請者が所属する組織の組織コード

groupCode - 申請者が所属するグループのグループコード

authCode - 申請者の役職コード

defineDataKey - 申請フォームのキー

applyFile2Workflow - 申請文書への入力データを格納したファイル(XML形式)

例外:

XFlowException - 申請に必要な情報が正しくない場合

doInspect4Save

public void doInspect4Save(java.lang.String applyerId,
                           java.lang.String orgVersionCode,
                           java.lang.String groupCode,
                           java.lang.String authCode,
                           java.lang.String applySubject,
                           java.lang.String defineDataKey,
                           java.io.File applyFile2Workflow)
                    throws XFlowException

下書きに必要な情報を検査し、設定します。
申請件名は、旧バージョン形式のフォームでは設定されません。

パラメータ:

applyerId - 申請者のID

orgVersionCode - 申請者が所属する組織の組織コード

groupCode - 申請者が所属するグループのグループコード

authCode - 申請者の役職コード

applySubject - 申請件名(旧バージョン形式のフォームでは無視されます)

defineDataKey - 申請フォームのキー

applyFile2Workflow - 申請文書への入力データを格納したファイル(XML形式)

例外:

XFlowException - 申請に必要な情報が正しくない場合