Class SplibGeneralService

java.lang.Object

jp.ecuacion.splib.web.service.SplibGeneralService

Direct Known Subclasses:

SplibGeneral1FormService, SplibGeneral2FormsService, SplibGeneralDoNothingService

public abstract class SplibGeneralService
extends Object

Is the service abstract class for general page of the page template.

Constructor Summary

Constructors

Constructor	Description
SplibGeneralService()

Method Summary

Modifier and Type	Method	Description
DatetimeFormatParameters	getParams()	Obtains DatetimeFormatParameters instance.
void	prepareForm(List<SplibGeneralForm> allFormList, org.springframework.security.core.userdetails.UserDetails loginUser)	Puts data needed to display a page.
protected void	throwWarning(Set<String> confirmedWarningMessageSet, Locale locale, String buttonIdToPressOnConfirm, String[] fields, String msgId, String... params)	Provides the warning feature.

Methods inherited from class Object

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

Constructor Details

SplibGeneralService

public SplibGeneralService()

Method Details

throwWarning

protected void throwWarning(@RequireNonnull
 Set<String> confirmedWarningMessageSet,
 @RequireNonnull
 Locale locale,
 @Nullable
 String buttonIdToPressOnConfirm,
 @Nullable
 String[] fields,
 @RequireNonnull
 String msgId,
 @RequireNonnull
 String... params)
                     throws WebAppWarningException

Provides the warning feature.

By calling this method you can use the warning feature, which means that the warning message is shown on the message box, and by pressing OK button the warning is ignored at the next time.

Parameters:

confirmedWarningMessageSet - This is obtained from form.getConfirmedWarningMessageSet().

locale - locale

buttonIdToPressOnConfirm - buttonIdToPressOnConfirm, may be null. See WebAppWarningException.

fields - fields

msgId - msgId

params - params

Throws:

WebAppWarningException - WebAppWarningException

getParams

public DatetimeFormatParameters getParams()

Obtains DatetimeFormatParameters instance.

It's often used to construct a record.

prepareForm

public void prepareForm(List<SplibGeneralForm> allFormList,
 org.springframework.security.core.userdetails.UserDetails loginUser)

Puts data needed to display a page.

It's called from controllers and SplibExceptionHandler right before showing a page.
In SplibGeneralService no procedures are defined in it.
It's not an abstract method because the implementation of this method is not mandatory.

Parameters:

allFormList - a list of forms

loginUser - UserDetails