Package com.foreach.across.modules.entity.views

Class EntityViewFactoryAttributes

java.lang.Object

com.foreach.across.modules.entity.views.EntityViewFactoryAttributes

public final class EntityViewFactoryAttributes
extends Object

Contains common EntityViewFactory configuration attributes. During view processing these can usually be retrieved using EntityViewRequest.getConfigurationAttributes().

Since:

3.0.0

Author:

Arne Vandamme

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_VALIDATOR	Contains a java.util.function.BiPredicate<EntityViewFactory,EntityViewContext> that is to be used for checking if access to the EntityViewFactory is allowed.
static final String	ADMIN_MENU	Contains a Consumer that takes an EntityAdminMenuEvent as parameter.
static final String	VIEW_NAME	Contains the name of the view.
static final String	VIEW_TEMPLATE_NAME	Contains the template name of the view.

Method Summary

Modifier and Type	Method	Description
static BiPredicate<EntityViewFactory,EntityViewContext>	defaultAccessValidator()	Returns a default access validator implementation that checks if there is an AllowableAction attribute on the EntityViewFactory and expects the action to be present in the EntityViewContext.getAllowableActions().

Methods inherited from class java.lang.Object

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

Field Details

VIEW_NAME

public static final String VIEW_NAME

Contains the name of the view.

VIEW_TEMPLATE_NAME

public static final String VIEW_TEMPLATE_NAME

Contains the template name of the view.

ADMIN_MENU

public static final String ADMIN_MENU

Contains a Consumer that takes an EntityAdminMenuEvent as parameter. Any view with this attribute will usually generate a menu item when the entity menu is being built.

ACCESS_VALIDATOR

public static final String ACCESS_VALIDATOR

Contains a java.util.function.BiPredicate<EntityViewFactory,EntityViewContext> that is to be used for checking if access to the EntityViewFactory is allowed. Usually the value of defaultAccessValidator() instance will be set, which checks on the presence of an AllowableAction.

Note that it is not strictly required to have a EntityViewContext for using the validator, meaning that implementations should take into account that the second argument can be null.

Method Details

defaultAccessValidator

public static BiPredicate<EntityViewFactory,EntityViewContext> defaultAccessValidator()

Returns a default access validator implementation that checks if there is an AllowableAction attribute on the EntityViewFactory and expects the action to be present in the EntityViewContext.getAllowableActions().

If there is no AllowableAction registered, the predicate will always allow access. If there is an AllowableAction but no EntityViewContext available, access will always be denied.

A predicate like this is usually registered as the ACCESS_VALIDATOR attribute.

Returns:

predicate