パッケージ org.iplass.mtp.view.generic

インタフェース EntityViewManager

すべてのスーパーインタフェース:

Manager, TypedDefinitionManager<EntityView>

public interface EntityViewManager
extends TypedDefinitionManager<EntityView>

画面定義を管理するクラスのインターフェース。

メソッドの概要

修飾子とタイプ	メソッド	説明
Map<String,Object>	applyDefaultPropertyCondition(String definitionName, String viewName, Map<String,Object> defaultCondMap)	画面定義に設定されたデフォルトプロパティ条件設定スクリプトを使って検索条件を設定します。
void	checkState(String definitionName)	EntityViewのステータスをチェックします。
Entity	copyEntity(String viewName, Entity entity)	画面定義に設定されたカスタムコピースクリプトを使ってEntityをコピーします。
DefinitionModifyResult	create(String name, EntityView entityView)	推奨されていません。 無効な参照です #create(EntityView) を利用してください。
BulkFormView	createDefaultBulkFormView(String definitionName)	Entity定義に対応する標準のBulkFormViewを返します。
DetailFormView	createDefaultDetailFormView(String definitionName)	Entity定義に対応する標準のDetailFormViewを返します。
SearchFormView	createDefaultSearchFormView(String definitionName)	Entity定義に対応する標準のSearchFormViewを返します。
void	executeTemplate(String name, String templateName, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, jakarta.servlet.ServletContext application, jakarta.servlet.jsp.PageContext page)	スクリプトテンプレートを実行します。
Object	getAutocompletionValue(String definitionName, String viewName, String viewType, String propName, String autocompletionKey, Integer referenceSectionIndex, Map<String,String[]> param, List<String> currentValue, Entity entity)	自動補完の値を取得します。
String	getCsvDownloadFileName(String definitionName, String viewName, String defaultName, Map<String,Object> csvVariableMap)	推奨されていません。 getEntityDownloadFileName(String, String, String, Map) を利用してください。
String	getCustomStyle(String definitionName, String scriptKey, String editorScriptKey, Entity entity, Object propValue)	カスタムスタイルを取得します。
String	getEntityDownloadFileName(String definitionName, String viewName, String defaultName, Map<String,Object> fileNameVariableMap)	画面定義に設定されたダウンロードファイル名Formatを使ってファイル名を返します。
Condition	getMassReferenceSectionCondition(String name, MassReferenceSection section)	大規模参照セクション用のデフォルト検索条件を取得します。
List<String>	getPermitRoles(String definitionName, String viewName)	EntityViewの操作を許可するロールを返します。
PropertyEditor	getPropertyEditor(String defName, String viewType, String viewName, String propName, Integer refSectionIndex, Entity entity)	指定の画面定義に設定されているEditorを取得します。
PropertyEditor	getPropertyEditor(String defName, String viewType, String viewName, String propName, Entity entity)	指定の画面定義に設定されているEditorを取得します。
Condition	getSearchConditionSectionDefaultCondition(String name, SearchConditionSection section)	検索条件セクション用のデフォルト検索条件を取得します。
String	getUrlParameter(String definitionName, ReferencePropertyEditor editor, Entity entity, ReferencePropertyEditor.UrlParameterActionType actionType)	参照ダイアログ用のURLパラメータを取得します。
boolean	hasEntityReferencePermissionDetailFormView(String definitionName, String viewName, Entity entity)	詳細編集画面でEntityデータの参照が許可されているかを返します。
Entity	initEntity(String definitionName, String viewName, Entity entity)	画面定義に設定された初期化スクリプトを使ってEntityを初期化します。
boolean	isDisplayButton(String definitionName, String buttonKey, OutputType outputType, Entity entity)	ボタンの表示可否を判定します。
boolean	isDisplayElement(String definitionName, String elementRuntimeId, OutputType outputType, Entity entity)	エレメントの表示可否を判定します。
DefinitionModifyResult	update(String name, EntityView entityView)	推奨されていません。 無効な参照です #update(EntityView) を利用してください。

インタフェースから継承されたメソッド org.iplass.mtp.definition.TypedDefinitionManager

