org.pslx.PpsDocuments
クラス Document

java.lang.Object
  上位を拡張 org.pslx.PpsDocuments.Document
すべての実装されたインタフェース:
DocumentElement, DomainElement

public final class Document
extends java.lang.Object
implements DocumentElement, DomainElement

業務ドキュメントを保持するクラス

バージョン:
1.6.003

入れ子のクラスの概要
static class Document.ActionTypes
          トランザクションの種類
 
メソッドの概要
static java.lang.String actionTypeString(Document.ActionTypes value)
          ActionTypes型の値を文字列に変換します
 Condition createCondition()
          照会条件を追加し、ドキュメントに追加します
 Condition createCondition(java.lang.String id)
          照会条件を追加し、ドキュメントに追加します
 DomainObject createDomainObject()
          業務オブジェクトを生成し、ドキュメントに追加します
 Error createError()
          エラー情報を生成し、ドキュメントに追加します
 Header createHeader()
          ヘッダ情報を生成します
 Header createHeader(java.lang.String objectName)
          ヘッダ情報を生成します
 Selection createSelection()
          選択項目指定のためのセレクションを生成し、ドキュメントへ追加します
 Selection createSelection(Selection.SelectionTypes type)
          選択項目指定のためのセレクションを生成し追加する
 Document.ActionTypes getAction()
          アクション種類を取得します
 java.lang.String getAppData(java.lang.String name)
          アプリケーション情報を取得します
 java.util.List<org.pslx.PpsDocuments.Document.AppData> getAppDataList()
          アプリケーション情報を取得します
 java.util.List<Condition> getConditions()
          コンディションのリストを取得します
 java.lang.String getConfirm()
          確認要求を取得します
 DomainObjectProfile getDomainObjectProfile()
          業務オブジェクトの定義情報を取得する
 DomainCollection<DomainObject> getDomainObjects()
          業務オブジェクトのリストを取得します
 java.util.List<Error> getErrors()
          エラー情報のリストを取得します
 java.lang.String getEventName()
          イベント名称
 java.lang.String getId()
          ID文字列を取得します
 boolean getIsShared()
          外部と共有するかどうかの区分を取得します(trueの場合のみ出力可能)
 java.lang.String getName()
          業務ドキュメント名を取得します
 java.lang.String getOption()
          オプション文字列を取得します
 java.lang.String getPrimitiveName()
          プリミティブ要素名を取得します
 DocumentProfile getProfile()
          業務ドキュメントの定義情報を取得します
 Document getReference()
          回答ドキュメントが参照する元のドキュメントを取得します
 java.lang.String getReferenceId()
          ドキュメントの参照先ドキュメントIDを取得します
 boolean getResumed()
          すでに送信されたドキュメントであるかどうかを取得します
 java.util.List<Selection> getSelections()
          セレクションのリストを取得します
 TransactionProcess.TentativeResults getTentativeResult()
          トランザクション処理の結果を取得します
 java.lang.String getXmlString()
          業務ドキュメント要素の内容を表すXMLメッセージを取得します
 java.lang.String getXmlString(boolean xmlDefinision)
          業務ドキュメント要素の内容を表すXMLメッセージを取得します
 boolean hasErrors()
          エラー情報をもっているかを取得します(警告は除く)
static Document load(java.lang.String filename, DocumentManager manager)
          指定したファイル名を読み込み、トランザクションを取得します
static Document load(javax.xml.stream.XMLStreamReader reader, DocumentManager manager)
          指定したファイル名を読み込み、トランザクションを取得します
