uCosminexus Portal Framework　システム管理者ガイド

jp.co.hitachi.soft.portal.portal.portlets.beans.DeviceBean

機能

各クライアントのレイアウトカスタマイズ画面を構成するBeanです。

Beanの項目

宣言

このBeanを単独で宣言できません。

対象スコープ

なし

メソッドの一覧

戻り値のデータ型メソッド説明

PortletEntryBean [] getAvailablePortletEntryBeans(java.lang.String pattern, int column) このクライアントで選択できるポートレットのPortletEntryBeanを取得します。

PortletEntryBean [] getAvailablePortletEntryBeansByGroup(java.lang.String group, java.lang.String pattern, int column) 指定したポートレットグループに所属する，このクライアントで選択できるポートレットのPortletEntryBeanを取得します。

PortletGroupBean [] getAvailablePortletGroupBeans(java.lang.String pattern, int column) このクライアントで選択できるポートレットが所属するポートレットグループのPortletGroupBeanを取得します。

java.lang.String[] getAvailablePortletNames() クライアントで使用できるポートレット名称の一覧を取得します。

java.lang.String[] getAvailablePortletTitles() このクライアントで実際に画面上に表示していて使用できるポートレットタイトル名称の一覧を取得します。

int getDeviceCode() クライアント種別を取得します。

LayoutBean getLayoutBean() 標準画面レイアウトオブジェクトを取得します。

LayoutEntryBean[] getAvailableLayoutEntryBeans() このクライアントで選択できるレイアウトのLayoutEntryBeanを取得します。

java.lang.String[] getLayoutGroup() レイアウトグループの一覧を取得します。

void setLayoutBean(LayoutBean layout) 標準画面レイアウトオブジェクトを設定します。

戻り値のデータ型	メソッド	説明
PortletEntryBean []	getAvailablePortletEntryBeans(java.lang.String pattern, int column)	このクライアントで選択できるポートレットのPortletEntryBeanを取得します。
PortletEntryBean []	getAvailablePortletEntryBeansByGroup(java.lang.String group, java.lang.String pattern, int column)	指定したポートレットグループに所属する，このクライアントで選択できるポートレットのPortletEntryBeanを取得します。
PortletGroupBean []	getAvailablePortletGroupBeans(java.lang.String pattern, int column)	このクライアントで選択できるポートレットが所属するポートレットグループのPortletGroupBeanを取得します。
java.lang.String[]	getAvailablePortletNames()	クライアントで使用できるポートレット名称の一覧を取得します。
java.lang.String[]	getAvailablePortletTitles()	このクライアントで実際に画面上に表示していて使用できるポートレットタイトル名称の一覧を取得します。
int	getDeviceCode()	クライアント種別を取得します。
LayoutBean	getLayoutBean()	標準画面レイアウトオブジェクトを取得します。
LayoutEntryBean[]	getAvailableLayoutEntryBeans()	このクライアントで選択できるレイアウトのLayoutEntryBeanを取得します。
java.lang.String[]	getLayoutGroup()	レイアウトグループの一覧を取得します。
void	setLayoutBean(LayoutBean layout)	標準画面レイアウトオブジェクトを設定します。

メソッドの説明

getAvailablePortletEntryBeans
形式
PortletEntryBean[] getAvailablePortletEntryBeans(java.lang.String pattern,int column)
機能

このクライアントで選択できるポートレットのPortletEntryBeanを取得します。

パラメタ

pattern - レイアウトパターン名（ユーザ登録形式の場合指定）

column - 列番号（ユーザ登録形式の場合指定）

なお，レイアウトパターンの列ごとに選択できるポートレットが異なるためパラメタには，次の値を指定します。

pattern
ユーザ登録形式の場合：レイアウトパターン名
ユーザ登録形式以外の場合：null

column
ユーザ登録形式の場合：列番号（１以上）
ユーザ登録形式以外の場合：0

戻り値

ポートレットが存在する場合は，使用できるポートレットのPortletEntryBeanオブジェクト一覧を，それ以外はnullを返却します。

例外

IllegalArgumentException - 不正なパラメタを指定した場合，およびpatternにnull以外を指定し，columnに存在しない列番号を指定した場合。
getAvailablePortletEntryBeansByGroup
形式
PortletEntryBean[] getAvailablePortletEntryBeansByGroup(java.lang.String group,
                                    java.lang.String pattern,
                                    int column)
機能

指定したポートレットグループに所属し，このクライアントで選択できるポートレットのPortletEntryBeanを取得します。

