Interface UserPreferenceProviderInterface

All Known Implementing Classes:

KeyValueUserPreferenceProvider

public interface UserPreferenceProviderInterface

Storage SPI for a preference section.

Method Summary

Modifier and Type	Method	Description
UserPreferenceValues	load(UserPreferenceRequestContext context)	Load the user's values and fixed rows.
default UserPreferenceActionResult	runAction(UserPreferenceRequestContext context, UserPreferenceActionRequest request)	Execute a validated action for the session user.
void	store(UserPreferenceRequestContext context, UserPreferenceChange change)	Store only the supplied fields and rows using ordinary audited table actions.
default List<String>	validate(UserPreferenceRequestContext context, UserPreferenceChange change)	Add domain validation after core has validated and coerced the partial change.

Method Details

load

UserPreferenceValues load(UserPreferenceRequestContext context)
                   throws QException

Load the user's values and fixed rows.

Throws:

QException

validate

default List<String> validate(UserPreferenceRequestContext context,
 UserPreferenceChange change)
                       throws QException

Add domain validation after core has validated and coerced the partial change.

Throws:

QException

store

void store(UserPreferenceRequestContext context,
 UserPreferenceChange change)
    throws QException

Store only the supplied fields and rows using ordinary audited table actions.

Throws:

QException

runAction

default UserPreferenceActionResult runAction(UserPreferenceRequestContext context,
 UserPreferenceActionRequest request)
                                      throws QException

Execute a validated action for the session user. Never log or audit secret values.

Throws:

QException