PortletManagerオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.19 |
since | 6.0 |
PortletManagerオブジェクト。
ポートレットに関連する情報の参照、更新を行うマネージャオブジェクトです。
ポートレット情報を操作するオブジェクトの構成は以下の通りです。
ポートレット情報オブジェクト
ポートレットタイトル情報オブジェクトの構成は以下の通りです。
ポートレットタイトル情報オブジェクト
ポートレットモード情報オブジェクトの構成は以下の通りです。
ポートレットモード情報オブジェクト
処理結果オブジェクトの構成は以下の通りです。
処理結果オブジェクトの data 属性は検索処理が成功 (error ステータスが false) の場合にのみ定義されます。
data属性には、呼び出されたメソッドの結果に応じたオブジェクトが設定されます。
処理結果オブジェクト
ポートレットに関連する情報の参照、更新を行うマネージャオブジェクトです。
ポートレット情報を操作するオブジェクトの構成は以下の通りです。
ポートレット情報オブジェクト
ポートレット情報 オブジェクト (Object) |
portletCode [必須] ポートレットコード (String) | ||
portletTypeName [必須] ポートレットタイプ名 (String) 指定できるポートレットタイプ名の値は以下のいずれか ・JspPortlet :Servlet/JSP ポートレット ・PresentationPagePortlet :プレゼンテーションページポートレット ・JavaeeFwPortlet :IM-J2EE Service Framework ポートレット ・SAStrutsPortlet :SAStrutsポートレット ・SpringPortlet :Springポートレット ・RssPortlet :RSS ポートレット ・InternetPortlet :インターネットポートレット ・AsyncPagePortlet :非同期ポートレット ・GoogleGadgetPortlet :グーグルガジェットポートレット ・SystemNoticePortlet :重要なお知らせポートレット ・HtmlPortlet :Htmlポートレット ・LinkSetPortlet :リンク集ポートレット |
|||
ポートレットタイプ名で 固有の属性 |
AsyncPagePortlet JspPortlet PresentationPagePortlet SAStrutsPortlet SpringPortlet |
url [必須] ページURL(String) | |
argument ページ引数 (String) | |||
JavaeeFwPortlet | applicationId [必須] アプリケーションID (String) | ||
serviceId [必須] サービスID (String) | |||
argument ページ引数 (String) | |||
RssPortlet | rssUrl [必須] RSSのURL (String) | ||
parserKey [必須] RSS解析バージョンのキー情報 (String) <PUBLIC_STORAGE_PATH>/portal/rss.xmlに定義された RSS解析パーサーのIDを指定する。 具体的には、parser-config/parser/idの要素を指定する。 インストール時の定義は、rss10、rss20またはatom10。 |
|||
proxyHost プロキシサーバのホスト名 (String) | |||
proxyPort プロキシサーバのポート番号 (Number) 設定されていない場合、-1を返却します。 |
|||
GoogleGadgetPortlet SystemNoticePortlet LinkSetPortlet |
portlet_title [必須] ポートレットアプリケーション名 (String) コンテキストパス.ポートレットタイプ名 |
||
HtmlPortlet | viewMode 表示モード (String) Htmlポートレットの表示モードを設定する。 デフォルト値はmce(リッチテキストボックス表示モード)。 HTML表示モード設定時はhtmlを指定する。 |
||
AsyncPagePortlet | portletHeight [必須] ポートレットの高さ (Number) | ||
titleBar タイトルバーを表示するかどうか (Boolean) デフォルト値は true (タイトルバーを表示する) |
|||
open_flag ポートレットを公開するかどうか (Boolean) デフォルト値は false (非公開) |
|||
cacheTime キャッシュ時間 (Number) デフォルト値は 0 (キャッシュ設定なし) |
|||
user_portal_flag 表示先ポータル種別ーユーザポータル (Boolean) デフォルト値は true (表示する) |
|||
group_portal_flag 表示先ポータル種別ーグループポータル (Boolean) デフォルト値は true (表示する) |
|||
portletTitles [必須] ポートレットタイトル情報配列 ポートレットタイトル情報オブジェクト の配列 |
|||
portletModes ポートレットモード情報配列 ポートレットモード情報オブジェクト の配列 |
|||
portletActionClass ポートレットアクションクラス名 (String) |
|||
portletEventClass ポートレットイベントクラス名 (String) |
|||
recordUserCode 最終更新ユーザコード (String) | |||
recordDate 最終更新日 (Date) |
ポートレットタイトル情報オブジェクトの構成は以下の通りです。
ポートレットタイトル情報オブジェクト
ポートレットタイトル情報 オブジェクト (Object) |
identificationId [必須] 識別ID(ポートレットコード) (String) |
locale [必須] ロケール (String) |
|
application [必須] アプリケーション名 (String) |
|
name [必須] ポートレット表示名 (String) |
|
description 説明 |
ポートレットモード情報オブジェクトの構成は以下の通りです。
ポートレットモード情報オブジェクト
ポートレットモード情報 オブジェクト (Object) |
portletModeCode [必須] ポートレットモードコード(ユニークなID) (String) |
portletCode [必須] ポートレットコード (String) | |
portletMode [必須] ポートレットモード (String) EDITのみ |
|
userFlag [必須] ユーザアクセス権フラグ (String) 値は "1"(ON) /"0"(OFF) デフォルト値は "1"(ON) |
処理結果オブジェクトの構成は以下の通りです。
処理結果オブジェクトの data 属性は検索処理が成功 (error ステータスが false) の場合にのみ定義されます。
data属性には、呼び出されたメソッドの結果に応じたオブジェクトが設定されます。
処理結果オブジェクト
処理結果 オブジェクト (Object) |
error true(失敗) or false(成功) (Boolean) |
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number) |
|
message エラー発生時のメッセージ (String) |
|
data 任意のオブジェクト (検索処理の成功時のみ) |
コンストラクタの概要
PortletManager () コンストラクタ |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
Boolean | deletePortlet (Object portlet ) ポートレット情報を削除します。 |
Object | getPortlet (String portletCode , String pageKind ) すでに登録済のポートレット情報を取得します。 |
Object | getPortlets () すでに登録されているポートレット情報の一覧を取得します。 |
Boolean | setPortlet (Object portlet ) ポートレット情報を登録します。 |
コンストラクタの詳細
PortletManager ()
コンストラクタ
|
メソッドの詳細
Boolean deletePortlet (Object portlet )
ポートレット情報を削除します。
パラメータ
返却値
|
Object getPortlet (String portletCode , String pageKind )
すでに登録済のポートレット情報を取得します。
検索結果は、処理結果オブジェクトのdata属性にポートレット情報オブジェクトが設定されます。 指定されたポートレット情報が存在しない場合は、data属性に null が設定されます。
パラメータ
返却値
|
Object getPortlets ()
すでに登録されているポートレット情報の一覧を取得します。
検索結果は、処理結果オブジェクトのdata属性にポートレット情報オブジェクトの配列 (Array) が設定されます。 ポートレット情報を1件も取得できなかった場合は、data属性に要素数が 0 の配列 (Array) が設定されます。
返却値
|
Boolean setPortlet (Object portlet )
ポートレット情報を登録します。
指定されたポートレット情報が存在ない場合は新規登録します。 すでに存在する場合は更新を行います。
パラメータ
返却値
|