com.hamaf.hikyaku.dataobject
クラス CommonMessage

java.lang.Object
  上位を拡張 com.hamaf.hikyaku.dataobject.CommonMessage
すべての実装されたインタフェース:
java.lang.Iterable<java.util.Map<java.lang.String,java.lang.String>>
直系の既知のサブクラス:
MultiCommonMessage

public class CommonMessage
extends java.lang.Object
implements java.lang.Iterable<java.util.Map<java.lang.String,java.lang.String>>

タイトル:CommonMessage is Based Message Chargo Object.

説明:基本のメッセージ保管用クラスです。


保管する項目は以下の項目です。 各領域に対する設定、取得メソッドは用意されています。
iterator()でレスポンスリストのIteratorを戻します。
値を保管するためのクラスで、それ以外のことは行いません。

著作権: Copyright (c) 2003/12/01

バージョン:
1.0
作成者:
Hamanaka

入れ子のクラスの概要
static class CommonMessage.STATUS
          errorStatus value definition.
 
コンストラクタの概要
CommonMessage()
          Creates a new CommonMessage.java instance.
 
メソッドの概要
 void addMessage(java.lang.String msg)
          Describe addMessage method : add Message List.
 void addResList(java.util.Map<java.lang.String,java.lang.String> obj)
          Describe addResList method : add resList List.
 java.lang.String getAppRoot()
           
 java.lang.String getCharCd()
           
 CommonMessage.STATUS getErrorStatus()
          Describe getErrorStatus method : ErrorStatus getter.
 java.util.Map<java.lang.String,java.lang.String> getHttpReq()
          Describe getHttpReq method : httpReq getter.
 java.util.List<java.lang.String> getMessages()
          Describe getMessages method : messageList getter.
 java.lang.String getReq(java.lang.String key)
          Describe getReq method : get HttpReqMap item and toString().
 java.lang.String getReq4JSP(java.lang.String key)
          Describe getReq4JSP method : get HttpReqMap item for JSP.
 java.util.Set<java.lang.String> getReqKeys()
          Describe getReqKeys method : return key set.
 java.lang.String getReqStr(java.lang.String key)
          Describe getReqStr method : .
 java.lang.String[] getReqValus(java.lang.String key)
          Describe getReqValus method : get HttpReqMap item.
 java.util.List<java.util.Map<java.lang.String,java.lang.String>> getResList()
          Describe getResList method : resList getter.
 java.util.Map<java.lang.String,java.lang.String> getResMessage()
          Describe getResMessage method : resMessage getter.
 java.lang.String getResMsg(java.lang.String key)
          Describe getResMsg method : get resMessage item..
 java.lang.String getResMsg4JSP(java.lang.String key)
          Describe getResMsg4JSP method : get resMessage item and toString().
 java.util.Set<java.lang.String> getResMsgKeys()
          Describe getResMsgKeys method : return key set.
 HttpSession getSession()
          Describe getSession method : HttpSession gette.
 java.lang.String getSysId()
          Get the SysId value.
 java.lang.Object getWorkBuff()
           
 java.util.ListIterator<java.util.Map<java.lang.String,java.lang.String>> iterator()
          Describe resIterator method : return resList List Iterator.
 java.util.Iterator<java.lang.String> msgIterator()
          Describe magIterator method : return MessageList Iterator.
 int resSize()
          Describe resSize method : return resList size.
 void setAppRoot(java.lang.String appRoot)
           
 void setCharCd(java.lang.String charCd)
           
 void setErrorStatus(CommonMessage.STATUS errorStI)
          Describe setErrorStatus method : ErrorStatus setter.
 void setHttpReq(java.util.Map<java.lang.String,java.lang.String> httpReq)
          Describe setHttpReq method : httpReq setter.
 void setMessages(java.util.List<java.lang.String> messages)
          Describe setMessages method : messageList setter.  
 void setReq(java.lang.String key, java.lang.String[] vals)
          Describe setReq method : set HttpReqMap item.
 void setResList(java.util.List<java.util.Map<java.lang.String,java.lang.String>> argList)
          Describe setResList method : resList setter.
 void setResMessage(java.util.Map<java.lang.String,java.lang.String> resMessage)
          Describe setResMessage method : resMessage setter.
 void setResMsg(java.lang.String key, java.lang.String val)
          Describe setResMsg method : set resMessage item.
 void setSession(HttpSession session)
          Describe setSession method : HttpSession setter.
 void setSysId(java.lang.String newSysId)
          Set the SysId value.
 void setWorkBuff(java.lang.Object workBuff)
           
 java.lang.String toErrorString()
          Describe toErrorString method : Error Message String.
 java.lang.String toRequestString()
          Describe toRequestString method : Request Map String.
 java.lang.String toResponseString()
          Describe toResponseString method : Response Map,List String.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CommonMessage