static Document.ActionTypes parseActionType(java.lang.String value)
          文字列からActionTypes型の値に変換します
 void setAction(Document.ActionTypes value)
          アクション種類を設定します
 void setAppData(java.lang.String name, java.lang.String value)
          アプリケーション情報を設定します
 void setConfirm(java.lang.String value)
          確認要求を設定します
 void setEventName(java.lang.String value)
           
 void setId(java.lang.String value)
          ID文字列を設定します
 void setIsShared(boolean value)
          外部と共有するかどうかの区分を設定します
 void setOption(java.lang.String value)
          オプション文字列を設定します
 void setReference(Document value)
          回答ドキュメントが参照する元のドキュメントを設定します
 void setResumed(boolean value)
          すでに送信されたドキュメントであるかどうかを設定します
 void verifyXml(java.io.InputStream stream)
          ストリームを指定してXMLの構文をチェックします
 void verifyXml(java.lang.String name)
          ファイル名を指定してXMLの構文をチェックします
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getDomainObjectProfile

public DomainObjectProfile getDomainObjectProfile()
インタフェース DocumentElement の記述:
業務オブジェクトの定義情報を取得する

定義:
インタフェース DocumentElement 内の getDomainObjectProfile

getReference

public Document getReference()
回答ドキュメントが参照する元のドキュメントを取得します


setReference

public void setReference(Document value)
回答ドキュメントが参照する元のドキュメントを設定します


getReferenceId

public java.lang.String getReferenceId()
ドキュメントの参照先ドキュメントIDを取得します


getOption

public java.lang.String getOption()
オプション文字列を取得します


setOption

public void setOption(java.lang.String value)
オプション文字列を設定します

パラメータ:
value - 設定値

getProfile

public DocumentProfile getProfile()
業務ドキュメントの定義情報を取得します


getErrors

public java.util.List<Error> getErrors()
エラー情報のリストを取得します


getTentativeResult

public TransactionProcess.TentativeResults getTentativeResult()
トランザクション処理の結果を取得します


getResumed

public boolean getResumed()
すでに送信されたドキュメントであるかどうかを取得します


setResumed

public void setResumed(boolean value)
すでに送信されたドキュメントであるかどうかを設定します


setAppData

public void setAppData(java.lang.String name,
                       java.lang.String value)
アプリケーション情報を設定します

パラメータ:
name - 属性名
value - 値

getAppData

public java.lang.String getAppData(java.lang.String name)
アプリケーション情報を取得します

パラメータ:
name - 属性名
戻り値:

createError

public Error createError()
エラー情報を生成し、ドキュメントに追加します

戻り値:
エラーオブジェクト

createDomainObject

public DomainObject createDomainObject()
                                throws PpsDocumentsException
業務オブジェクトを生成し、ドキュメントに追加します

戻り値:
生成した業務オブジェクト
例外:
PpsDocumentsException
java.text.ParseException

createHeader

public Header createHeader()
                    throws PpsDocumentsException
ヘッダ情報を生成します

戻り値:
生成したヘッダオブジェクト
例外:
PpsDocumentsException

createHeader

public Header createHeader(java.lang.String objectName)
                    throws PpsDocumentsException
ヘッダ情報を生成します

パラメータ:
objectName - ヘッダ用業務オブジェクト名
戻り値:
生成したヘッダオブジェクト
例外:
PpsDocumentsException

createCondition

public Condition createCondition()
照会条件を追加し、ドキュメントに追加します

戻り値:
生成したコンディションオブジェクト

createCondition

public Condition createCondition(java.lang.String id)
照会条件を追加し、ドキュメントに追加します

パラメータ:
id - ID制約
戻り値:
生成したコンディションオブジェクト

createSelection

public Selection createSelection()
選択項目指定のためのセレクションを生成し、ドキュメントへ追加します

戻り値:
生成したセレクションオブジェクト

createSelection

public Selection createSelection(Selection.SelectionTypes type)
選択項目指定のためのセレクションを生成し追加する

パラメータ:
type - セレクションの区分
戻り値:
生成したセレクションオブジェクト

getIsShared

public boolean getIsShared()
外部と共有するかどうかの区分を取得します(trueの場合のみ出力可能)


setIsShared

