uCosminexus Portal Framework　ポートレット開発ガイド

jp.co.hitachi.soft.portal.om.security.PortalUserAccount

機能

ポータルのユーザアカウント情報を取得，設定するクラスです。

メソッドの一覧

戻り値のデータ型	メソッド	説明
String	getUserName()	ユーザIDを取得します。
String	getDispName()	ユーザ名を取得します。
String[]	getTitle()	役職名を取得します。
String[]	getOU()	所属組織IDを取得します。
String[]	getParameter(String key)	ユーザに対する特定のマッピング項目を取得します。
void	setDispName(String name)	ユーザ名を設定します。
void	setTitle(String[] titles)	役職名を設定します。
void	setOU(String[] ou)	所属組織IDを設定します。
void	setParameter(String key, String[] value)	ユーザに対する特定のマッピング項目を設定します。

メソッドの説明

getUserName

形式

String getUserName()

機能

ユーザアカウント情報からユーザIDを取得します。

このオブジェクトが持っているキャッシュからユーザIDを取得します。

パラメタ

なし

戻り値

ユーザID

例外

なし

getDispName

形式

String getDispName()

機能

ユーザアカウント情報からユーザ名を取得します。

このオブジェクトが持っているキャッシュからユーザ名を取得します。キャッシュにユーザ名がない場合は，ユーザIDをキーにしてリポジトリから取得します。なお，ユーザ名が設定されていない場合は，ユーザIDが戻り値となります。

パラメタ

なし

戻り値

ユーザ名

例外

なし

getTitle

形式

String[] getTitle()

機能

ユーザアカウント情報からユーザの役職名を取得します。

このオブジェクトが持っているキャッシュから役職名を取得します。キャッシュに役職名がない場合は，ユーザIDをキーにしてリポジトリから取得します。役職名が設定されていない場合，およびマッピング情報の設定で役職が設定されていない場合は，空のリストが戻り値となります。

パラメタ

なし

戻り値

役職名のリスト

例外

なし

getOU

形式

String[] getOU()

機能

ユーザアカウント情報から所属組織ID（ユーザが所属している組織のID）を取得します。

このオブジェクトが持っているキャッシュから所属組織IDを取得します。キャッシュに所属組織IDがない場合は，ユーザIDをキーにしてリポジトリから取得します。所属組織IDは，ユーザが所属している最下位の組織のIDだけを取得し，上位組織のIDは取得しません。ユーザが組織に所属していない場合，およびマッピング情報の設定で組織情報が設定されていない場合は，空のリストが戻り値となります。

パラメタ

なし

戻り値

所属組織ID

例外

なし

getParameter

形式

String[] getParameter(String key)

機能

ユーザアカウント情報から特定のマッピング項目を取得します。

値が一つだけの場合，長さ1のString配列の最初（0番目）に格納されます。

このオブジェクトが持っているキャッシュからマッピング項目を取得します。キャッシュにマッピング項目がない場合は，ユーザIDをキーにしてリポジトリから取得します。リポジトリにユーザ情報または対象データがない場合は，空のリストが戻り値となります。

なお，このオブジェクトの戻り値は，PortalUserAccountオブジェクトのメンバそのものでなく，オブジェクトのコピーとなります。

パラメタ

key - ユーザのマッピング情報のキー項目名

戻り値

キー項目名にマッピングされている値を格納したリスト

例外

IllegalArgumentException - 入力パラメタが次の値の場合に発生します。

• null
• LOGIN_NAME
• NAME
• ParsonalizeKey
• TITLE
• DEPARTMENT

setDispName

形式

void setDispName(String name)

機能

ユーザ名を設定します。

パラメタ

name - ユーザ名

戻り値

なし

例外

なし

setTitle

形式

void setTitle(String[] titles)

機能

役職名を設定します。

パラメタ

titles - 役職名のリスト

戻り値

なし

例外

なし

setOU

形式

void setOU(String[] ou)

機能

所属組織ID（ユーザが所属している組織のID）を設定します。

パラメタ

ou - 所属組織IDのリスト

戻り値

なし

例外

なし

setParameter

形式

void setParameter(String key, String[] value)

機能

ユーザアカウント情報に特定のマッピング項目を設定します。

値が一つだけの場合，長さ1のString配列の最初（0番目）に格納します。

このオブジェクトが持っているキャッシュだけにマッピング項目を設定し，リポジトリには設定しません。

パラメタ

key - 値を格納するキー項目名

value - キー項目名にマッピングする値のリスト

戻り値

なし

例外

IllegalArgumentException - 入力パラメタが次の値の場合に発生します。

• null
• LOGIN_NAME
• NAME
• ParsonalizeKey
• TITLE
• DEPARTMENT
• リポジトリ情報ファイルに未定義のキー項目名

[目次][前へ][次へ]

All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi INS Software, Ltd.