PageHandler パーツ・プロパティー

PageHandler フィールド に固有のプロパティーを除外して、PageHandler のプロパティーは次のとおりです。 これらのプロパティーはオプションです。
alias = "alias"
生成された出力の名前に取り込まれるストリング。別名 (alias) を指定しなかった場合は、PageHandler パーツ名が代わりに使用されます。
allowUnqualifiedItemReferences = noallowUnqualifiedItemReferences = yes
構造体項目のコンテナー (構造体項目を保持しているデータ・テーブル、レコード、または書式) の名前を除外しても、コードが構造体項目を参照できるようにするかどうかを指定します。例えば、次のレコード・パーツについて考えましょう。
  Record ExampleRecordPart type basicRecord
    10 myItem01 CHAR(5);
    10 myItem02 CHAR(5);
  end
以下の変数はそのパーツに基づいています。
  myRecord ExampleRecordPart;
allowUnqualifiedItemReferences のデフォルト値 (no) を受け入れる場合、以下の代入のように myItem01 を参照するときにレコード名を指定する必要があります。
  myValue = myRecord.myItem01;
ただし、allowUnqualifiedItemReferences プロパティーを yes に設定した場合は、次に示すように、レコード名を指定する必要はありません。
  myValue = myItem01;

デフォルト値 (最良実例) を受け入れることをお勧めします。コンテナー名を指定することにより、 コードを読み取る人と EGL に対するあいまいさを減らすことができます。

EGL は規則セットを使用して変数名または項目名が参照するメモリー領域を決定します。 詳細については、『変数および定数の参照』を参照してください。

handleHardIOErrors = yes, handleHardIOErrors = no
システム変数 VGVar.handleHardIOErrors にデフォルト値を設定します。 このシステム変数は、try ブロック内の入出力操作でハード・エラーが発生した後に、プログラムを継続して実行するかどうかを制御します。 このプロパティーのデフォルト値は yes であり、この変数は 1 に設定されます。

詳細については、『VGVar.handleHardIOErrors』および『例外処理』を参照してください。

includeReferencedFunctions = noincludeReferencedFunctions = yes
PageHandler 内にも、PageHandler によってアクセスされるライブラリー内にもない各関数のコピーが PageHandler Bean に含まれるかどうかを指示します。デフォルト値は no です。これは、推奨されるように開発時に以下の規則に従う場合、 このプロパティーを無視することができることを意味します。
  • 共用関数をライブラリーに収める
  • 非共用関数を PageHandler に収める

ライブラリーに収められていない共用関数を使用している場合は、 プロパティー includeReferencedFunctionsyes に設定する場合にのみ生成が可能です。

localSQLScope = no, localSQLScope = yes
SQL 結果セットおよび作成された文の識別子が、pageHandler に対してローカルである (これがデフォルトです) かどうかを示します。 値 yes をそのまま使用すると、pageHandler から呼び出される異なる複数の プログラムが、同じ識別子を独自に使用することができます。

no を指定すると、識別子はその実行単位全体で共用されます。 現行のコード内で作成された識別子は、その他のコード内でも使用可能です。ただし、その他のコードは、localSQLScope = yes を使用して、これらの識別子の使用をブロックすることができます。また現行のコードは、他のコードで 作成された識別子を参照できます。ただし、参照できるのは、既にその他のコードが実行され、アクセスをブロックしなかった場合だけです。

SQL 識別子を共用する効果は、次のとおりです。
  • pageHandler または呼び出し先プログラムで結果セットを開き、 別のコードでその結果セットから行を取得できる。
  • 1 つのコードで SQL 文を作成し、その文を別のコードで実行できる。
msgResource = "fileName"
エラー・メッセージ表示で使用される Java™ リソース・バンドルまたはプロパティー・ファイルを識別します。 Java ランタイムはこのファイルを検索します。 このファイルは Java クラスパスでリストされたディレクトリー内になければなりません。

検索は fileName で始まる名前を持つファイルに対して行われ、その名前に付加された環境固有のロケール値を持っています。 例えば、myFile という名前のリソース・バンドルのノルウェー・バージョンは、myFile_no です。

最初にランタイム検索は、拡張子 class (リソース・バンドル用) を持つファイルに対して行われますが、そのファイルが検出されなかった場合に検索は、拡張子 properties (プロパティー・ファイル用) を持つファイルに対して行われます。

リソース・バンドルまたはプロパティー・ファイルの内容は、一連のキーおよび関連する値で構成されています。 プログラムによる EGL システム関数 sysLib.setError の呼び出しに応答して、特定の値が表示されます (呼び出しにその値のキーの使用が含まれる場合)。

onPageLoadFunction = "functionName"
関連 JSP が最初に Web ページを表示するときに制御権を受信する PageHandler 機能の名前。 この機能は、ページに表示されるデータの初期値をセットアップする場合に使用されます。このプロパティーは、以前の onPageLoad プロパティーです。

この関数に渡される引数は、『EGL での参照の互換性』に説明するように、参照の互換性がある必要があります。

