com.helger.photon.basic.app.dao

Interface IAutoSaveAware

All Known Subinterfaces:

IDAO, IDAOContainer, IReloadableDAO

All Known Implementing Classes:

AbstractDAO, AbstractDAOContainer, AbstractMapBasedWALDAO, AbstractSimpleDAO, AbstractWALDAO, AuditManager, DefaultDAOContainer, FavoriteManager, LongRunningJobResultManager, SimpleAuditManager, SystemMessageManager, SystemMigrationManager

public interface IAutoSaveAware

Abstraction layer around auto save stuff.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
void	beginWithoutAutoSave() Start doing something without auto save.
void	endWithoutAutoSave() End doing something without auto save.
boolean	isAutoSaveEnabled()
void	performWithoutAutoSave(Runnable aRunnable) This method is used for batch processing of instructions (like the initial read).
<RETURNTYPE> RETURNTYPE	performWithoutAutoSave(Supplier<RETURNTYPE> aCallable) This method is used for batch processing of instructions (like the initial read).

Method Detail

isAutoSaveEnabled

boolean isAutoSaveEnabled()

Returns:

true if auto save is enabled, false otherwise.

beginWithoutAutoSave

void beginWithoutAutoSave()

Start doing something without auto save.

endWithoutAutoSave

void endWithoutAutoSave()

End doing something without auto save. It must be ensure that each call to beginWithoutAutoSave() is always correctly ended with a call to this method.

performWithoutAutoSave

void performWithoutAutoSave(@Nonnull
                            Runnable aRunnable)

This method is used for batch processing of instructions (like the initial read). If first turns automatic saving off, runs the desired operations and finally restores the initial state of the "automatic save" flag and tries to write any pending changes.

Parameters:

aRunnable - The runnable to be executed. May not be null.

performWithoutAutoSave

@Nullable
<RETURNTYPE> RETURNTYPE performWithoutAutoSave(@Nonnull
                                                          Supplier<RETURNTYPE> aCallable)

This method is used for batch processing of instructions (like the initial read). If first turns automatic saving off, runs the desired operations and finally restores the initial state of the "automatic save" flag and tries to write any pending changes.

Type Parameters:

RETURNTYPE - Return type of the callable

Parameters:

aCallable - The runnable to be executed. May not be null.

Returns:

the result of the callable.