portalLib は、ポータル Web 環境で実行するように設計された EGL プログラム用の、EGL システム・ライブラリーです。 この環境では Web ブラウザーからアプリケーションを起動することができますが、その処理の大半は、IBM® WebSphere® Portal Server V6.0 上で実行されるポートレット内で実行されます。
これらの関数は、ポータル・アプリケーションの一部として実行される JSF ハンドラー内でのみ、有用です。 ポートレット・コンテナーの外側で portalLib 関数を呼び出すと、エラーが発生します。
下の表に、portalLib ライブラリー内のシステム関数を示します。
| 関数 | 説明 |
|---|---|
| clearPortletSessionAttr(key, scope) | 指定の PortletSession スコープから、指定のキーと関連付けられている値を除去します。 |
| value = createVaultSlot(resourceName, secretType, active, portletPrivate) | ユーザー管理のボールト・セグメントに新規のクレデンシャル・ボールト・スロットを作成します。 |
| deleteVaultSlot(slotID) | 指定の slotId を持つユーザー・ボールト・スロットを削除します。 |
| getCredential(slotID, userid, password) | 指定のクレデンシャル・ボールト・スロットからユーザー ID およびパスワードを取り出します。 |
| value = getPortletMode() | 現行のポートレット・モードを返します。 |
| value = getPorteltSessionAttr(key, scope) | 指定のキーを使用して、PortletSession の指定のスコープから値を取り出します。 |
| value = getPreferenceValue(key, defaultValue?) | ポータル設定ストアから、指定のキーと関連付けられている最初の値を取り出します。 |
| value = getPreferenceValues(key, defaultValue[]) | 指定の設定キーと関連付けられているストリングの配列を返します。 |
| value[] = getWindowState() | 現在のウィンドウの状態を返します。 |
| value = isPreferenceReadOnly(key) | 指定のキーを持つ設定が読み取り専用である場合に true を返します。 |
| resetPreference(key) | 指定のキーと関連付けられている設定値をリセットまたは除去します。 |
| savePreferences() | set メソッドを使用して設定に行ったすべての変更を、永続設定ストアにコミットします。 |
| setCredential(slotId, userId, password) | 指定の ID を持つクレデンシャル・ボールト・スロットのユーザー ID およびパスワードの値を設定します。 |
| setPortletMode(mode) | ポートレット・モードを設定します。 |
| setPortletSessionAttr(key, value, scope) | 指定のキーを使用して、指定のスコープで PortletSession 属性の値を設定します。 |
| setPreferenceValue(key, value) | 指定の値と、設定ストア内の指定のキーを関連付けます。 |
| setPreferenceValues(key, values) | 指定の値配列と、設定ストア内の指定のキーを関連付けます。 |
| setWindowState(state) | ポートレットのウィンドウの状態を変更します。 |
| プラットフォーム | 問題 |
|---|---|
| COBOL 生成 | portalLib 関数はどれもサポートされません。 |