Class UserPreferencesAction

java.lang.Object

com.kingsrook.qqq.backend.core.actions.preferences.UserPreferencesAction

public class UserPreferencesAction
extends Object

Session-scoped user preferences: visibility, validation and trusted persistence.

Constructor Summary

Constructors

Constructor	Description
UserPreferencesAction()

Method Summary

Modifier and Type	Method	Description
UserPreferenceSectionResult	getSection(String name)	Load the session user's section, or hide it with not found.
List<UserPreferenceSectionResult>	listSections()	List only visible installed sections, ordered by order then label.
UserPreferenceSectionResult	patchSection(String name, UserPreferenceChange change)	Apply a typed partial change from an in-process caller.
UserPreferenceSectionResult	patchSection(String name, Map<String,?> body)	Validate the complete body without discarding unknown properties.
UserPreferenceActionResult	runAction(String sectionName, String actionName, Map<String,?> body)	Validate action inputs and row ownership before entering trusted provider code.

Methods inherited from class java.lang.Object

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

Constructor Details

UserPreferencesAction

public UserPreferencesAction()

Method Details

listSections

public List<UserPreferenceSectionResult> listSections()
                                               throws QException

List only visible installed sections, ordered by order then label.

Throws:

QException

getSection

public UserPreferenceSectionResult getSection(String name)
                                       throws QException

Load the session user's section, or hide it with not found.

Throws:

QException

patchSection

public UserPreferenceSectionResult patchSection(String name,
 Map<String,?> body)
                                         throws QException

Validate the complete body without discarding unknown properties.

Throws:

QException

patchSection

public UserPreferenceSectionResult patchSection(String name,
 UserPreferenceChange change)
                                         throws QException

Apply a typed partial change from an in-process caller.

Throws:

QException

runAction

public UserPreferenceActionResult runAction(String sectionName,
 String actionName,
 Map<String,?> body)
                                     throws QException

Validate action inputs and row ownership before entering trusted provider code. Action results are transient: no logging or auditing of secret values occurs here.

Throws:

QException