create, definitionList, definitionSummaryList, definitionSummaryList, definitionSummaryList, get, getDefinitionType, remove, rename, update

メソッドの詳細

create

@Deprecated
DefinitionModifyResult create(String name,
 EntityView entityView)

推奨されていません。

無効な参照です

#create(EntityView)

を利用してください。

画面定義を新規作成します。

パラメータ:

name - Entity定義の名前

entityView - 画面定義

update

@Deprecated
DefinitionModifyResult update(String name,
 EntityView entityView)

推奨されていません。

無効な参照です

#update(EntityView)

を利用してください。

指定の画面定義で既存の定義を更新します。

パラメータ:

name - Entity定義の名前

entityView - 画面定義

getPropertyEditor

PropertyEditor getPropertyEditor(String defName,
 String viewType,
 String viewName,
 String propName,
 Entity entity)

指定の画面定義に設定されているEditorを取得します。

パラメータ:

defName - Entity定義の名前

viewType - FormViewの種類

viewName - View名

propName - プロパティ名

entity - エンティティ

戻り値:

エディター

getPropertyEditor

PropertyEditor getPropertyEditor(String defName,
 String viewType,
 String viewName,
 String propName,
 Integer refSectionIndex,
 Entity entity)

指定の画面定義に設定されているEditorを取得します。

パラメータ:

defName - Entity定義の名前

viewType - FormViewの種類

viewName - View名

propName - プロパティ名

entity - エンティティ

refSection - 参照セクションインデックス

戻り値:

エディター

executeTemplate

void executeTemplate(String name,
 String templateName,
 jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse res,
 jakarta.servlet.ServletContext application,
 jakarta.servlet.jsp.PageContext page)

スクリプトテンプレートを実行します。

パラメータ:

name - 定義名

templateName - テンプレート名

req - リクエスト

res - レスポンス

application - サーブレットコンテキスト

page - ページコンテキスト

copyEntity

Entity copyEntity(String viewName,
 Entity entity)

画面定義に設定されたカスタムコピースクリプトを使ってEntityをコピーします。

パラメータ:

viewName - view名

entity - コピー元Entity

戻り値:

コピーしたEntity

initEntity

Entity initEntity(String definitionName,
 String viewName,
 Entity entity)

画面定義に設定された初期化スクリプトを使ってEntityを初期化します。

パラメータ:

definitionName - Entity定義名

viewName - view名

entity - 初期化対象Entity

戻り値:

初期化したEntity

applyDefaultPropertyCondition

Map<String,Object> applyDefaultPropertyCondition(String definitionName,
 String viewName,
 Map<String,Object> defaultCondMap)

画面定義に設定されたデフォルトプロパティ条件設定スクリプトを使って検索条件を設定します。

パラメータ:

definitionName - Entity定義名

viewName - view名

defaultCondMap - パラメータなどで設定された検索条件

戻り値:

デフォルトプロパティ条件が適用された検索条件

getCsvDownloadFileName

@Deprecated
String getCsvDownloadFileName(String definitionName,
 String viewName,
 String defaultName,
 Map<String,Object> csvVariableMap)

推奨されていません。

getEntityDownloadFileName(String, String, String, Map) を利用してください。

画面定義に設定されたCSVダウンロードファイル名Formatを使ってCSVファイル名を返します。

パラメータ:

definitionName - Entity定義名

viewName - view名

defaultName - デフォルトファイル名

csvVariableMap - TemplateBind引数

戻り値:

CSVファイル名

getEntityDownloadFileName

String getEntityDownloadFileName(String definitionName,
 String viewName,
 String defaultName,
 Map<String,Object> fileNameVariableMap)

画面定義に設定されたダウンロードファイル名Formatを使ってファイル名を返します。

パラメータ:

definitionName - Entity定義名

viewName - view名

defaultName - デフォルトファイル名

fileNameVariableMap - TemplateBind引数

戻り値:

ファイル名

getSearchConditionSectionDefaultCondition

Condition getSearchConditionSectionDefaultCondition(String name,
 SearchConditionSection section)