public CommonMessage()
Creates a new CommonMessage.java instance.
Default Constructor

メソッドの詳細

getErrorStatus

public final CommonMessage.STATUS getErrorStatus()
Describe getErrorStatus method : ErrorStatus getter.
エラー状態コードの取得

戻り値:
an STATUS : エラー状態コード

setErrorStatus

public final void setErrorStatus(CommonMessage.STATUS errorStI)
Describe setErrorStatus method : ErrorStatus setter.
エラー状態コードの設定

パラメータ:
errorStI - an int : エラー状態コード

getSession

public final HttpSession getSession()
Describe getSession method : HttpSession gette.
HttpSessionの取得

戻り値:
a HttpSession : HttpSession

setSession

public final void setSession(HttpSession session)
Describe setSession method : HttpSession setter.
HttpSessionの設定

パラメータ:
session - a HttpSession : HttpSession

getMessages

public final java.util.List<java.lang.String> getMessages()
Describe getMessages method : messageList getter.
メッセージリストの取得

戻り値:
a List : メッセージリスト

setMessages

public final void setMessages(java.util.List<java.lang.String> messages)
Describe setMessages method : messageList setter.  
メッセージリストの設定

パラメータ:
messages - a List : メッセージリスト

getHttpReq

public final java.util.Map<java.lang.String,java.lang.String> getHttpReq()
Describe getHttpReq method : httpReq getter.
リクエストテーブルの取得

戻り値:
a Map : リクエストテーブル

setHttpReq

public final void setHttpReq(java.util.Map<java.lang.String,java.lang.String> httpReq)
Describe setHttpReq method : httpReq setter.
リクエストテーブルの設定

パラメータ:
httpReq - a Map : リクエストテーブル

getResMessage

public final java.util.Map<java.lang.String,java.lang.String> getResMessage()
Describe getResMessage method : resMessage getter.
レスポンステーブルの取得

戻り値:
a Map : レスポンステーブル

setResMessage

public final void setResMessage(java.util.Map<java.lang.String,java.lang.String> resMessage)
Describe setResMessage method : resMessage setter.
レスポンステーブルの設定

パラメータ:
resMessage - a Map : レスポンステーブル

getResList

public final java.util.List<java.util.Map<java.lang.String,java.lang.String>> getResList()
Describe getResList method : resList getter.
レスポンスリストの取得

戻り値:
a List : レスポンスリスト

setResList

public final void setResList(java.util.List<java.util.Map<java.lang.String,java.lang.String>> argList)
Describe setResList method : resList setter.
レスポンスリストの設定

パラメータ:
argList - a List : レスポンスリスト

getSysId

public final java.lang.String getSysId()
Get the SysId value.

戻り値:
a String :

setSysId

public final void setSysId(java.lang.String newSysId)
Set the SysId value.

パラメータ:
newSysId - The new SysId value.

getCharCd

public final java.lang.String getCharCd()
戻り値:
charCd

setCharCd

public final void setCharCd(java.lang.String charCd)
パラメータ:
charCd - : charCd を設定します。

getWorkBuff

public final java.lang.Object getWorkBuff()
戻り値:
workBuff

setWorkBuff

public final void setWorkBuff(java.lang.Object workBuff)
パラメータ:
workBuff - : workBuff を設定します。

getAppRoot

public final java.lang.String getAppRoot()
戻り値:
appRoot を取得します。

setAppRoot

public final void setAppRoot(java.lang.String appRoot)
パラメータ:
appRoot - appRoot を設定します。

addMessage

public void addMessage(java.lang.String msg)
Describe addMessage method : add Message List.
メッセージ用リストにメッセージを追加する。
JSPでの表示用にコード変換、タグ文字変換を行います。


msgIterator

public final java.util.Iterator<java.lang.String> msgIterator()
Describe magIterator method : return MessageList Iterator.
メッセージリストのイテレータを返却する。

戻り値:
a Iterator : メッセージリストのIterator

setReq

public void setReq(java.lang.String key,
                   java.lang.String[] vals)
