A.1.1 PWScenarioContextクラス

PWScenarioContextクラスは、このシナリオを呼んだ利用者の情報およびセション間で持ち回る情報を提示するためのクラスです。

使用方法

参照方法

スクリプト変数名「scenarioContext」で参照します。

「PROFILE_」で始まるstatic変数をkeyに指定して、getAttribute()メソッドは、ユーザプロファイル基本情報を返します。カスタムプロファイルを取得する場合には、keyに".カスタム名"を指定し、それ以外のkeyは、セション情報を表し、setAttribute()メソッドで設定した値は、同一セション内で保持されます。makeLink()メソッドは、Portalworksを通じて呼び出すUSP、シナリオ、またはPortletアプリケーションへのURLを文字列で返します。

有効範囲: prologueScenarioタグ、prologueDocタグ以降

使用例

アクティブドックJSPでのmakeLinkメソッドの使用例を以下に示します。

<%
Hashtable param=new Hashtable();
param.put("sponsorAction","request");
param.put("httpMethod","GET");
%>
<a href="<%= scenarioContext.makeLink("WebUSP", param,
"http://www.nifty.com") %>" >@nifty</a>

JAVAインタフェース

フィールドの概要
static java.lang.String	PROFILE_COMMON_NAME 名前(common name)のkey
static java.lang.String	PROFILE_FACSIMILE_TELEPHONE_NUMBER FAX番号のkey
static java.lang.String	PROFILE_GIVEN_NAME 名のkey
static java.lang.String	PROFILE_HOME_PHONE 自宅電話番号のkey
static java.lang.String	PROFILE_HOME_POSTAL_ADDRESS 自宅住所のkey
static java.lang.String	PROFILE_LOCALE 言語種別のkey 例)ja,en
static java.lang.String	PROFILE_MAIL メールアドレスのkey
static java.lang.String	PROFILE_MOBILE 携帯番号のkey
static java.lang.String	PROFILE_POSTAL_ADDRESS 住所のkey
static java.lang.String	PROFILE_POSTAL_CODE 郵便番号のkey
static java.lang.String	PROFILE_REMOTE_ADDR ブラウザのリモートアドレスのkey
static java.lang.String	PROFILE_REMOTE_HOST ブラウザのリモートホスト名のkey
static java.lang.String	PROFILE_ROLL ロール情報のkey
static java.lang.String	PROFILE_SN 姓のkey
static java.lang.String	PROFILE_TELEPHONE_NUMBER 電話番号のkey
static java.lang.String	PROFILE_TITLE 肩書きのkey
static java.lang.String	PROFILE_UID ユーザIDのkey 値は必ず英小文字になります。

メソッドの概要
void	contentToResponse(java.lang.Object content) タグが返したコンテンツをレスポンスに乗せます。
java.lang.String	contentToString(java.lang.Object content) タグが返したコンテンツをストリングに変更します。
boolean	controlBrick(String brkCtl) 自シナリオのブリックを制御します。 brkCtl:ブリック制御文字列ブリック制御文字列の記述例: 特定のブリックを最小化(タイトルバーのみ) 「brick(コンテンツID)= doShade」指定できるブリック制御文字列については、“Portalworksスクリプト変数クラスリファレンス”を参照してください。備考1: メソッドがfalseを返した場合、詳細情報は、シナリオのデバッグファイルに出力されます。備考2: ブリック制御文字列は複数指定することができます。複数指定する場合には、区切り文字列として「;」を指定します。同一コンテンツIDに対して複数の操作文字列が指定された場合、採用される操作は不定です。
boolean	controlBrick (String service,String brkCtl) サービス名指定でブリックを制御します。 service:ブリックを制御するサービス名 brkCtl:ブリック制御文字列ブリック制御文字列の記述例: 特定のブリックを最小化(タイトルバーのみ) 「brick(コンテンツID)= doShade」指定できるブリック制御文字列については、“Portalworksスクリプト変数クラスリファレンス”を参照してください。備考1: メソッドがfalseを返した場合、詳細情報は、シナリオのデバッグファイルに出力されます。備考2: ブリック制御文字列は複数指定することができます。複数指定する場合には、区切り文字列として「;」を指定します。同一コンテンツIDに対して複数の操作文字列が指定された場合、採用される操作は不定です。備考3: このメソッドで指定したサービスは、表示されているロールに含まれている必要があります。
java.lang.Object	getAttribute(java.lang.String key) プロファイル情報、セッション情報を返します。プロファイルのカスタムフィールドを取得する場合には、keyに".カスタム名"を指定します。
String[]	getMyRoles() 当該ユーザおよび当該シナリオが属しているロール名一覧を返却します。
boolean	getRelayMode() 現在のシナリオコントローラ中継処理の通知モードを返します。 true:中継処理する、false:中継処理しない設定メソッドが呼ばれていない時のデフォルト値は、falseです。
java.lang.Object	getRootAttribute (Object key) ルートセッション情報からキー情報に対応した値情報を取り出します。ただし、このメソッドを使って、別VMにあるサービスと連携することはできません。※
java.lang.String	getRootSessionId() ルートセッション識別子を返します。
java.lang.String	makeContentLink(java.lang.String name) 当該シナリオの持つコンテンツへのURLを生成します。
java.lang.String	makeLink() 自シナリオへのURLを生成します。
java.lang.String	makeLink(java.util.Map param, java.lang.String brkCtl) ブリックの表示状態を変更するリンク文字列を作成します。 brkCtl:ブリック制御文字列ブリック制御文字列の記述例: 特定のブリックをシェード(タイトルバーのみ) 「brick(コンテンツID)= doShade」指定できるブリック制御文字列については、“Portalworksスクリプト変数クラスリファレンス”を参照してください。備考: 上記指定は複数指定することができます。複数指定する場合には、区切り文字列として「;」を指定します。同一コンテンツIDに対して複数の操作文字列が指定された場合、採用される操作は不定です。
java.lang.String	makeLink(java.lang.String name) シナリオのURLを生成します。
java.lang.String	makeLink(java.lang.String service, java.util.Map param) シナリオもしくはUSPのURLを生成します。
java.lang.String	makeLink(java.lang.String service, java.util.Map param, java.lang.String uspPathinfo) USPのURLを生成します。
java.lang.String	makeLink(java.lang.String service, java.lang.String type, java.util.Map param, java.lang.String uspPathinfo) 呼び出しタイプを指定してシナリオもしくはUSPのURLを生成します。
java.lang.String	makeQuery(java.util.Map param) WebUSPのクエリ情報を作成します。
java.lang.String	makeQuery(java.util.Map param, java.lang.String encoding) 指定されたエンコードタイプでWebUSPのクエリ情報を作成します。
java.lang.String	makeTargetUrl(java.lang.String url, java.util.Map query) WebUSPのパラメータ「targetURL」に渡すURLを生成します。
java.lang.String	pwEncode(java.lang.String src) 文字列をPortalworksの内部形式に変換します。
void	setAttribute(java.lang.String key, java.lang.Object value) プロファイル情報、セッション情報を設定します。
void	setRelayMode(boolean mode) 現在のシナリオコントローラ中継処理の通知モードを設定します。 mode true:通知する、false:通知しない
void	setRootAttribute (Object key,Object value) ルートセッション情報にキー情報と値情報の組を追加します。ただし、このメソッドを使って、別VMにあるサービスと連携することはできません。※

※setRootAttribute、getRootAttributeは、サービスが呼び出し経路に依存しないセッションを意識したいサービスに有効です。