org.pslx.PpsDocuments
クラス TransactionMessage

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

public final class TransactionMessage
extends java.lang.Object

トランザクションメッセージ クラス(通信時におけるの物理的単位)

バージョン:
1.6.003

入れ子のクラスの概要
static class TransactionMessage.MessageTypes
          メッセージの種別
 
コンストラクタの概要
TransactionMessage(DocumentManager manager)
          トランザクション要素を生成します
 
メソッドの概要
 Transaction createTransaction()
          トランザクション要素を生成して、メッセージに追加します。
 Transaction get(int index)
          業務ドキュメントを取得します
 TransactionProcess.ConfirmTypes getConfirm()
          返信要求の種類を取得します
 java.lang.String getConnectionString()
          内部接続用文字列を取得します
 java.lang.String getId()
          メッセージIDを取得します
 ImplementProfile getImplement()
          実装プロファイルを取得します(送受信用)
 ImplementProfile getImplementObtained()
          相手から取得した実装プロファイルを取得します
 Document.ActionTypes getImplementObtainedAction()
          相手から取得した実装プロファイルのトランザクションの種類を取得します
 boolean getIsCanceled()
          トランザクション処理が取消されているかどうかを取得します
 boolean getIsCommited()
          トランザクション処理が確定しているかどうかを取得します
 boolean getIsStarted()
          トランザクション処理が開始されたことを表すメッセージであるかどうかを取得します
 TransactionMessage.MessageTypes getMessageType()
          メッセージ種別を取得します
 java.lang.String getSenderName()
          送信者を取得します
 java.lang.String getTransactionId()
          トランザクションIDを取得します
 java.util.List<Transaction> getTransactions()
          業務ドキュメントのリストを取得します
 java.lang.String getXmlString()
          トランザクションメッセージの内容を表すXMLメッセージを取得します
 void setConfirm(TransactionProcess.ConfirmTypes value)
          返信要求の種類を設定します
 void setConnectionString(java.lang.String value)
          内部接続用文字列を設定します
 void setId(java.lang.String value)
          メッセージIDを設定します
 void setImplementObtained(ImplementProfile value)
          相手から取得した実装プロファイルを設定します
 void setMessageType(TransactionMessage.MessageTypes value)
          メッセージ種別を設定します
 void setSenderName(java.lang.String value)
          送信者を設定します
 void setTransactionId(java.lang.String value)
          トランザクションIDを設定します
 void write(java.io.OutputStream stream)
          XMLメッセージをOutputStreamへ出力します
 void write(java.lang.String filename)
          XMLメッセージをファイルに出力します
 void write(java.io.Writer writer)
          XMLメッセージをWriterに出力します
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

TransactionMessage

public TransactionMessage(DocumentManager manager)
トランザクション要素を生成します

パラメータ:
manager -
メソッドの詳細

getId

public java.lang.String getId()
メッセージIDを取得します


setId

public void setId(java.lang.String value)
メッセージIDを設定します

パラメータ:
value - メッセージID

getMessageType

public TransactionMessage.MessageTypes getMessageType()
メッセージ種別を取得します


setMessageType

public void setMessageType(TransactionMessage.MessageTypes value)
メッセージ種別を設定します

パラメータ:
value - メッセージ種別

getSenderName

public java.lang.String getSenderName()
送信者を取得します


setSenderName

public void setSenderName(java.lang.String value)
送信者を設定します

パラメータ:
value - 送信者名

getTransactionId

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


setTransactionId

public void setTransactionId(java.lang.String value)
トランザクションIDを設定します

パラメータ:
value - トランザクションID

getConfirm

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


setConfirm

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

パラメータ:
value - 返信要求の種類

getConnectionString

public java.lang.String getConnectionString()
内部接続用文字列を取得します


setConnectionString

public void setConnectionString(java.lang.String value)
内部接続用文字列を設定します

パラメータ:
value - 内部接続用文字列

getImplementObtainedAction

public Document.ActionTypes getImplementObtainedAction()
相手から取得した実装プロファイルのトランザクションの種類を取得します

戻り値:
トランザクションの種類

getImplementObtained

public ImplementProfile getImplementObtained()
相手から取得した実装プロファイルを取得します


setImplementObtained

public void setImplementObtained(ImplementProfile value)
相手から取得した実装プロファイルを設定します

パラメータ:
value - 実装プロファイル

getTransactions

public java.util.List<Transaction> getTransactions()
業務ドキュメントのリストを取得します


get

public Transaction get(int index)
業務ドキュメントを取得します

パラメータ:
index - インデックス

getIsCommited

public boolean getIsCommited()
トランザクション処理が確定しているかどうかを取得します

戻り値:
トランザクションが確定している場合は、true

getIsCanceled

public boolean getIsCanceled()
トランザクション処理が取消されているかどうかを取得します

戻り値:
トランザクションが取消されている場合は、true

getIsStarted

public boolean getIsStarted()
トランザクション処理が開始されたことを表すメッセージであるかどうかを取得します

戻り値:
トランザクション処理が開始されている場合は、true

getImplement

public ImplementProfile getImplement()
実装プロファイルを取得します(送受信用)


createTransaction

public Transaction createTransaction()
                              throws PpsDocumentsException
トランザクション要素を生成して、メッセージに追加します。 ここで生成されるメッセージは、トランザクション処理に依存しません

戻り値:
Transaction
例外:
PpsDocumentsException

getXmlString

public java.lang.String getXmlString()
                              throws javax.xml.stream.XMLStreamException,
                                     PpsDocumentsException,
                                     java.io.IOException
トランザクションメッセージの内容を表すXMLメッセージを取得します

例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException
java.io.IOException

write

public void write(java.lang.String filename)
           throws java.io.FileNotFoundException,
                  javax.xml.stream.XMLStreamException,
                  PpsDocumentsException
XMLメッセージをファイルに出力します

パラメータ:
filename - 出力先のパス
例外:
javax.xml.stream.XMLStreamException
java.io.FileNotFoundException
PpsDocumentsException

write

public void write(java.io.OutputStream stream)
           throws javax.xml.stream.XMLStreamException,
                  PpsDocumentsException
XMLメッセージをOutputStreamへ出力します

パラメータ:
stream - 出力先のOutputStream
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException

write

public void write(java.io.Writer writer)
           throws javax.xml.stream.XMLStreamException,
                  PpsDocumentsException
XMLメッセージをWriterに出力します

パラメータ:
writer - 出力先のWriter
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException