ClientContext (PEXA API Document)

既知のサブインタフェースのリスト:

DialogContext

既知の実装クラスのリスト:

SimpleClientContext, SimpleDialogContext
```
public interface ClientContext
```
クライアントの実行コンテキストを表すインタフェース。以下の役割を持つ。
1. ViewManager,ContentManagerにおける各管理オブジェクトのキー
2. 実行セッションへのアクセス手段の提供
バージョン:

$Revision: 3266 $ $Date:: 2009-02-28 00:41:10 #$

作成者:

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`void`	`addClientContextEventListener(ClientContextEventListener scl)` Contextイベントリスナーを登録する
`void`	`close()` Contextを終了する
`void`	`closeOnError()` 初期化エラー発生時の終了処理を行う (internal use only)
`boolean`	`containsPlatformResource(java.lang.String key)` 指定したキーの制御リソースが存在しているかチェックする
`ClientContext`	`createChild()` 新たな子コンテキストを生成する
`ClientContext`	`createDialog()` 新たなダイアログコンテキストを生成する
`ClientContext[]`	`getChildren()` 子コンテキストオブジェクトを配列で取得する
`ClientContextEventListener[]`	`getClientContextEventListeners()` リスナー配列を取得する
`ClientSession`	`getClientSession()` Clientの実行コンテキストを取得する
`java.lang.String`	`getContextName()` このコンテキストに付けられた名称を取得する。
`java.lang.String`	`getContextSituation()` このコンテキストの業務的な状況名を取得する。
`DialogContext`	`getDialogContext()` isDialogContext() == trueの場合にこのコンテキストをDialogContextに変換して返す
`DialogContext[]`	`getDialogs()` ダイアログコンテキストオブジェクトを配列で取得する
`ClientManager`	`getManager(java.lang.String key)` ClientのManagerを取得する。
`ClientContext`	`getParent()` 親になるコンテキストを取得する
`java.lang.Object`	`getPlatformResource(java.lang.String key)` 制御リソースを取得する。
`boolean`	`isDialogContext()` このコンテキストがDialogContextかを返す
`boolean`	`isRoot()` このコンテキストがルートコンテキストかを返す
`void`	`removeChild(ClientContext child)` 子コンテキストの解放処理を行う
`void`	`removeClientContextEventListener(ClientContextEventListener scl)` Contextイベントリスナーを削除する
`void`	`removeDialog(ClientContext dialog)` ダイアログコンテキストの解放処理を行う
`void`	`setCloseEventName(java.lang.String event)` コンテキストの終了イベント名を任意の名称で設定する
`void`	`setContextName(java.lang.String name)` このコンテキストに名称を設定する
`void`	`setContextSituation(java.lang.String situation)` このコンテキストに業務的な状況名を設定する。

- メソッドの詳細
  - getClientSession
```
ClientSession getClientSession()
```
    Clientの実行コンテキストを取得する
    
    戻り値:
    
    クライアントコンテキストオブジェクト
  - getManager
```
ClientManager getManager(java.lang.String key)
```
    ClientのManagerを取得する。
    getClientSession().getManager(key)と等価。
    
    パラメータ:
    
    key - Managerを特定するキー文字列
    
    戻り値:
    
    Managerインスタンス
  - getPlatformResource
```
java.lang.Object getPlatformResource(java.lang.String key)
```
    制御リソースを取得する。
    getClientSession().getPlatformResource(key)と等価。
    
    パラメータ:
    
    key - 制御リソースを表すキー
    
    戻り値:
    
    制御リソース
  - containsPlatformResource
```
boolean containsPlatformResource(java.lang.String key)
```
    指定したキーの制御リソースが存在しているかチェックする
    
    パラメータ:
    
    key - 有無チェック対象の制御リソースキー
    
    戻り値:
    
    あればtrue,なければfalse
  - createChild
```
ClientContext createChild()
```
    新たな子コンテキストを生成する
    
    戻り値:
    
    新たに生成された子Context
  - removeChild
```
void removeChild(ClientContext child)
```
    子コンテキストの解放処理を行う
    
    パラメータ:
    
    child - 解放対象のContext
  - getParent
```
ClientContext getParent()
```
    親になるコンテキストを取得する
    
    戻り値:
    
    親Context
  - getChildren
```
ClientContext[] getChildren()
```
    子コンテキストオブジェクトを配列で取得する
    
    戻り値:
    
    子Contextの配列
  - createDialog
```
ClientContext createDialog()
```
    新たなダイアログコンテキストを生成する
    
    戻り値:
    
    新たに生成されたDialogContext
  - removeDialog
```
void removeDialog(ClientContext dialog)
```
    ダイアログコンテキストの解放処理を行う
    
    パラメータ:
    
    dialog - 解放対象のContext
  - getDialogs
```
DialogContext[] getDialogs()
```
    ダイアログコンテキストオブジェクトを配列で取得する
    
    戻り値:
    
    DialogContextの配列
  - addClientContextEventListener
```
void addClientContextEventListener(ClientContextEventListener scl)
```
    Contextイベントリスナーを登録する
    
    パラメータ:
    
    scl - 登録するリスナーオブジェクト
  - getClientContextEventListeners
```
ClientContextEventListener[] getClientContextEventListeners()
```
    リスナー配列を取得する
    
    戻り値:
    
    リスナーリストのコピー配列
  - removeClientContextEventListener
```
void removeClientContextEventListener(ClientContextEventListener scl)
```
    Contextイベントリスナーを削除する
    
    パラメータ:
    
    scl - 削除するリスナーオブジェクト
  - close
```
void close()
```
    Contextを終了する
  - closeOnError
```
void closeOnError()
```
    初期化エラー発生時の終了処理を行う (internal use only)
  - setCloseEventName
```
void setCloseEventName(java.lang.String event)
```
    コンテキストの終了イベント名を任意の名称で設定する
    
    パラメータ:
    
    event - コンテキスト終了時のイベント名
  - getContextName
```
java.lang.String getContextName()
```
    このコンテキストに付けられた名称を取得する。
    
    戻り値:
    
    コンテキスト名称。なければnull。
  - setContextName
```
void setContextName(java.lang.String name)
```
    このコンテキストに名称を設定する
    
    パラメータ:
    
    name - コンテキスト名称
  - getContextSituation
```
java.lang.String getContextSituation()
```
    このコンテキストの業務的な状況名を取得する。
    
    戻り値:
    
    コンテキスト状況名。なければnull。
  - setContextSituation
```
void setContextSituation(java.lang.String situation)
```
    このコンテキストに業務的な状況名を設定する。
  - isRoot
```
boolean isRoot()
```
    このコンテキストがルートコンテキストかを返す
    
    戻り値:
    
    ルートコンテキストならtrue, 違うならfalse
  - isDialogContext
```
boolean isDialogContext()
```
    このコンテキストがDialogContextかを返す
    
    戻り値:
    
    DialogContextならtrue, 違うならfalse
  - getDialogContext
```
DialogContext getDialogContext()
```
    isDialogContext() == trueの場合にこのコンテキストをDialogContextに変換して返す
    
    戻り値:
    
    DialogContextに変換した自分自身

インタフェース ClientContext

メソッドのサマリー

メソッドの詳細

getClientSession

getManager

getPlatformResource

containsPlatformResource

createChild

removeChild

getParent

getChildren

createDialog

removeDialog

getDialogs

addClientContextEventListener

getClientContextEventListeners

removeClientContextEventListener

close

closeOnError

setCloseEventName

getContextName

setContextName

getContextSituation

setContextSituation

isRoot

isDialogContext

getDialogContext