Describe setReq method : set HttpReqMap item.
リクエストテーブルに項目を設定します。

パラメータ:
key - a String : 設定する項目のキー値
val - an String : 設定する値

getReqValus

public java.lang.String[] getReqValus(java.lang.String key)
Describe getReqValus method : get HttpReqMap item.
リクエストテーブルからキー値で指定された項目のString配列を戻します。

パラメータ:
key - a String : 取得する値のキー値
戻り値:
a String : : キー値に対応した項目の String[] 値

getReq

public java.lang.String getReq(java.lang.String key)
Describe getReq method : get HttpReqMap item and toString().
リクエストテーブルからキー値で指定された項目の値を戻します。
値ObjectがString配列の場合はtabで接続して戻します。

パラメータ:
key - a String : 取得する値のキー値
戻り値:
a String : : キー値に対応した項目の String 値

getReqStr

public java.lang.String getReqStr(java.lang.String key)
Describe getReqStr method : .
リクエストテーブルからキー値で指定された項目の値を戻します。
キー値が存在しない場合は長さ0の文字列("")を戻します。

パラメータ:
key - a String : 取得する値のキー値
戻り値:
a String : : キー値に対応した項目の String 値

getReq4JSP

public java.lang.String getReq4JSP(java.lang.String key)
Describe getReq4JSP method : get HttpReqMap item for JSP.
リクエストテーブルからキー値で指定された項目の値を戻します。
JSPでの表示用にコード変換、タグ文字変換を行います。

パラメータ:
key - a String : 取得する値のキー値
戻り値:
a String : : キー値に対応した項目の JSP用の値

getReqKeys

public final java.util.Set<java.lang.String> getReqKeys()
Describe getReqKeys method : return key set.
リクエストテーブルのキー値の配列(Set)を戻します。

戻り値:
a Set : キー値の配列

setResMsg

public void setResMsg(java.lang.String key,
                      java.lang.String val)
Describe setResMsg method : set resMessage item.
レスポンスメッセージに項目値を設定します。

パラメータ:
key - a String : 設定する項目のキー値
val - a String : 設定する項目の値

getResMsg

public java.lang.String getResMsg(java.lang.String key)
Describe getResMsg method : get resMessage item..
レスポンスメッセージからキー値で指定された項目を取得します。

パラメータ:
key - a String : 取得する値のキー値
戻り値:
a String : キー値に対応した値

getResMsg4JSP

public java.lang.String getResMsg4JSP(java.lang.String key)
Describe getResMsg4JSP method : get resMessage item and toString().
レスポンスメッセージからキー値で指定された項目のtoString()値を戻します。
JSPでの表示用にコード変換、タグ文字変換を行います。

パラメータ:
key - a String : 取得する値のキー値
戻り値:
a String : : キー値に対応した項目の JSP用の値

getResMsgKeys

public final java.util.Set<java.lang.String> getResMsgKeys()
Describe getResMsgKeys method : return key set.
レスポンスメッセージのキー値の配列(Set)を戻します。

戻り値:
a Set : キー値の配列

addResList

public void addResList(java.util.Map<java.lang.String,java.lang.String> obj)
Describe addResList method : add resList List.
レスポンス用リストに一覧表示用の項目を追加する。

パラメータ:
obj - a Map : Map形式の一覧表示項目

iterator

public final java.util.ListIterator<java.util.Map<java.lang.String,java.lang.String>> iterator()
Describe resIterator method : return resList List Iterator.
レスポンス用リストのリストイテレータを返却する。

定義:
インタフェース java.lang.Iterable<java.util.Map<java.lang.String,java.lang.String>> 内の iterator
戻り値:
a Iterator : レスポンス用リストのIterator

resSize

public final int resSize()
Describe resSize method : return resList size.
レスポンス用リストのサイズを返却する。

戻り値:
a int : レスポンス用リストのsize

toErrorString

public java.lang.String toErrorString()
Describe toErrorString method : Error Message String.
エラー情報の文字列表現を戻します。

戻り値:
a String : エラー情報の文字列表現

toRequestString

public java.lang.String toRequestString()
Describe toRequestString method : Request Map String.
リクエスト情報Mapの文字列表現を戻します。

戻り値:
a String : リクエスト情報Mapの文字列表現

toResponseString

public java.lang.String toResponseString()
Describe toResponseString method : Response Map,List String.
レスポンス情報のMap,Listの文字列表現を戻します。

戻り値:
a String : レスポンス情報のMap,Listの文字列表現