Package org.iplass.mtp.view.generic
Interface EntityViewManager
- All Superinterfaces:
Manager,TypedDefinitionManager<EntityView>
public interface EntityViewManager extends TypedDefinitionManager<EntityView>
画面定義を管理するクラスのインターフェース。
-
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>applyDefaultPropertyCondition(java.lang.String definitionName, java.lang.String viewName, java.util.Map<java.lang.String,java.lang.Object> defaultCondMap)画面定義に設定されたデフォルトプロパティ条件設定スクリプトを使って検索条件を設定します。voidcheckState(java.lang.String definitionName)EntityViewのステータスをチェックします。EntitycopyEntity(java.lang.String viewName, Entity entity)画面定義に設定されたカスタムコピースクリプトを使ってEntityをコピーします。DefinitionModifyResultcreate(java.lang.String name, EntityView entityView)Deprecated.#create(EntityView)を利用してください。BulkFormViewcreateDefaultBulkFormView(java.lang.String definitionName)Entity定義に対応する標準のBulkFormViewを返します。DetailFormViewcreateDefaultDetailFormView(java.lang.String definitionName)Entity定義に対応する標準のDetailFormViewを返します。SearchFormViewcreateDefaultSearchFormView(java.lang.String definitionName)Entity定義に対応する標準のSearchFormViewを返します。voidexecuteTemplate(java.lang.String name, java.lang.String templateName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletContext application, javax.servlet.jsp.PageContext page)スクリプトテンプレートを実行します。java.lang.ObjectgetAutocompletionValue(java.lang.String definitionName, java.lang.String viewName, java.lang.String viewType, java.lang.String propName, java.lang.String autocompletionKey, java.lang.Integer referenceSectionIndex, java.util.Map<java.lang.String,java.lang.String[]> param, java.util.List<java.lang.String> currentValue, Entity entity)自動補完の値を取得します。java.lang.StringgetCsvDownloadFileName(java.lang.String definitionName, java.lang.String viewName, java.lang.String defaultName, java.util.Map<java.lang.String,java.lang.Object> csvVariableMap)画面定義に設定されたCSVダウンロードファイル名Formatを使ってCSVファイル名を返します。java.lang.StringgetCustomStyle(java.lang.String definitionName, java.lang.String scriptKey, java.lang.String editorScriptKey, Entity entity, java.lang.Object propValue)カスタムスタイルを取得します。ConditiongetMassReferenceSectionCondition(java.lang.String name, MassReferenceSection section)大規模参照セクション用のデフォルト検索条件を取得します。java.util.List<java.lang.String>getPermitRoles(java.lang.String definitionName, java.lang.String viewName)EntityViewの操作を許可するロールを返します。 View定義が1つもない場合はnullを返します。PropertyEditorgetPropertyEditor(java.lang.String defName, java.lang.String viewType, java.lang.String viewName, java.lang.String propName, java.lang.Integer refSectionIndex, Entity entity)指定の画面定義に設定されているEditorを取得します。PropertyEditorgetPropertyEditor(java.lang.String defName, java.lang.String viewType, java.lang.String viewName, java.lang.String propName, Entity entity)指定の画面定義に設定されているEditorを取得します。ConditiongetSearchConditionSectionDefaultCondition(java.lang.String name, SearchConditionSection section)検索条件セクション用のデフォルト検索条件を取得します。java.lang.StringgetUrlParameter(java.lang.String definitionName, ReferencePropertyEditor editor, Entity entity, ReferencePropertyEditor.UrlParameterActionType actionType)参照ダイアログ用のURLパラメータを取得します。EntityinitEntity(java.lang.String definitionName, java.lang.String viewName, Entity entity)画面定義に設定された初期化スクリプトを使ってEntityを初期化します。booleanisDisplayButton(java.lang.String definitionName, java.lang.String buttonKey, OutputType outputType, Entity entity)ボタンの表示可否を判定します。booleanisDisplayElement(java.lang.String definitionName, java.lang.String elementRuntimeId, OutputType outputType, Entity entity)エレメントの表示可否を判定します。DefinitionModifyResultupdate(java.lang.String name, EntityView entityView)Deprecated.#update(EntityView)を利用してください。Methods inherited from interface org.iplass.mtp.definition.TypedDefinitionManager
create, definitionList, definitionSummaryList, definitionSummaryList, definitionSummaryList, get, getDefinitionType, remove, rename, update
-
Method Details
-
create
Deprecated.#create(EntityView)を利用してください。画面定義を新規作成します。- Parameters:
name- Entity定義の名前entityView- 画面定義
-
update
Deprecated.#update(EntityView)を利用してください。指定の画面定義で既存の定義を更新します。- Parameters:
name- Entity定義の名前entityView- 画面定義
-
getPropertyEditor
PropertyEditor getPropertyEditor(java.lang.String defName, java.lang.String viewType, java.lang.String viewName, java.lang.String propName, Entity entity)指定の画面定義に設定されているEditorを取得します。- Parameters:
defName- Entity定義の名前viewType- FormViewの種類viewName- View名propName- プロパティ名entity- エンティティ- Returns:
- エディター
-
getPropertyEditor
PropertyEditor getPropertyEditor(java.lang.String defName, java.lang.String viewType, java.lang.String viewName, java.lang.String propName, java.lang.Integer refSectionIndex, Entity entity)指定の画面定義に設定されているEditorを取得します。- Parameters:
defName- Entity定義の名前viewType- FormViewの種類viewName- View名propName- プロパティ名refSection- 参照セクションインデックスentity- エンティティ- Returns:
- エディター
-
executeTemplate
void executeTemplate(java.lang.String name, java.lang.String templateName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletContext application, javax.servlet.jsp.PageContext page)スクリプトテンプレートを実行します。- Parameters:
name- 定義名templateName- テンプレート名req- リクエストres- レスポンスapplication- サーブレットコンテキストpage- ページコンテキスト
-
copyEntity
画面定義に設定されたカスタムコピースクリプトを使ってEntityをコピーします。- Parameters:
viewName- view名entity- コピー元Entity- Returns:
- コピーしたEntity
-
initEntity
画面定義に設定された初期化スクリプトを使ってEntityを初期化します。- Parameters:
definitionName- Entity定義名viewName- view名entity- 初期化対象Entity- Returns:
- 初期化したEntity
-
applyDefaultPropertyCondition
java.util.Map<java.lang.String,java.lang.Object> applyDefaultPropertyCondition(java.lang.String definitionName, java.lang.String viewName, java.util.Map<java.lang.String,java.lang.Object> defaultCondMap)画面定義に設定されたデフォルトプロパティ条件設定スクリプトを使って検索条件を設定します。- Parameters:
definitionName- Entity定義名viewName- view名defaultCondMap- パラメータなどで設定された検索条件- Returns:
- デフォルトプロパティ条件が適用された検索条件
-
getCsvDownloadFileName
java.lang.String getCsvDownloadFileName(java.lang.String definitionName, java.lang.String viewName, java.lang.String defaultName, java.util.Map<java.lang.String,java.lang.Object> csvVariableMap)画面定義に設定されたCSVダウンロードファイル名Formatを使ってCSVファイル名を返します。- Parameters:
definitionName- Entity定義名viewName- view名defaultName- デフォルトファイル名csvVariableMap- TemplateBind引数- Returns:
- CSVファイル名
-
getSearchConditionSectionDefaultCondition
Condition getSearchConditionSectionDefaultCondition(java.lang.String name, SearchConditionSection section)検索条件セクション用のデフォルト検索条件を取得します。- Parameters:
name- Entity定義名section- 検索条件セクション- Returns:
- 条件
-
getMassReferenceSectionCondition
大規模参照セクション用のデフォルト検索条件を取得します。- Parameters:
name- Entity定義名section- 大規模参照セクション- Returns:
- 条件
-
createDefaultSearchFormView
Entity定義に対応する標準のSearchFormViewを返します。- Parameters:
definitionName- Entity定義名- Returns:
- SearchFormView
-
createDefaultDetailFormView
Entity定義に対応する標準のDetailFormViewを返します。- Parameters:
definitionName- Entity定義名- Returns:
- DetailFormView
-
createDefaultBulkFormView
Entity定義に対応する標準のBulkFormViewを返します。- Parameters:
definitionName- Entity定義名- Returns:
- BulkFormView
-
getCustomStyle
java.lang.String getCustomStyle(java.lang.String definitionName, java.lang.String scriptKey, java.lang.String editorScriptKey, Entity entity, java.lang.Object propValue)カスタムスタイルを取得します。- Parameters:
definitionName- Entity定義名scriptKey- EntityViewのカスタムスタイルキーeditorScriptKey- EntityViewに設定されているプロパティ毎のカスタムスタイルキーentity- EntityデータpropValue- プロパティの値- Returns:
- DetailFormView
-
isDisplayElement
boolean isDisplayElement(java.lang.String definitionName, java.lang.String elementRuntimeId, OutputType outputType, Entity entity)エレメントの表示可否を判定します。- Parameters:
definitionName- Entity定義名elementRuntimeId- エレメントのランタイムIDoutputType- 表示タイプentity- 表示対象のエンティティ- Returns:
- 表示可否
-
isDisplayButton
boolean isDisplayButton(java.lang.String definitionName, java.lang.String buttonKey, OutputType outputType, Entity entity)ボタンの表示可否を判定します。- Parameters:
definitionName- Entity定義名buttonKey- ボタンのキーoutputType- 表示タイプentity- 表示対象のエンティティ- Returns:
-
getUrlParameter
java.lang.String getUrlParameter(java.lang.String definitionName, ReferencePropertyEditor editor, Entity entity, ReferencePropertyEditor.UrlParameterActionType actionType)参照ダイアログ用のURLパラメータを取得します。- Parameters:
definitionName- Entity定義名editor- ReferencePropertyEditorentity- 参照元EntityactionType- URLパラメータActionタイプ- Returns:
- URLパラメータ
-
getAutocompletionValue
java.lang.Object getAutocompletionValue(java.lang.String definitionName, java.lang.String viewName, java.lang.String viewType, java.lang.String propName, java.lang.String autocompletionKey, java.lang.Integer referenceSectionIndex, java.util.Map<java.lang.String,java.lang.String[]> param, java.util.List<java.lang.String> currentValue, Entity entity)自動補完の値を取得します。- Parameters:
definitionName- Entity定義名viewName- view名viewType- 表示タイプpropName- プロパティ名autocompletionKey- 自動補完のキーparam- 連動元の値currentValue- 連動先の値entity- エンティティ- Returns:
- 自動補完の値
-
getPermitRoles
java.util.List<java.lang.String> getPermitRoles(java.lang.String definitionName, java.lang.String viewName)EntityViewの操作を許可するロールを返します。 View定義が1つもない場合はnullを返します。
- Parameters:
definitionName- Entity定義名viewName- view名- Returns:
- 許可ロール
-
checkState
void checkState(java.lang.String definitionName)EntityViewのステータスをチェックします。- Parameters:
definitionName- Entity定義名
-