Portlet (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.portal.portlet.model.Portlet

すべての実装されたインタフェース:

Serializable

直系の既知のサブクラス:

ApplicationPortlet, InternetPortlet, J2eeFwPortlet, MenuLinkSetPortlet, RssPortlet, StandardPortlet
```
public abstract class Portlet
extends Object
implements Serializable
```
すべてのポートレットの基底となる抽象クラスです。

導入されたバージョン:

8.0.0

バージョン:

8.0.27

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`DISPLAY_NONE` 表示単位を指定しない状態
`static String`	`DISPLAY_PERCENT` 表示単位パーセント
`static String`	`DISPLAY_PIXCEL` 表示単位ピクセル

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Portlet()
コンストラクタ

コンストラクタ
コンストラクタと説明
`Portlet()` コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`String`	`getApplication()` 非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。このメソッドは常にnullを返します。
`int`	`getCacheTime()` キャッシュ時間を取得します。
`String`	`getEntityIdPrefix()` エンティティIDプリフィックスを取得
`String`	`getExplain()` 非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。このメソッドは常にnullを返します。
`boolean`	`getGlobalPortalFlag()` 非推奨です。グローバルポータルの廃止に伴いこのメソッドは非推奨となりました。このメソッドは常にfalseを返します。
`boolean`	`getGroupPortalFlag()` グループポータル表示可否を取得初期値は true になります。
`int`	`getHeight()` 非推奨です。 DBから削除された項目
`boolean`	`getOpenFlag()` 公開フラグを取得初期値は true (公開)になります。
`abstract String`	`getPageKind()` ページ種別を取得します。
`String`	`getPortletApplicationName()` ポートレットアプリケーション名を取得
`String`	`getPortletCode()` ポートレットコードを取得します。
`PortletMode[]`	`getPortletModes()` ポートレットモードを取得
`String`	`getPortletName()` 非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。このメソッドは常にnullを返します。
`String`	`getPortletTitle()` 非推奨です。 getPortletApplicationNameをご利用ください。
`PortletTitle[]`	`getPortletTitles()` portletTitleInfoのGetter
`String`	`getPortletTypeName()` ポートレットタイプ名を取得します。
`Date`	`getRecordDate()` レコード更新日を取得します。
`String`	`getRecordUserCode()` レコード更新ユーザコードを取得します。
`String`	`getUnit()` 非推奨です。 DBから削除された項目
`boolean`	`getUserPortalFlag()` ユーザポータル表示可否を取得初期値は true になります。
`int`	`getWidth()` 非推奨です。 DBから削除された項目
`int`	`hashCode()` このオブジェクトに対するハッシュコード値を返します。
`boolean`	`isEnabled()` ポートレットが有効かどうか判定します。
`boolean`	`isTitleBar()` タイトルバーを表示するかどうかのステータスを取得します。
`void`	`setApplication(String application)` 非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。指定した引数は無視されます。
`void`	`setCacheConfig(int cacheTime)` キャッシュ時間を設定します。
`void`	`setEnabled(boolean enable)` ポートレットが有効かどうか設定します。
`void`	`setEntityIdPrefix(String entityIdPrefix)` 非推奨です。ポートレットアプリケーション名または、ポートレットタイプ名から自動設定されるため、このメソッドは無視されます。
`void`	`setExplain(String explain)` 非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。指定した引数は無視されます。
`void`	`setGlobalPortalFlag(boolean globalPortalFlag)` 非推奨です。グローバルポータルの廃止に伴いこのメソッドは非推奨となりました。指定した引数は無視されます。
`void`	`setGroupPortalFlag(boolean groupPortalFlag)` グループポータル表示可否をセット
`void`	`setHeight(int height)` 非推奨です。 DBから削除された項目
`void`	`setOpenFlag(boolean openFlag)` 公開フラグをセット
`void`	`setPortletApplicationName(String portletApplicationName)` ポートレットアプリケーション名をセット
`void`	`setPortletCode(String portletCode)` ポートレットコードを設定します。
`void`	`setPortletModes(PortletMode[] portletModes)` ポートレットモードをセット
`void`	`setPortletName(String portletName)` 非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。指定した引数は無視されます。
`void`	`setPortletTitle(String portletTitle)` 非推奨です。 setPortletApplicationNameをご利用ください。
`void`	`setPortletTitles(PortletTitle[] portletTitles)` portletTitleInfoのSetter
`void`	`setRecordDate(Date recordDate)` レコード更新日を設定します。
`void`	`setRecordUserCode(String recordUserCode)` レコード更新ユーザコードを設定します。
`void`	`setTitleBar(boolean titleBar)` タイトルバーを表示するかどうかのステータスを設定します。
`void`	`setUnit(String unit)` 非推奨です。 DBから削除された項目
`void`	`setUserPortalFlag(boolean userPortalFlag)` ユーザポータル表示可否をセット
`void`	`setWidth(int width)` 非推奨です。 DBから削除された項目

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - DISPLAY_NONE
```
public static final String DISPLAY_NONE
```
    表示単位を指定しない状態
  - DISPLAY_PERCENT
```
public static final String DISPLAY_PERCENT
```
    表示単位パーセント
    
    関連項目:
    
    定数フィールド値
  - DISPLAY_PIXCEL
```
public static final String DISPLAY_PIXCEL
```
    表示単位ピクセル
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - Portlet
```
public Portlet()
```
    コンストラクタ
- メソッドの詳細
  - getPortletCode
```
public String getPortletCode()
```
    ポートレットコードを取得します。
    
    戻り値:
    
    ポートレットコード
    
    例外:
    
    IllegalStateException - ポートレットコードがnullである場合
  - setPortletCode
```
public void setPortletCode(String portletCode)
```
    ポートレットコードを設定します。(必須)
    ポートレットコードは必須項目です。必ずnull以外の値を設定して下さい。
    
    パラメータ:
    
    portletCode - ポートレットコード
    
    例外:
    
    IllegalArgumentException - ポートレットコードにnullが設定された場合
  - getApplication
```
@Deprecated
public String getApplication()
```
    非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。このメソッドは常にnullを返します。
    
    アプリケーション名を取得します。
    
    戻り値:
    
    アプリケーション名
  - setApplication
```
@Deprecated
public void setApplication(String application)
```
    非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。指定した引数は無視されます。
    
    アプリケーション名を設定します。
    
    パラメータ:
    
    application - アプリケーション名
  - getPortletName
```
@Deprecated
public String getPortletName()
```
    非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。このメソッドは常にnullを返します。
    
    ポートレット表示名を取得します。
    
    戻り値:
    
    ポートレット表示名
  - setPortletName
```
@Deprecated
public void setPortletName(String portletName)
```
    非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。指定した引数は無視されます。
    
    ポートレット表示名を設定します。
    
    パラメータ:
    
    portletName - ポートレット表示名
  - getPortletApplicationName
```
public String getPortletApplicationName()
```
    ポートレットアプリケーション名を取得
    
    戻り値:
    
    ポートレットアプリケーション名
  - setPortletApplicationName
```
public void setPortletApplicationName(String portletApplicationName)
```
    ポートレットアプリケーション名をセット
    
    パラメータ:
    
    portletApplicationName - ポートレットアプリケーション名
  - getPageKind
```
public abstract String getPageKind()
```
    ページ種別を取得します。
    
    戻り値:
    
    ページ種別
  - getPortletTypeName
```
public String getPortletTypeName()
```
    ポートレットタイプ名を取得します。
    
    戻り値:
    
    ポートレットタイプ名
  - isTitleBar
```
public boolean isTitleBar()
```
    タイトルバーを表示するかどうかのステータスを取得します。
    
    戻り値:
    
    タイトルバーを表示するかどうかのステータス
  - setTitleBar
```
public void setTitleBar(boolean titleBar)
```
    タイトルバーを表示するかどうかのステータスを設定します。
    
    パラメータ:
    
    titleBar - タイトルバーを表示するかどうかのステータス
  - getOpenFlag
```
public boolean getOpenFlag()
```
    公開フラグを取得
    
    初期値は true (公開)になります。
    
    戻り値:
    
    公開フラグ
  - setOpenFlag
```
public void setOpenFlag(boolean openFlag)
```
    公開フラグをセット
    
    パラメータ:
    
    openFlag - 公開フラグ
  - getCacheTime
```
public int getCacheTime()
```
    キャッシュ時間を取得します。
    
    初期値は 0 (キャッシュ設定なし)になります。
    無制限は -1 です。
    
    戻り値:
    
    キャッシュ時間
  - setCacheConfig
```
public void setCacheConfig(int cacheTime)
```
    キャッシュ時間を設定します。
    
    パラメータ:
    
    cacheTime - キャッシュ時間
  - getEntityIdPrefix
```
public String getEntityIdPrefix()
```
    エンティティIDプリフィックスを取得
    
    戻り値:
    
    エンティティIDプリフィックス
  - setEntityIdPrefix
```
public void setEntityIdPrefix(String entityIdPrefix)
```
    非推奨です。ポートレットアプリケーション名または、ポートレットタイプ名から自動設定されるため、このメソッドは無視されます。
    
    エンティティIDプリフィックスをセット。
    
    パラメータ:
    
    entityIdPrefix - エンティティIDプリフィックス
  - getExplain
```
@Deprecated
public String getExplain()
```
    非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。このメソッドは常にnullを返します。
    
    説明を取得します。
    
    戻り値:
    
    説明
  - setExplain
```
@Deprecated
public void setExplain(String explain)
```
    非推奨です。国際化項目はポートレットタイトル情報オブジェクト格納されるように変更されました。指定した引数は無視されます。
    
    説明を設定します。
    
    パラメータ:
    
    explain - 説明
  - getUserPortalFlag
```
public boolean getUserPortalFlag()
```
    ユーザポータル表示可否を取得
    
    初期値は true になります。
    
    戻り値:
    
    ユーザポータル表示可否
  - setUserPortalFlag
```
public void setUserPortalFlag(boolean userPortalFlag)
```
    ユーザポータル表示可否をセット
    
    パラメータ:
    
    userPortalFlag - ユーザポータル表示可否
  - getGroupPortalFlag
```
public boolean getGroupPortalFlag()
```
    グループポータル表示可否を取得
    
    初期値は true になります。
    
    戻り値:
    
    グループポータル表示可否
  - setGroupPortalFlag
```
public void setGroupPortalFlag(boolean groupPortalFlag)
```
    グループポータル表示可否をセット
    
    パラメータ:
    
    groupPortalFlag - グループポータル表示可否
  - getGlobalPortalFlag
```
@Deprecated
public boolean getGlobalPortalFlag()
```
    非推奨です。グローバルポータルの廃止に伴いこのメソッドは非推奨となりました。このメソッドは常にfalseを返します。
    
    グローバルポータル表示可否を取得
    
    戻り値:
    
    false グローバルポータル表示可否
  - setGlobalPortalFlag
```
@Deprecated
public void setGlobalPortalFlag(boolean globalPortalFlag)
```
    非推奨です。グローバルポータルの廃止に伴いこのメソッドは非推奨となりました。指定した引数は無視されます。
    
    グローバルポータル表示可否をセット
    
    パラメータ:
    
    globalPortalFlag - グローバルポータル表示可否
  - getRecordUserCode
```
public String getRecordUserCode()
```
    レコード更新ユーザコードを取得します。
    
    戻り値:
    
    レコード更新ユーザコード
  - setRecordUserCode
```
public void setRecordUserCode(String recordUserCode)
```
    レコード更新ユーザコードを設定します。
    
    パラメータ:
    
    recordUserCode - レコード更新ユーザコード
  - getRecordDate
```
public Date getRecordDate()
```
    レコード更新日を取得します。
    初期値はモデル生成時のシステム時間になります。
    
    戻り値:
    
    レコード更新日
  - setRecordDate
```
public void setRecordDate(Date recordDate)
```
    レコード更新日を設定します。
    
    パラメータ:
    
    recordDate - レコード更新日
    
    例外:
    
    IllegalArgumentException - レコード更新日にnullが設定された場合
  - hashCode
```
public int hashCode()
```
    このオブジェクトに対するハッシュコード値を返します。
    
    オーバーライド:
    
    hashCode クラス内 Object
    
    戻り値:
    
    このオブジェクトのハッシュコード値
  - getHeight
```
@Deprecated
public int getHeight()
```
    非推奨です。 DBから削除された項目
    
    表示単位に対する高さを取得します。
    
    戻り値:
    
    表示高さ
  - setHeight
```
@Deprecated
public void setHeight(int height)
```
    非推奨です。 DBから削除された項目
    
    表示単位に対する高さを設定します。
    
    パラメータ:
    
    height - 表示高
  - getUnit
```
@Deprecated
public String getUnit()
```
    非推奨です。 DBから削除された項目
    
    表示単位を取得します。
    
    戻り値:
    
    表示単位
  - setUnit
```
@Deprecated
public void setUnit(String unit)
```
    非推奨です。 DBから削除された項目
    表示単位を設定します。
    表示単位には、以下のいずれのかの値を設定して下さい。
    - Portlet.DISPLAY_NONE (初期値)
    - Portlet.DISPLAY_PERCENT
    - Portlet.DISPLAY_PIXCEL
    何れにも該当しない値が設定された場合は表示設定なしとします。
    パラメータ:
    
    displayUnit - 表示単位
  - getWidth
```
@Deprecated
public int getWidth()
```
    非推奨です。 DBから削除された項目
    
    表示単位に対する幅を取得します。
    
    戻り値:
    
    表示幅
  - setWidth
```
@Deprecated
public void setWidth(int width)
```
    非推奨です。 DBから削除された項目
    
    表示単位に対する幅設定します。
    
    パラメータ:
    
    width - 表示幅
  - getPortletTitles
```
public PortletTitle[] getPortletTitles()
```
    portletTitleInfoのGetter
    
    戻り値:
    
    portletTitleInfoを返却
  - setPortletTitles
```
public void setPortletTitles(PortletTitle[] portletTitles)
```
    portletTitleInfoのSetter
    
    パラメータ:
    
    portletTitleInfo - portletTitleInfoの設定値
  - getPortletModes
```
public PortletMode[] getPortletModes()
```
    ポートレットモードを取得
    
    戻り値:
    
    PortletEditMode[] ポートレットモードの配列
  - setPortletModes
```
public void setPortletModes(PortletMode[] portletModes)
```
    ポートレットモードをセット
    
    パラメータ:
    
    portletEditModes - ポートレットモードの配列
  - getPortletTitle
```
@Deprecated
public String getPortletTitle()
```
    非推奨です。 getPortletApplicationNameをご利用ください。
    
    ポートレットアプリケーション名を取得
    
    戻り値:
    
    ポートレットアプリケーション名
  - setPortletTitle
```
@Deprecated
public void setPortletTitle(String portletTitle)
```
    非推奨です。 setPortletApplicationNameをご利用ください。
    
    ポートレットアプリケーション名をセット
    
    パラメータ:
    
    portletTitle - ポートレットアプリケーション名
  - isEnabled
```
public boolean isEnabled()
```
    ポートレットが有効かどうか判定します。
    
    戻り値:
    
    有効/無効
  - setEnabled
```
public void setEnabled(boolean enable)
```
    ポートレットが有効かどうか設定します。
    
    パラメータ:
    
    enable - 有効/無効

クラス Portlet

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

DISPLAY_NONE

DISPLAY_PERCENT

DISPLAY_PIXCEL

コンストラクタの詳細

Portlet

メソッドの詳細

getPortletCode

setPortletCode

getApplication

setApplication

getPortletName

setPortletName

getPortletApplicationName

setPortletApplicationName

getPageKind

getPortletTypeName

isTitleBar

setTitleBar

getOpenFlag

setOpenFlag

getCacheTime

setCacheConfig

getEntityIdPrefix

setEntityIdPrefix

getExplain

setExplain

getUserPortalFlag

setUserPortalFlag

getGroupPortalFlag

setGroupPortalFlag

getGlobalPortalFlag

setGlobalPortalFlag

getRecordUserCode

setRecordUserCode

getRecordDate

setRecordDate

hashCode

getHeight

setHeight

getUnit

setUnit

getWidth

setWidth

getPortletTitles

setPortletTitles

getPortletModes

setPortletModes

getPortletTitle

setPortletTitle

isEnabled

setEnabled