パラメタ

group - ポートレットグループ名

pattern - レイアウトパターン名（ユーザ登録形式の場合指定）

column - 列番号（ユーザ登録形式の場合指定）

なお，レイアウトパターンの列ごとに選択できるポートレットが異なるためパラメタには，次の値を指定します。

group
ポートレットグループに所属するポートレットを取得する場合：ポートレットグループ名
ポートレットグループに所属しないポートレットを取得する場合：null

pattern
ユーザ登録形式の場合：レイアウトパターン名
ユーザ登録形式以外の場合：null
column
ユーザ登録形式の場合：列番号（１以上）
ユーザ登録形式以外の場合：0

戻り値

ポートレットが存在する場合は，使用できるポートレットのPortletEntryBeanオブジェクト一覧を，それ以外はnullを返却します。

例外

IllegalArgumentException - 不正なパラメタを指定した場合，およびpatternにnull以外を指定し，columnに存在しない列番号を指定した場合。
getAvailablePortletGroupBeans
形式
PortletGroupBean[] getAvailablePortletGroupBeans(java.lang.String pattern,int column)
機能

このクライアントで選択できるポートレットが所属するポートレットグループのPortletGroupBeanを取得します。

パラメタ

pattern - レイアウトパターン名（ユーザ登録形式の場合指定）

column - 列番号（ユーザ登録形式の場合指定）

なお，レイアウトパターンの列ごとに選択できるポートレットが異なるためパラメタには，次の値を指定します。

pattern
ユーザ登録形式の場合：レイアウトパターン名
ユーザ登録形式以外の場合：null

column
ユーザ登録形式の場合：列番号（１以上）
ユーザ登録形式以外の場合：0

戻り値

ポートレットが存在する場合は，使用できるポートレットのPortletGroupBeanオブジェクト一覧を，それ以外はnullを返却します。

例外

IllegalArgumentException - 不正なパラメタを指定した場合，およびpatternにnull以外を指定し，columnに存在しない列番号を指定した場合。
getAvailablePortletNames
形式
public java.lang.String[] getAvailablePortletNames()
機能

このクライアントで使用できるポートレット名称の一覧を取得します。ポートレットグループを使用していない場合に使用します。

パラメタ

なし

戻り値

使用できるポートレット名称の一覧

例外

なし
getAvailablePortletTitles
形式
public java.lang.String[] getAvailablePortletTitles()
機能

このクライアントで実際に画面上に表示していて使用できるポートレットタイトル名称の一覧を取得します。ポートレットグループを使用していない場合に使用します。

パラメタ

なし

戻り値

使用できるポートレットタイトル名称の一覧

例外

なし
getDeviceCode
形式
public int getDeviceCode()
機能

クライアント種別を取得します。

パラメタ

なし

戻り値

次のどれかの値が戻されます。

値内容

LayoutCustomizeBean.HTML PCブラウザ用画面

LayoutCustomizeBean.CHTML iモード用画面

LayoutCustomizeBean.HDML EZweb用画面

例外

なし
getLayoutBean
形式
public LayoutBean getLayoutBean()
機能

標準画面レイアウトオブジェクトを取得します。

パラメタ

なし

戻り値

LayoutBeanオブジェクト

例外

なし
getAvailableLayoutEntryBeans
形式
LayoutEntryBean[] getAvailableLayoutEntryBeans()
機能

このクライアントで選択できるレイアウトのLayoutEntryBeanの一覧を取得します。

パラメタ

なし

戻り値

選択できるレイアウトのLayoutEntryBeanの一覧を返却します。このレイアウトには，ユーザが定義したレイアウト名称なしのレイアウトも含みます。

選択できるレイアウトが存在しない場合は，空配列を返却します。

例外

なし
getLayoutGroup
形式
public java.lang.String[] getLayoutGroup()
機能

クライアントのレイアウトグループの一覧を取得します。

パラメタ

なし

戻り値

レイアウトグループの一覧

「デフォルト」のレイアウトグループがある場合は，nullを配列に格納して返却します。

例外

なし
setLayoutBean
形式
public void setLayoutBean(LayoutBean layout)
機能

標準画面レイアウトオブジェクトを設定します。

パラメタ

layout - 設定する標準画面レイアウトオブジェクト

戻り値

なし

例外

なし

値	内容
LayoutCustomizeBean.HTML	PCブラウザ用画面
LayoutCustomizeBean.CHTML	iモード用画面
LayoutCustomizeBean.HDML	EZweb用画面

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

[他社商品名称に関する表示]