org.pslx.PpsDocuments
クラス Header

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

public final class Header
extends java.lang.Object

業務ドキュメントに付加するヘッダ情報を保持するクラスです。

業務ドキュメントに1つだけ設定可能です。 ヘッダには、業務ドキュメントの本体として設定された 業務オブジェクトと同じ種類の業務プロパティを設定する場合と、 ヘッダ独自に異なる種類の業務オブジェクトの内容を設定する場合があります。

バージョン:
1.6.004

フィールドの概要
 java.lang.String title
           
 
メソッドの概要
 Property addProperty(java.lang.String name)
          指定名のプロパティを生成し、追加します。
 Property createProperty(java.lang.String name)
          指定名のプロパティを追加します。
 java.lang.Object get(java.lang.String name)
          ヘッダ要素に含まれる指定したプロパティの値を取得します
 java.lang.String getObjectId()
          対象オブジェクトIDを取得します
 java.lang.String getObjectName()
          対象となる業務オブジェクトの名称を取得します
 int getOffset()
          オフセット(読み飛ばし)数を取得します
 java.util.List<Property> getProperties()
          ヘッダ要素に含まれるプロパティのリストを取得します
 Property getProperty(java.lang.String name)
          ヘッダ用プロパティを取得します
 java.lang.Object getPropertyValue(java.lang.String name)
          ヘッダ用プロパティの値を取得します
 java.lang.String getTitle()
          業務ドキュメントのタイトルを取得します
 int getTotalObjectCount()
          業務オブジェクト数を取得します
 java.lang.String getXmlString()
          ヘッダ要素の内容を表すXML文字列を取得します
 void set(java.lang.String name, java.lang.Object value)
          ヘッダ要素に含まれる指定したプロパティの値を取得します
 void setObjectId(java.lang.String value)
          対象オブジェクのIDを設定します
 void setOffset(int value)
          オフセット(読み飛ばし)数を設定します
 void setTitle(java.lang.String value)
          業務ドキュメントのタイトルを設定します
 void setTotalObjectCount(int value)
          業務オブジェクト数を設定します
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

title

public java.lang.String title
メソッドの詳細

getObjectId

public java.lang.String getObjectId()
対象オブジェクトIDを取得します


setObjectId

public void setObjectId(java.lang.String value)
対象オブジェクのIDを設定します

パラメータ:
value - 対象オブジェクトID

getObjectName

public java.lang.String getObjectName()
対象となる業務オブジェクトの名称を取得します


getTitle

public java.lang.String getTitle()
業務ドキュメントのタイトルを取得します


setTitle

public void setTitle(java.lang.String value)
業務ドキュメントのタイトルを設定します


getTotalObjectCount

public int getTotalObjectCount()
業務オブジェクト数を取得します


setTotalObjectCount

public void setTotalObjectCount(int value)
業務オブジェクト数を設定します


getOffset

public int getOffset()
オフセット(読み飛ばし)数を取得します


setOffset

public void setOffset(int value)
オフセット(読み飛ばし)数を設定します


getProperties

public java.util.List<Property> getProperties()
ヘッダ要素に含まれるプロパティのリストを取得します


get

public java.lang.Object get(java.lang.String name)
ヘッダ要素に含まれる指定したプロパティの値を取得します

パラメータ:
name - プロパティ名

set

public void set(java.lang.String name,
                java.lang.Object value)
         throws PpsDocumentsException
ヘッダ要素に含まれる指定したプロパティの値を取得します

パラメータ:
name - プロパティ名
value - 設定値
例外:
PpsDocumentsException

getProperty

public Property getProperty(java.lang.String name)
ヘッダ用プロパティを取得します

パラメータ:
name - プロパティ名
戻り値:
ヘッダ用プロパティ

createProperty

public Property createProperty(java.lang.String name)
                        throws PpsDocumentsException
指定名のプロパティを追加します。 存在する場合は、例外が発生します。 "user:"で始まる拡張プロパティを指定することも可能です。

パラメータ:
name - プロパティ名
戻り値:
追加されたプロパティ
例外:
PpsDocumentsException

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String name)
ヘッダ用プロパティの値を取得します

パラメータ:
name - プロパティ名
戻り値:
プロパティの値

addProperty

public Property addProperty(java.lang.String name)
                     throws PpsDocumentsException
指定名のプロパティを生成し、追加します。 すでに存在する場合は、存在するものを取得します。

パラメータ:
name - プロパティ名
戻り値:
プロパティ
例外:
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