検索条件セクション用のデフォルト検索条件を取得します。

パラメータ:

name - Entity定義名

section - 検索条件セクション

戻り値:

条件

getMassReferenceSectionCondition

Condition getMassReferenceSectionCondition(String name,
 MassReferenceSection section)

大規模参照セクション用のデフォルト検索条件を取得します。

パラメータ:

name - Entity定義名

section - 大規模参照セクション

戻り値:

条件

createDefaultSearchFormView

SearchFormView createDefaultSearchFormView(String definitionName)

Entity定義に対応する標準のSearchFormViewを返します。

パラメータ:

definitionName - Entity定義名

戻り値:

SearchFormView

createDefaultDetailFormView

DetailFormView createDefaultDetailFormView(String definitionName)

Entity定義に対応する標準のDetailFormViewを返します。

パラメータ:

definitionName - Entity定義名

戻り値:

DetailFormView

createDefaultBulkFormView

BulkFormView createDefaultBulkFormView(String definitionName)

Entity定義に対応する標準のBulkFormViewを返します。

パラメータ:

definitionName - Entity定義名

戻り値:

BulkFormView

getCustomStyle

String getCustomStyle(String definitionName,
 String scriptKey,
 String editorScriptKey,
 Entity entity,
 Object propValue)

カスタムスタイルを取得します。

パラメータ:

definitionName - Entity定義名

scriptKey - EntityViewのカスタムスタイルキー

editorScriptKey - EntityViewに設定されているプロパティ毎のカスタムスタイルキー

entity - Entityデータ

propValue - プロパティの値

戻り値:

DetailFormView

isDisplayElement

boolean isDisplayElement(String definitionName,
 String elementRuntimeId,
 OutputType outputType,
 Entity entity)

エレメントの表示可否を判定します。

パラメータ:

definitionName - Entity定義名

elementRuntimeId - エレメントのランタイムID

outputType - 表示タイプ

entity - 表示対象のエンティティ

戻り値:

表示可否

isDisplayButton

boolean isDisplayButton(String definitionName,
 String buttonKey,
 OutputType outputType,
 Entity entity)

ボタンの表示可否を判定します。

パラメータ:

definitionName - Entity定義名

buttonKey - ボタンのキー

outputType - 表示タイプ

entity - 表示対象のエンティティ

戻り値:

getUrlParameter

String getUrlParameter(String definitionName,
 ReferencePropertyEditor editor,
 Entity entity,
 ReferencePropertyEditor.UrlParameterActionType actionType)

参照ダイアログ用のURLパラメータを取得します。

パラメータ:

definitionName - Entity定義名

editor - ReferencePropertyEditor

entity - 参照元Entity

actionType - URLパラメータActionタイプ

戻り値:

URLパラメータ

getAutocompletionValue

Object getAutocompletionValue(String definitionName,
 String viewName,
 String viewType,
 String propName,
 String autocompletionKey,
 Integer referenceSectionIndex,
 Map<String,String[]> param,
 List<String> currentValue,
 Entity entity)

自動補完の値を取得します。

パラメータ:

definitionName - Entity定義名

viewName - view名

viewType - 表示タイプ

propName - プロパティ名

autocompletionKey - 自動補完のキー

param - 連動元の値

currentValue - 連動先の値

entity - エンティティ

戻り値:

自動補完の値

getPermitRoles

List<String> getPermitRoles(String definitionName,
 String viewName)

EntityViewの操作を許可するロールを返します。 View定義が1つもない場合はnullを返します。

パラメータ:

definitionName - Entity定義名

viewName - view名

戻り値:

許可ロール

checkState

void checkState(String definitionName)

EntityViewのステータスをチェックします。

パラメータ:

definitionName - Entity定義名

hasEntityReferencePermissionDetailFormView

boolean hasEntityReferencePermissionDetailFormView(String definitionName,
 String viewName,
 Entity entity)

詳細編集画面でEntityデータの参照が許可されているかを返します。

パラメータ:

definitionName - Entity定義名

viewName - view名

entity - エンティティ

戻り値:

許可されているか