org.pslx.PpsDocuments
クラス TransactionProcess

java.lang.Object
  上位を拡張 org.pslx.PpsDocuments.TransactionProcess

public final class TransactionProcess
extends java.lang.Object

一連のトランザクション処理を表すクラス

バージョン:
1.6

入れ子のクラスの概要
static class TransactionProcess.ConfirmTypes
          返信要求の種類
static class TransactionProcess.TentativeResults
          トランザクション処理の結果
static class TransactionProcess.TransactionTypes
          トランザクションの種類
 
メソッドの概要
 boolean checkTransaction(Document document)
          トランザクション継続のチェック(エラーがある場合には中断)
 void commit()
          トランザクションを確定します(クライアント用)
static java.lang.String confirmTypeString(TransactionProcess.ConfirmTypes value)
          ConfirmTypes型の値を文字列に変換します
 Document createDocument(java.lang.String documentName)
          業務ドキュメントを生成します
 Document createDocument(java.lang.String documentName, java.lang.String optionName)
          業務ドキュメントを生成します
 TransactionMessage createMessage()
          トランザクションメッセージを生成します
 TransactionMessage createProfileMessage(Document.ActionTypes actionType)
          実装プロファイルを表すトランザクションメッセージを生成します
 void exitTransaction()
          トランザクションの後処理(確定や取消の場合にイベント発生)
 TransactionProcess.ConfirmTypes getConfirm()
          確認要求の種類を取得します
 TransactionProcess.ConfirmTypes getConfirmReceived()
          受信メッセージの確認要求の種類を取得します
 java.util.List<Document> getDocuments()
          生成した業務ドキュメントのリストを取得します
 java.lang.String getInitiatorName()
          トランザクション起動者名を取得します
 java.util.List<Document> getReceivedDocuments()
          受信メッセージに含まれる業務ドキュメントのリストを取得します
 TransactionProcess.TentativeResults getResult()
          受信メッセージの処理結果を取得します
 java.lang.String getTransactionId()
          トランザクションIDを取得します
 boolean isResponseRequired()
          回答メッセージの送信を要求しているかのどうか判定します
static TransactionProcess.ConfirmTypes parseConfirmType(java.lang.String value)
          文字列からConfirmTypes型の値に変換します
static TransactionProcess.TransactionTypes parseTransactionType(java.lang.String value)
          文字列からTransactionTypes型の値に変換します
 void resume()
          トランザクションを再開します(クライアント用)
 void setConfirm(TransactionProcess.ConfirmTypes value)
          確認要求の種類を設定します
 void setConfirmReceived(TransactionProcess.ConfirmTypes value)
          受信メッセージの確認要求の種類を設定します
 void setDocuments(java.util.List<Document> value)
          生成した業務ドキュメントのリストを設定します
 void setResult(TransactionProcess.TentativeResults value)
          受信メッセージの処理結果を設定します
 void start()
          トランザクションを開始します(クライアント用)
 void transactionCancel()
          トランザクションを取り消します(クライアント用)
static java.lang.String transactionTypeString(TransactionProcess.TransactionTypes value)
          TransactionTypes型の値を文字列に変換します
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getTransactionId

public java.lang.String getTransactionId()
トランザクションIDを取得します


getInitiatorName

public java.lang.String getInitiatorName()
トランザクション起動者名を取得します

戻り値:
トランザクション起動者名

getConfirmReceived

public TransactionProcess.ConfirmTypes getConfirmReceived()
受信メッセージの確認要求の種類を取得します

戻り値:
確認要求の種類

setConfirmReceived

public void setConfirmReceived(TransactionProcess.ConfirmTypes value)
受信メッセージの確認要求の種類を設定します

パラメータ:
value - 確認要求の種類

getConfirm

public TransactionProcess.ConfirmTypes getConfirm()
確認要求の種類を取得します

戻り値:
確認要求の種類

setConfirm

public void setConfirm(TransactionProcess.ConfirmTypes value)
確認要求の種類を設定します

パラメータ:
value - 確認要求の種類

getResult

public TransactionProcess.TentativeResults getResult()
受信メッセージの処理結果を取得します

戻り値:
処理結果

setResult

public void setResult(TransactionProcess.TentativeResults value)
受信メッセージの処理結果を設定します

パラメータ:
value - 処理結果

getDocuments

public java.util.List<Document> getDocuments()
生成した業務ドキュメントのリストを取得します


setDocuments

public void setDocuments(java.util.List<Document> value)
生成した業務ドキュメントのリストを設定します


getReceivedDocuments

public java.util.List<Document> getReceivedDocuments()
受信メッセージに含まれる業務ドキュメントのリストを取得します


createDocument

public Document createDocument(java.lang.String documentName)
                        throws PpsDocumentsException
業務ドキュメントを生成します

パラメータ:
documentName - 業務ドキュメント名
戻り値:
生成された業務ドキュメント
例外:
PpsDocumentsException

createDocument

public Document createDocument(java.lang.String documentName,
                               java.lang.String optionName)
                        throws PpsDocumentsException
業務ドキュメントを生成します

パラメータ:
documentName - 業務ドキュメント名
optionName - オプション識別名
戻り値:
生成された業務ドキュメント
例外:
PpsDocumentsException

createMessage

public TransactionMessage createMessage()
                                 throws PpsDocumentsException
トランザクションメッセージを生成します

戻り値:
生成されたTransactionMessage
例外:
PpsDocumentsException

createProfileMessage

public TransactionMessage createProfileMessage(Document.ActionTypes actionType)
実装プロファイルを表すトランザクションメッセージを生成します

パラメータ:
actionType - トランザクションの種類
戻り値:
生成されたTransactionMessage

isResponseRequired

public boolean isResponseRequired()
回答メッセージの送信を要求しているかのどうか判定します


start

public void start()
トランザクションを開始します(クライアント用)


commit

public void commit()
トランザクションを確定します(クライアント用)


transactionCancel

public void transactionCancel()
トランザクションを取り消します(クライアント用)


resume

public void resume()
トランザクションを再開します(クライアント用)


checkTransaction

public boolean checkTransaction(Document document)
トランザクション継続のチェック(エラーがある場合には中断)

パラメータ:
document - 処理が終わった業務ドキュメント
戻り値:
エラーがある場合はtrue

exitTransaction

public void exitTransaction()
トランザクションの後処理(確定や取消の場合にイベント発生)


transactionTypeString

public static java.lang.String transactionTypeString(TransactionProcess.TransactionTypes value)
TransactionTypes型の値を文字列に変換します


parseTransactionType

public static TransactionProcess.TransactionTypes parseTransactionType(java.lang.String value)
文字列からTransactionTypes型の値に変換します


confirmTypeString

public static java.lang.String confirmTypeString(TransactionProcess.ConfirmTypes value)
ConfirmTypes型の値を文字列に変換します


parseConfirmType

public static TransactionProcess.ConfirmTypes parseConfirmType(java.lang.String value)
文字列からConfirmTypes型の値に変換します