public void setIsShared(boolean value)
外部と共有するかどうかの区分を設定します

パラメータ:
value - trueの場合 出力可能

hasErrors

public boolean hasErrors()
エラー情報をもっているかを取得します(警告は除く)


verifyXml

public void verifyXml(java.lang.String name)
               throws java.io.IOException,
                      org.xml.sax.SAXException
ファイル名を指定してXMLの構文をチェックします

パラメータ:
name - XMLファイル名
例外:
org.xml.sax.SAXException
java.io.IOException

verifyXml

public void verifyXml(java.io.InputStream stream)
               throws java.io.IOException,
                      org.xml.sax.SAXException
ストリームを指定してXMLの構文をチェックします

パラメータ:
stream - 入力となるInputStream
例外:
org.xml.sax.SAXException
java.io.IOException

getAction

public Document.ActionTypes getAction()
アクション種類を取得します


setAction

public void setAction(Document.ActionTypes value)
アクション種類を設定します

パラメータ:
value - アクション種類

getId

public java.lang.String getId()
ID文字列を取得します


setId

public void setId(java.lang.String value)
ID文字列を設定します

パラメータ:
value - ID文字列

getConfirm

public java.lang.String getConfirm()
確認要求を取得します


setConfirm

public void setConfirm(java.lang.String value)
確認要求を設定します

パラメータ:
value - 送信者

getEventName

public java.lang.String getEventName()
イベント名称


setEventName

public void setEventName(java.lang.String value)

getName

public java.lang.String getName()
業務ドキュメント名を取得します

戻り値:
業務ドキュメント名

getPrimitiveName

public java.lang.String getPrimitiveName()
プリミティブ要素名を取得します

戻り値:
プリミティブ要素名

getAppDataList

public java.util.List<org.pslx.PpsDocuments.Document.AppData> getAppDataList()
アプリケーション情報を取得します


getDomainObjects

public DomainCollection<DomainObject> getDomainObjects()
業務オブジェクトのリストを取得します


getConditions

public java.util.List<Condition> getConditions()
コンディションのリストを取得します


getSelections

public java.util.List<Selection> getSelections()
セレクションのリストを取得します


getXmlString

public java.lang.String getXmlString()
                              throws javax.xml.stream.XMLStreamException,
                                     PpsDocumentsException,
                                     java.io.IOException
業務ドキュメント要素の内容を表すXMLメッセージを取得します

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

getXmlString

public java.lang.String getXmlString(boolean xmlDefinision)
                              throws javax.xml.stream.XMLStreamException,
                                     PpsDocumentsException,
                                     java.io.IOException
業務ドキュメント要素の内容を表すXMLメッセージを取得します

パラメータ:
xmlDefinision - XML定義を出力するかどうか
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException
java.io.IOException

load

public static Document load(java.lang.String filename,
                            DocumentManager manager)
                     throws java.lang.Exception
指定したファイル名を読み込み、トランザクションを取得します

パラメータ:
filename - XMLファイル名
manager - ドキュメントマネージャ
戻り値:
業務ドキュメント
例外:
java.lang.Exception

load

public static Document load(javax.xml.stream.XMLStreamReader reader,
                            DocumentManager manager)
                     throws javax.xml.stream.XMLStreamException,
                            java.text.ParseException,
                            PpsDocumentsException
指定したファイル名を読み込み、トランザクションを取得します

パラメータ:
reader - XMLStreamReader
manager - ドキュメントマネージャ
戻り値:
業務ドキュメント
例外:
javax.xml.stream.XMLStreamException
java.text.ParseException
PpsDocumentsException

actionTypeString

public static java.lang.String actionTypeString(Document.ActionTypes value)
ActionTypes型の値を文字列に変換します


parseActionType

public static Document.ActionTypes parseActionType(java.lang.String value)
                                            throws java.text.ParseException
文字列からActionTypes型の値に変換します

例外:
java.text.ParseException