Module jp.ecuacion.splib.web

Package jp.ecuacion.splib.web.form

Class SplibGeneralForm

java.lang.Object

jp.ecuacion.splib.web.form.SplibGeneralForm

Direct Known Subclasses:

AdminLoginForm, ConfigForm, LoginForm, SplibEditForm, SplibListForm, SplibSearchForm

public abstract class SplibGeneralForm
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SplibGeneralForm.PrepareSettings

Field Summary

Fields

Modifier and Type	Field	Description
protected String	confirmedWarnings	warningを返した際に、それに対してOKした場合は、OKしたという履歴を残さないとまた再度同じチェックに引っかかりワーニングを出してしまう。
protected String	dataKind	一つの機能の実装を複数メニューで使い回す場合に使用するメニュー名。

Constructor Summary

Constructors

Constructor	Description
SplibGeneralForm()

Method Summary

Modifier and Type	Method	Description
boolean	containsConfirmedWarning(String messageId)
SplibRecord	get(String itemName)	引数は、"acc"のような形で渡される想定。
Set<String>	getConfirmedWarningMessageSet()
String	getConfirmedWarnings()
SplibGeneralController.ControllerContext	getControllerContext()
String	getDataKind()
SplibGeneralForm.PrepareSettings	getPrepareSettings()
Object	getRootRecord()	Deprecated.
protected Object	getRootRecord(Field rootRecordField)	getLabelItemName() ではfieldも別途使用するため、fieldの二回取得は無駄なのでfieldを引数にするメソッドも作っておく。
Object	getRootRecord(String recordName)	formからrecordを取得する処理。
Field	getRootRecordField()	Deprecated.
List<Field>	getRootRecordFields()	form配下に存在するrecordを全て取得。
boolean	hasNotEmptyError(String loginState, SplibSecurityUtil.RolesAndAuthoritiesBean bean)	EditFormのメソッドを呼び出すことで、その中の全てのNotEmpty Checkを実施。
SplibGeneralForm	noValidate()	prepare method内でのvalidation要否判断に使用。
void	setConfirmedWarnings(String confirmedWarnings)
void	setControllerContext(SplibGeneralController.ControllerContext controllerContext)
void	setDataKind(String dataKind)
SplibGeneralForm	validate(org.springframework.validation.BindingResult bindingResult)	prepare method内でのvalidation要否判断に使用。
Set<SplibExceptionHandler.ValidationErrorInfoBean>	validateNotEmpty(String loginState, SplibSecurityUtil.RolesAndAuthoritiesBean bean)	NotEmptyエラーの有無・件数だけを知りたい場合で、localeを取得するのが面倒な際はこちらを使用。
Set<SplibExceptionHandler.ValidationErrorInfoBean>	validateNotEmpty(Locale locale, String loginState, SplibSecurityUtil.RolesAndAuthoritiesBean bean)	NotEmptyエラーのメッセージを取得したい場合はこちらを使用。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dataKind

protected String dataKind

一つの機能の実装を複数メニューで使い回す場合に使用するメニュー名。

使い回しをしない通常機能は、放置しnull（実際にはhtml側でhiddenを持っているのでそれがsubmitされ空文字になる）のままでよい。 searchFormはsessionにformを保持し検索条件を保持するが、複数メニューで使い回す場合は そのメニュー別に検索条件を保持するのが望ましいため、このdataKindもsession保存時のキーとする。

現行設計ではdataKindをrequestで持ち回る形を採用している。 sessionに持たせた方が実装が楽と思われる部分もありながら、navBarから他のメニューを選択された時には sessionに保管されたdataKindではなくrequestの方のdataKindを採用する、あたりをうまく回す必要があり、 その意味ではsessionに持たせるよりrequestで持ち回る方がわかりやすい（dataKindが空ならシステムエラーになるので）ことから まずはrequestで持ち回り、の実装方式としておく。 ※PRGを使用しGETでのアクセスを可としている中で、個々のURLをコピって使用しても使用可能とする意味でも、 全てのURLにdataKindパラメータがついているのが望ましい、という観点もあるので付記。

confirmedWarnings

protected String confirmedWarnings

warningを返した際に、それに対してOKした場合は、OKしたという履歴を残さないとまた再度同じチェックに引っかかりワーニングを出してしまう。 それを防ぐため、一度OKしたwarningは、messageIdを本fieldに保管することで避ける。 複数のwarnに対する情報を保持できるよう、本項目はcsv形式とする。（対応するhiddenにjavascript側で","とメッセージIDを追加）

Constructor Details

SplibGeneralForm

public SplibGeneralForm()

Method Details

getPrepareSettings

public SplibGeneralForm.PrepareSettings getPrepareSettings()

validate

public SplibGeneralForm validate(org.springframework.validation.BindingResult bindingResult)

prepare method内でのvalidation要否判断に使用。

noValidate

public SplibGeneralForm noValidate()

prepare method内でのvalidation要否判断に使用。

getDataKind

public String getDataKind()

setDataKind

public void setDataKind(String dataKind)

getControllerContext

public SplibGeneralController.ControllerContext getControllerContext()

setControllerContext

public void setControllerContext(SplibGeneralController.ControllerContext controllerContext)

get

public SplibRecord get(String itemName)
                throws IllegalArgumentException,
IllegalAccessException,
NoSuchFieldException,
SecurityException

引数は、"acc"のような形で渡される想定。

Throws:

IllegalArgumentException

IllegalAccessException

NoSuchFieldException

SecurityException

getRootRecordFields

public List<Field> getRootRecordFields()

form配下に存在するrecordを全て取得。 戻り値のmapのkeyはfield名。

getRootRecordField

@Deprecated
public Field getRootRecordField()

Deprecated.

form配下にrecordが1つしかない前提で使用されるメソッド。deprecatedにしたいのだが、状況確認中。

getRootRecord

@Deprecated
public Object getRootRecord()

Deprecated.

formからrecordを取得する処理。

getRootRecord

public Object getRootRecord(String recordName)

formからrecordを取得する処理。

getRootRecord

protected Object getRootRecord(Field rootRecordField)

getLabelItemName() ではfieldも別途使用するため、fieldの二回取得は無駄なのでfieldを引数にするメソッドも作っておく。

getConfirmedWarnings

public String getConfirmedWarnings()

containsConfirmedWarning

public boolean containsConfirmedWarning(String messageId)

getConfirmedWarningMessageSet

public Set<String> getConfirmedWarningMessageSet()

setConfirmedWarnings

public void setConfirmedWarnings(String confirmedWarnings)

hasNotEmptyError

public boolean hasNotEmptyError(String loginState,
 SplibSecurityUtil.RolesAndAuthoritiesBean bean)

EditFormのメソッドを呼び出すことで、その中の全てのNotEmpty Checkを実施。

validateNotEmpty

public Set<SplibExceptionHandler.ValidationErrorInfoBean> validateNotEmpty(String loginState,
 SplibSecurityUtil.RolesAndAuthoritiesBean bean)

NotEmptyエラーの有無・件数だけを知りたい場合で、localeを取得するのが面倒な際はこちらを使用。

validateNotEmpty

public Set<SplibExceptionHandler.ValidationErrorInfoBean> validateNotEmpty(Locale locale,
 String loginState,
 SplibSecurityUtil.RolesAndAuthoritiesBean bean)

NotEmptyエラーのメッセージを取得したい場合はこちらを使用。