Package org.kuali.rice.krad.web.service.impl

Class QueryControllerServiceImpl

java.lang.Object

org.kuali.rice.krad.web.service.impl.QueryControllerServiceImpl

All Implemented Interfaces:

QueryControllerService

public class QueryControllerServiceImpl
extends Object
implements QueryControllerService

Default implementation of the query controller service.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor	Description
QueryControllerServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	buildLookupCriteriaParameters(UifFormBase form, javax.servlet.http.HttpServletRequest request, Class<?> lookupDataObjectClass, Properties urlParameters)	If lookup criteria parameters were configured, pulls the values for those parameters from the form and passes as values to pre-populate the lookup view criteria.
protected void	buildLookupUrlParameters(UifFormBase form, javax.servlet.http.HttpServletRequest request, Class<?> lookupDataObjectClass, Properties urlParameters)	Modifies the given properties object representing the lookup URL parameters to add additional parameters based on the form and action parameters.
AttributeQueryService	getAttributeQueryService()
protected Class<?>	getLookupDataObjectClass(Properties urlParameters)	Returns the Class instance for the data object whose lookup view was requested.
protected String	getLookupUrlFromModuleService(Class<?> lookupDataObjectClass, Properties urlParameters)	Attempts to find a module service that claims responsibility for the given data object class and if found invokes that module service to build the lookup url.
protected ModelAndViewService	getModelAndViewService()	Instance of model and view service to use within the collection service.
AttributeQueryResult	performFieldQuery(UifFormBase form)	Retrieves field query parameters from the request and invokes AttributeQueryService.performFieldQuery(org.kuali.rice.krad.uif.lifecycle.ViewPostMetadata, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) to carry out the field query.
AttributeQueryResult	performFieldSuggest(UifFormBase form)	Retrieves suggest query parameters from the request and invokes AttributeQueryService.performFieldSuggestQuery(org.kuali.rice.krad.uif.lifecycle.ViewPostMetadata, java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) to carry out the suggest query.
org.springframework.web.servlet.ModelAndView	performLookup(UifFormBase form)	Inspects the given request and action parameters on the form to build a URL to the requested lookup view.
void	setAttributeQueryService(AttributeQueryService attributeQueryService)
void	setModelAndViewService(ModelAndViewService modelAndViewService)

Methods inherited from class java.lang.Object

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

Constructor Details

QueryControllerServiceImpl

public QueryControllerServiceImpl()

Method Details

performLookup

public org.springframework.web.servlet.ModelAndView performLookup(UifFormBase form)

Inspects the given request and action parameters on the form to build a URL to the requested lookup view.

First the data object class for the lookup view is found from the action parameters. A call is then made to check if there is a module service that handles that class, and if so the URL from the module service is used. If not, the base url is and other lookup URL parameters are created from the action parameters and form.

Handles the perform lookup action by building up a URL to the lookup view and configuring a redirect.

Specified by:

performLookup in interface QueryControllerService

Parameters:

form - form instance containing the model data

Returns:

ModelAndView configured for redirecting to the lookup view

See Also:

• getLookupDataObjectClass(java.util.Properties)
• getLookupUrlFromModuleService(java.lang.Class<?>, java.util.Properties)
• buildLookupUrlParameters(org.kuali.rice.krad.web.form.UifFormBase, javax.servlet.http.HttpServletRequest, java.lang.Class<?>, java.util.Properties)

getLookupDataObjectClass

protected Class<?> getLookupDataObjectClass(Properties urlParameters)

Returns the Class instance for the data object whose lookup view was requested.

Parameters:

urlParameters - properties containing the lookup configuration

Returns:

Classinvalid input: '<'?> lookup data object class

Throws:

RuntimeException - if class cannot be created from data object class name

getLookupUrlFromModuleService

protected String getLookupUrlFromModuleService(Class<?> lookupDataObjectClass,
 Properties urlParameters)

Attempts to find a module service that claims responsibility for the given data object class and if found invokes that module service to build the lookup url.

Parameters:

lookupDataObjectClass - data object class to find responsible module service for

urlParameters - properties containing the lookup configuration

Returns:

String lookup URL returned from module service, or null if not module service was found

buildLookupUrlParameters

protected void buildLookupUrlParameters(UifFormBase form,
 javax.servlet.http.HttpServletRequest request,
 Class<?> lookupDataObjectClass,
 Properties urlParameters)

Modifies the given properties object representing the lookup URL parameters to add additional parameters based on the form and action parameters.

Parameters:

form - form instance containing the model data

request - http request object being handled

lookupDataObjectClass - data object class the lookup URL is being built for

urlParameters - properties instance holding the lookup URL parameters

buildLookupCriteriaParameters

protected void buildLookupCriteriaParameters(UifFormBase form,
 javax.servlet.http.HttpServletRequest request,
 Class<?> lookupDataObjectClass,
 Properties urlParameters)

If lookup criteria parameters were configured, pulls the values for those parameters from the form and passes as values to pre-populate the lookup view criteria.

Parameters:

form - form instance containing the model data

request - http request object being handled

lookupDataObjectClass - data object class the lookup URL is being built for

urlParameters - properties instance holding the lookup URL parameters

performFieldSuggest

public AttributeQueryResult performFieldSuggest(UifFormBase form)

Retrieves suggest query parameters from the request and invokes AttributeQueryService.performFieldSuggestQuery(org.kuali.rice.krad.uif.lifecycle.ViewPostMetadata, java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) to carry out the suggest query. Invoked to provides options (execute a query) for a field that contains a suggest widget.

Specified by:

performFieldSuggest in interface QueryControllerService

Parameters:

form - form instance containing the model data

Returns:

AttributeQueryResult containing the results of the suggest query

performFieldQuery

public AttributeQueryResult performFieldQuery(UifFormBase form)

Retrieves field query parameters from the request and invokes AttributeQueryService.performFieldQuery(org.kuali.rice.krad.uif.lifecycle.ViewPostMetadata, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) to carry out the field query. Invoked to execute the attribute query associated with a field given the query parameters found in the request

Specified by:

performFieldQuery in interface QueryControllerService

Parameters:

form - form instance containing the model data

Returns:

AttributeQueryResult containing the results of the field query

getModelAndViewService

protected ModelAndViewService getModelAndViewService()

Instance of model and view service to use within the collection service.

Returns:

ModelAndViewService instance

setModelAndViewService

public void setModelAndViewService(ModelAndViewService modelAndViewService)

See Also:

• CollectionControllerServiceImpl.getModelAndViewService()

getAttributeQueryService

public AttributeQueryService getAttributeQueryService()

setAttributeQueryService

public void setAttributeQueryService(AttributeQueryService attributeQueryService)