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

Interface EntityViewProcessor

All Known Implementing Classes:

AbstractEntityFetchingViewProcessor, ActionAllowedAuthorizationViewProcessor, AssociationHeaderViewProcessor, DefaultEntityFetchingViewProcessor, DefaultValidationViewProcessor, DelegatingEntityFetchingViewProcessor, DeleteActionFormViewProcessor, DeleteEntityViewProcessor, DetailFormViewProcessor, EntityPropertyRegistryViewProcessor, EntityQueryFilterProcessor, EntityViewLinksUtilsProcessors.AfterSaveEntityViewRedirectProcessor, EntityViewLinksUtilsProcessors.ButtonRedirectEntityViewRedirectProcessor, EntityViewLinksUtilsProcessors.EntityViewRedirectProcessor, EntityViewProcessorAdapter, ExtensionViewProcessorAdapter, GlobalPageFeedbackViewProcessor, ListFormViewProcessor, ListPageStructureViewProcessor, MessagePrefixingViewProcessor, PageableExtensionViewProcessor, PropertyRenderingViewProcessor, SaveEntityViewProcessor, SimpleEntityViewProcessorAdapter, SingleEntityFormViewProcessor, SingleEntityPageStructureViewProcessor, SortableTableRenderingViewProcessor, TemplateViewProcessor

public interface EntityViewProcessor

Default processor interface for entity view processing. Whereas there is only a single EntityViewFactory, if that factory implements DefaultEntityViewFactory there can be multiple processors that modify the resulting view.

Author:

Arne Vandamme

See Also:

• DefaultEntityViewFactory

Method Summary

Modifier and Type	Method	Description
void	authorizeRequest(EntityViewRequest entityViewRequest)	Verify the EntityViewRequest is valid for this factory.
void	doControl(EntityViewRequest entityViewRequest, EntityView entityView, EntityViewCommand command)	Called after preProcess(EntityViewRequest, EntityView) but before any rendering.
void	initializeCommandObject(EntityViewRequest entityViewRequest, EntityViewCommand command, org.springframework.web.bind.WebDataBinder dataBinder)	Initialize the EntityViewCommand for the given request.
void	postProcess(EntityViewRequest entityViewRequest, EntityView entityView)	Post-process the created EntityView after control and render have completed.
void	postRender(EntityViewRequest entityViewRequest, EntityView entityView)	Called after render(EntityViewRequest, EntityView) but only if rendering happened.
void	prepareEntityViewContext(ConfigurableEntityViewContext entityViewContext)	Apply possible factory modifications to the ConfigurableEntityViewContext.
void	preProcess(EntityViewRequest entityViewRequest, EntityView entityView)	Pre-process the created EntityView before any of the control or rendering methods are called.
void	preRender(EntityViewRequest entityViewRequest, EntityView entityView)	Called after doControl(EntityViewRequest, EntityView, com.foreach.across.modules.entity.views.request.EntityViewCommand) but only if rendering is supposed to happen.
void	render(EntityViewRequest entityViewRequest, EntityView entityView)	Called after doControl(EntityViewRequest, EntityView, com.foreach.across.modules.entity.views.request.EntityViewCommand).

Method Details

prepareEntityViewContext

void prepareEntityViewContext(ConfigurableEntityViewContext entityViewContext)

Apply possible factory modifications to the ConfigurableEntityViewContext. Call this method before creating an EntityViewRequest that uses the context.

This method is called first, before authorizeRequest(EntityViewRequest) in the default view rendering.

Parameters:

entityViewContext - to modify

authorizeRequest

void authorizeRequest(EntityViewRequest entityViewRequest)

Verify the EntityViewRequest is valid for this factory. This usually means things like performing security checks and checking all individual properties are valid.

Any invalid requests are expected to throw the most relevant exceptions.

Called after prepareEntityViewContext(ConfigurableEntityViewContext) but before initializing the command object.

Parameters:

entityViewRequest - request to validate

initializeCommandObject

void initializeCommandObject(EntityViewRequest entityViewRequest,
 EntityViewCommand command,
 org.springframework.web.bind.WebDataBinder dataBinder)

Initialize the EntityViewCommand for the given request. Optionally configure the WebDataBinder that will be used to bind the command object.

Parameters:

entityViewRequest - request

command - object

dataBinder - to bind the web request to the command

preProcess

void preProcess(EntityViewRequest entityViewRequest,
 EntityView entityView)

Pre-process the created EntityView before any of the control or rendering methods are called.

Parameters:

entityViewRequest - request

entityView - model and view

doControl

void doControl(EntityViewRequest entityViewRequest,
 EntityView entityView,
 EntityViewCommand command)

Called after preProcess(EntityViewRequest, EntityView) but before any rendering.

Parameters:

entityViewRequest - request

entityView - model and view

command - object for the request

preRender

void preRender(EntityViewRequest entityViewRequest,
 EntityView entityView)

Called after doControl(EntityViewRequest, EntityView, com.foreach.across.modules.entity.views.request.EntityViewCommand) but only if rendering is supposed to happen.

Parameters:

entityViewRequest - request

entityView - model and view

See Also:

• EntityView.shouldRender()

render

void render(EntityViewRequest entityViewRequest,
 EntityView entityView)

Called after doControl(EntityViewRequest, EntityView, com.foreach.across.modules.entity.views.request.EntityViewCommand).

Parameters:

entityViewRequest - request

entityView - model and view

See Also:

• EntityView.shouldRender()

postRender

void postRender(EntityViewRequest entityViewRequest,
 EntityView entityView)

Called after render(EntityViewRequest, EntityView) but only if rendering happened.

Parameters:

entityViewRequest - request

entityView - model and view

See Also:

• EntityView.shouldRender()

postProcess

void postProcess(EntityViewRequest entityViewRequest,
 EntityView entityView)

Post-process the created EntityView after control and render have completed. This method will always be called, even if render was skipped.

Parameters:

entityViewRequest - request

entityView - model and view