scope = session, scope = request
PageHandler (ページ Bean) が、いつ Web アプリケーション・サーバー内のメモリーから除去されるかを指定します。
有効範囲が session に設定されている場合 (デフォルトのまま)
Web ページが表示された後、PageHandler はメモリー内に残ります。 次にユーザーが PageHandler 関数を起動すると、Web ページから戻された値がその関数で使用可能です。
  • 関数が forward を実行しないで終了した場合、JSF ランタイム・コードは OnPageLoad 関数を再呼び出しせずに同じ Web ページを再表示する。
  • 関数が同じページを参照する forward 文で終了した場合、状態は前のケースと同じである。 OnPageLoad 関数は再呼び出しされません。
  • 関数が他のページを参照する forward 文で終了した場合、セッションまたは要求オブジェクトのどちらかに引数を渡して値を保存しても、PageHandler 内のデータは失われる。 詳しくは『forward』を参照してください。
PageHandler の scope プロパティーが session に設定されている場合でも、その PageHandler 内のデータは、ユーザー・セッションを通して必ずしも使用可能ではありません。 例えば、PageHandler A が PageHandler B へ制御権を移す場合、以下のようなアクションがとられていない限り、PageHandler A 内のデータはもはや使用可能ではありません。
  • 新規 PageHandler にパスされる引数内にそのデータが含まれる。 あるいは
  • セッションまたは要求オブジェクトにそのデータが含まれる。 あるいは
  • リレーショナル・データベースまたはその他のデータ・ストアにそのデータが含まれる。
有効範囲が request に設定されている場合
Web ページが表示された後、PageHandler はメモリー内に残りますが、ユーザーが他の要求を実行依頼するとすぐにメモリーから除去されます。 ユーザーが PageHandler 関数を呼び出すと、以下のイベントが発生します。
  • 前の PageHandler がメモリーから除去される。
  • 要求された PageHandler が開始され (あるいは再開され)、OnPageLoad 関数が呼び出される。
  • ユーザーから受け取られたデータが、PageHandler 内の関連した変数に割り当てられる。
  • PageHandler 関数が実行され、即時イベントも、有効範囲が session に設定されている場合と同様である。
    • 関数が forward 文を実行しないで終了した場合、JSF ランタイムは OnPageLoad 関数を再呼び出しせずに同じ Web ページを再表示する。
    • 関数が同じページを参照する forward 文で終了した場合、状態は前のケースと同じである。 OnPageLoad 関数は再呼び出しされません。
    • 関数が他のページを参照する forward 文で終了した場合、セッションまたは要求オブジェクトのどちらかに引数を渡して値を保存しても、PageHandler 内のデータは失われる。 詳しくは『forward』を参照してください。

ユーザーの決定を文書化するため、このプロパティーを明示的に設定することをお勧めします。 この決定は、Web アプリケーションの設計および操作に影響を及ぼします。

throwNrfEofExceptions = no, throwNrfEofExceptions = yes

ソフト・エラーにより例外がスローされるかどうかを指定します。 デフォルトは no です。背景情報については、『例外処理』を参照してください。

title = "literal"
title プロパティーは、バインド・プロパティーです。つまり、Page Designer で作業をしている場合は、割り当て済みの値がデフォルトとして使用されます。このプロパティーは、ページのタイトルを指定します。

literal は、引用符付きストリングです。

validationBypassFunctions = ["functionNames"]
1 つ以上のイベント・ハンドラーを識別します。 これは、JSP 内のボタン・コントロールに関連付けられた PageHandler 関数です。各関数名はコンマで区切られます。

このコンテキストでイベント・ハンドラーを指定すると、イベント・ハンドラーであるか、またはそれに関係するボタンまたはハイパーテキスト・リンクをクリックしたときに、EGL ランタイムは、入力フィールドおよびページの検証をスキップします。 このプロパティーは、現在の PageHandler 処理を終わらせ、即時に別の Web リソースに制御権を転送する ユーザー・アクションを確保する場合に役立ちます。

validatorFunction = "functionName"
PageHandler のバリデーター関数を識別します。 これは、すべての項目バリデーターが呼び出された後に呼び出されます。 これについては、『EGL を使用してビルドされた Web アプリケーションの検証』で説明します。 このプロパティーは、以前の validator プロパティーです。
view = "JSPFileName"
PageHandler にバインドされている Java Server Page (JSP) の名前、およびその JSP に至るサブディレクトリー・パスを識別します。JSPFileName は、引用符付きストリングです。

デフォルト値は、ファイル拡張子 .jsp を持つ PageHandler の名前です。 このプロパティーを指定する場合、ファイル拡張子がある場合には、それを含めてください。

PageHandler を保管または生成すると、同じ名前の JSP ファイル (view プロパティーで指定した名前) が適切なフォルダー (フォルダー WebContent¥WEB-INF) 既にある場合を除き、EGL は後続のカスタマイズのためにプロジェクトに JSP ファイルを追加します。 EGL は JSP を上書きしません。

viewRootVar = "variableName"
JSF コンポーネント・ツリーにアクセスするために使用される、UIViewRoot 型の変数の名前を識別します。 詳細については、『viewRootVar プロパティー』を参照してください。

関連概念
EGL プロパティーの概要
PageHandler
viewRootVar プロパティー

関連リファレンス
EGL ソース形式の PageHandler パーツ

フィードバック
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.