com.qcadoo.view.api.crud

Interface CrudService

public interface CrudService

Service for accessing high-level controller functions. It should be used when creating Spring MVC Controller and want to extend qcadoo framework standard mechanisms.

Some example of how CrudService can be used (inside Spring MVC Controller):

 
 
 
 
 
 
 
 @RequestMapping(value = "examplePluginPages/infoPage", method = RequestMethod.GET)
 public ModelAndView getInfoPageView(@RequestParam final Map<String, String> arguments, final Locale locale) {
     arguments.put("popup", "true");
     ModelAndView mav = crudService.prepareView("examplePlugin", "exampleView", arguments, locale);
 
     // some ModelAndView modifications, like:
     mav.addObject("headerClass", "successHeader");
 
     return mav;
 }
 
 

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
ViewDefinitionState	invokeEvent(String pluginIdentifier, String viewName, JSONObject body, Locale locale) Performs event on specified view and returns view definition state.
JSONObject	invokeEventAndRenderView(String pluginIdentifier, String viewName, JSONObject body, Locale locale) Performs event on specified view and returns the result
org.springframework.web.servlet.ModelAndView	prepareView(String pluginIdentifier, String viewName, Map<String,String> arguments, Locale locale) Generates Spring ModelAndView for specified view.
JSONObject	renderView(ViewDefinitionState state) Render given view definition state.

Method Detail

invokeEvent

ViewDefinitionState invokeEvent(String pluginIdentifier,
                                String viewName,
                                JSONObject body,
                                Locale locale)

Performs event on specified view and returns view definition state.

Parameters:

pluginIdentifier - identifier of plugin

viewName - name of view

body - request json body

locale - current locale

Returns:

view definition state

Since:

0.4.1

invokeEventAndRenderView

JSONObject invokeEventAndRenderView(String pluginIdentifier,
                                    String viewName,
                                    JSONObject body,
                                    Locale locale)

Performs event on specified view and returns the result

Parameters:

pluginIdentifier - identifier of plugin

viewName - name of view

body - request json body

locale - current locale

Returns:

JSONObject generated by performing event

prepareView

org.springframework.web.servlet.ModelAndView prepareView(String pluginIdentifier,
                                                         String viewName,
                                                         Map<String,String> arguments,
                                                         Locale locale)

Generates Spring ModelAndView for specified view.

Parameters:

pluginIdentifier - identifier of plugin

viewName - name of view

arguments - map of arguments

locale - current locale

Returns:

generated ModelAndView

renderView

JSONObject renderView(ViewDefinitionState state)

Render given view definition state.

Parameters:

state - view definition state

Returns:

JSONObject

Since:

0.4.1