Package org.kuali.rice.krad.web.controller

Class UifControllerBase

java.lang.Object

org.kuali.rice.krad.web.controller.UifControllerBase

Direct Known Subclasses:

DocumentControllerBase, DummyLoginController, IncidentReportController, InitiatedDocumentInfoController, InquiryController, LookupController, MockViewController, ModuleLockedController, SessionTimeoutController, UifClientListener, UifExportController

public abstract class UifControllerBase
extends Object

Base controller class for views within the KRAD User Interface Framework.

Provides common methods such as navigation, collection handling, queries, and refresh calls. All subclass controller methods after processing should call one of the #getModelAndView methods to setup the View and return the ModelAndView instance.

Author:

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

Constructor Summary

Constructors

Constructor	Description
UifControllerBase()

Method Summary

Modifier and Type	Method	Description
org.springframework.web.servlet.ModelAndView	addBlankLine(UifFormBase form)
org.springframework.web.servlet.ModelAndView	addFileUploadLine(UifFormBase form)
org.springframework.web.servlet.ModelAndView	addLine(UifFormBase form)
org.springframework.web.servlet.ModelAndView	back(UifFormBase form)
org.springframework.web.servlet.ModelAndView	cancel(UifFormBase form)
org.springframework.web.servlet.ModelAndView	checkForm(UifFormBase form)
org.springframework.web.servlet.ModelAndView	closeEditLineDialog(UifFormBase form)
protected abstract UifFormBase	createInitialForm()	Invoked to create a new form instance for the request before it is passed to the Binder/BeanWrapper.
org.springframework.web.servlet.ModelAndView	defaultMapping(UifFormBase form)	Default method mapping for cases where the method to call is not passed, calls the start method.
org.springframework.web.servlet.ModelAndView	deleteFileUploadLine(UifFormBase form)
org.springframework.web.servlet.ModelAndView	deleteLine(UifFormBase form)
org.springframework.web.servlet.ModelAndView	editLine(UifFormBase form)
protected CollectionControllerService	getCollectionControllerService()
protected ControllerService	getControllerService()
protected FileControllerService	getFileControllerService()
void	getFileFromLine(UifFormBase form, javax.servlet.http.HttpServletResponse response)
protected org.springframework.web.servlet.ModelAndView	getMessageView(UifFormBase form, String headerText, String messageText)
protected org.springframework.web.servlet.ModelAndView	getModelAndView(UifFormBase form)
protected org.springframework.web.servlet.ModelAndView	getModelAndView(UifFormBase form, String pageId)
protected org.springframework.web.servlet.ModelAndView	getModelAndView(UifFormBase form, Map<String,Object> additionalViewAttributes)
protected ModelAndViewService	getModelAndViewService()
protected org.springframework.web.servlet.ModelAndView	getModelAndViewWithInit(UifFormBase form, String viewId)
protected org.springframework.web.servlet.ModelAndView	getModelAndViewWithInit(UifFormBase form, String viewId, String pageId)
protected NavigationControllerService	getNavigationControllerService()
protected QueryControllerService	getQueryControllerService()
protected RefreshControllerService	getRefreshControllerService()
SaveControllerService	getSaveControllerService()
protected UifFormBase	initForm()	Creates form instance the will be used for the default model.
org.springframework.web.servlet.ModelAndView	navigate(UifFormBase form)
AttributeQueryResult	performFieldQuery(UifFormBase form)
AttributeQueryResult	performFieldSuggest(UifFormBase form)
org.springframework.web.servlet.ModelAndView	performLookup(UifFormBase form)
protected org.springframework.web.servlet.ModelAndView	performRedirect(UifFormBase form, String redirectUrl)
protected org.springframework.web.servlet.ModelAndView	performRedirect(UifFormBase form, String baseUrl, Properties urlParameters)
org.springframework.web.servlet.ModelAndView	refresh(UifFormBase form)
org.springframework.web.servlet.ModelAndView	retrieveCollectionPage(UifFormBase form)
org.springframework.web.servlet.ModelAndView	retrieveEditLineDialog(UifFormBase form)
org.springframework.web.servlet.ModelAndView	returnToHub(UifFormBase form)
org.springframework.web.servlet.ModelAndView	returnToPrevious(UifFormBase form)
org.springframework.web.servlet.ModelAndView	save(UifFormBase form)
org.springframework.web.servlet.ModelAndView	saveField(UifFormBase form)
org.springframework.web.servlet.ModelAndView	saveLine(UifFormBase form)
org.springframework.web.servlet.ModelAndView	sessionTimeout(UifFormBase form)
void	setCollectionControllerService(CollectionControllerService collectionControllerService)
void	setControllerService(ControllerService controllerService)
void	setFileControllerService(FileControllerService fileControllerService)
void	setModelAndViewService(ModelAndViewService modelAndViewService)
void	setNavigationControllerService(NavigationControllerService navigationControllerService)
void	setQueryControllerService(QueryControllerService queryControllerService)
void	setRefreshControllerService(RefreshControllerService refreshControllerService)
void	setSaveControllerService(SaveControllerService saveControllerService)
protected org.springframework.web.servlet.ModelAndView	showDialog(String dialogId, boolean confirmation, UifFormBase form)
org.springframework.web.servlet.ModelAndView	start(UifFormBase form)
org.springframework.web.servlet.ModelAndView	tableJsonRetrieval(UifFormBase form)

Methods inherited from class java.lang.Object

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

Constructor Details

UifControllerBase

public UifControllerBase()

Method Details

initForm

@ModelAttribute("KualiForm")
protected UifFormBase initForm()

Creates form instance the will be used for the default model.

Returns:

UifFormBase form instance for holding model data

createInitialForm

protected abstract UifFormBase createInitialForm()

Invoked to create a new form instance for the request before it is passed to the Binder/BeanWrapper.

Returns:

UifFormBase instance that will be used for data binding and backing the view.

defaultMapping

@RequestMapping
public org.springframework.web.servlet.ModelAndView defaultMapping(UifFormBase form)

Default method mapping for cases where the method to call is not passed, calls the start method.

start

@RequestMapping(method=GET,
                params="methodToCall=start")
public org.springframework.web.servlet.ModelAndView start(UifFormBase form)

See Also:

• ControllerService.start(org.kuali.rice.krad.web.form.UifFormBase)

sessionTimeout

@RequestMapping(params="methodToCall=sessionTimeout")
public org.springframework.web.servlet.ModelAndView sessionTimeout(UifFormBase form)

See Also:

• ControllerService.sessionTimeout(org.kuali.rice.krad.web.form.UifFormBase)

cancel

@RequestMapping(params="methodToCall=cancel")
public org.springframework.web.servlet.ModelAndView cancel(UifFormBase form)

See Also:

• ControllerService.cancel(org.kuali.rice.krad.web.form.UifFormBase)

back

@RequestMapping(params="methodToCall=back")
public org.springframework.web.servlet.ModelAndView back(UifFormBase form)

See Also:

• NavigationControllerService.back(org.kuali.rice.krad.web.form.UifFormBase)

returnToPrevious

@RequestMapping(params="methodToCall=returnToPrevious")
public org.springframework.web.servlet.ModelAndView returnToPrevious(UifFormBase form)

See Also:

• NavigationControllerService.returnToPrevious(org.kuali.rice.krad.web.form.UifFormBase)

save

@RequestMapping(method=POST,
                params="methodToCall=save")
public org.springframework.web.servlet.ModelAndView save(UifFormBase form)
                                                  throws Exception

Throws:

Exception

See Also:

• SaveControllerService.save(org.kuali.rice.krad.web.form.UifFormBase)

saveField

@RequestMapping(method=POST,
                params="methodToCall=saveField")
public org.springframework.web.servlet.ModelAndView saveField(UifFormBase form)
                                                       throws Exception

Throws:

Exception

See Also:

• SaveControllerService.saveField(org.kuali.rice.krad.web.form.UifFormBase)

returnToHub

@RequestMapping(params="methodToCall=returnToHub")
public org.springframework.web.servlet.ModelAndView returnToHub(UifFormBase form)

See Also:

• NavigationControllerService.returnToHub(org.kuali.rice.krad.web.form.UifFormBase)

addFileUploadLine

@RequestMapping(method=POST,
                params="methodToCall=addFileUploadLine")
public org.springframework.web.servlet.ModelAndView addFileUploadLine(UifFormBase form)

See Also:

• FileControllerService.addFileUploadLine(org.kuali.rice.krad.web.form.UifFormBase)

deleteFileUploadLine

@RequestMapping(method=POST,
                params="methodToCall=deleteFileUploadLine")
public org.springframework.web.servlet.ModelAndView deleteFileUploadLine(UifFormBase form)

See Also:

• FileControllerService.deleteFileUploadLine(org.kuali.rice.krad.web.form.UifFormBase)

getFileFromLine

@RequestMapping(method=GET,
                params="methodToCall=getFileFromLine")
public void getFileFromLine(UifFormBase form,
 javax.servlet.http.HttpServletResponse response)

See Also:

• FileControllerService.getFileFromLine(org.kuali.rice.krad.web.form.UifFormBase, javax.servlet.http.HttpServletResponse)

navigate

@RequestMapping(method=POST,
                params="methodToCall=navigate")
public org.springframework.web.servlet.ModelAndView navigate(UifFormBase form)

See Also:

• NavigationControllerService.navigate(org.kuali.rice.krad.web.form.UifFormBase)

addLine

@RequestMapping(method=POST,
                params="methodToCall=addLine")
public org.springframework.web.servlet.ModelAndView addLine(UifFormBase form)

See Also:

• CollectionControllerService.addLine(org.kuali.rice.krad.web.form.UifFormBase)

addBlankLine

@RequestMapping(method=POST,
                params="methodToCall=addBlankLine")
public org.springframework.web.servlet.ModelAndView addBlankLine(UifFormBase form)

See Also:

• CollectionControllerService.addBlankLine(org.kuali.rice.krad.web.form.UifFormBase)

retrieveEditLineDialog

@RequestMapping(method=POST,
                params="methodToCall=retrieveEditLineDialog")
public org.springframework.web.servlet.ModelAndView retrieveEditLineDialog(UifFormBase form)

See Also:

• CollectionControllerService.retrieveEditLineDialog(org.kuali.rice.krad.web.form.UifFormBase)

editLine

@RequestMapping(method=POST,
                params="methodToCall=editLine")
public org.springframework.web.servlet.ModelAndView editLine(UifFormBase form)

See Also:

• CollectionControllerService.editLine(org.kuali.rice.krad.web.form.UifFormBase)

closeEditLineDialog

@RequestMapping(method=POST,
                params="methodToCall=closeEditLineDialog")
public org.springframework.web.servlet.ModelAndView closeEditLineDialog(UifFormBase form)

See Also:

• CollectionControllerService.closeEditLineDialog(org.kuali.rice.krad.web.form.UifFormBase)

saveLine

@RequestMapping(method=POST,
                params="methodToCall=saveLine")
public org.springframework.web.servlet.ModelAndView saveLine(UifFormBase form)

See Also:

• CollectionControllerService.saveLine(org.kuali.rice.krad.web.form.UifFormBase)

deleteLine

@RequestMapping(method=POST,
                params="methodToCall=deleteLine")
public org.springframework.web.servlet.ModelAndView deleteLine(UifFormBase form)

See Also:

• CollectionControllerService.deleteLine(org.kuali.rice.krad.web.form.UifFormBase)

retrieveCollectionPage

@RequestMapping(params="methodToCall=retrieveCollectionPage")
public org.springframework.web.servlet.ModelAndView retrieveCollectionPage(UifFormBase form)

See Also:

• CollectionControllerService.retrieveCollectionPage(org.kuali.rice.krad.web.form.UifFormBase)

tableJsonRetrieval

@RequestMapping(method=GET,
                params="methodToCall=tableJsonRetrieval")
public org.springframework.web.servlet.ModelAndView tableJsonRetrieval(UifFormBase form)

See Also:

• CollectionControllerService.tableJsonRetrieval(org.kuali.rice.krad.web.form.UifFormBase)

refresh

@MethodAccessible
@RequestMapping(params="methodToCall=refresh")
public org.springframework.web.servlet.ModelAndView refresh(UifFormBase form)

See Also:

• RefreshControllerService.refresh(org.kuali.rice.krad.web.form.UifFormBase)

performLookup

@RequestMapping(method=POST,
                params="methodToCall=performLookup")
public org.springframework.web.servlet.ModelAndView performLookup(UifFormBase form)

See Also:

• QueryControllerService.performLookup(org.kuali.rice.krad.web.form.UifFormBase)

performFieldSuggest

@RequestMapping(method=GET,
                params="methodToCall=performFieldSuggest")
@ResponseBody
public AttributeQueryResult performFieldSuggest(UifFormBase form)

See Also:

• QueryControllerService.performFieldSuggest(org.kuali.rice.krad.web.form.UifFormBase)

performFieldQuery

@RequestMapping(method=GET,
                params="methodToCall=performFieldQuery")
@ResponseBody
public AttributeQueryResult performFieldQuery(UifFormBase form)

See Also:

• QueryControllerService.performFieldQuery(org.kuali.rice.krad.web.form.UifFormBase)

checkForm

@RequestMapping(method=POST,
                params="methodToCall=checkForm")
public org.springframework.web.servlet.ModelAndView checkForm(UifFormBase form)

See Also:

• ModelAndViewService.checkForm(org.kuali.rice.krad.web.form.UifFormBase)

showDialog

protected org.springframework.web.servlet.ModelAndView showDialog(String dialogId,
 boolean confirmation,
 UifFormBase form)

See Also:

• ModelAndViewService.showDialog(java.lang.String, boolean, org.kuali.rice.krad.web.form.UifFormBase)

performRedirect

protected org.springframework.web.servlet.ModelAndView performRedirect(UifFormBase form,
 String baseUrl,
 Properties urlParameters)

See Also:

• ModelAndViewService.performRedirect(org.kuali.rice.krad.web.form.UifFormBase, java.lang.String, java.util.Properties)

performRedirect

protected org.springframework.web.servlet.ModelAndView performRedirect(UifFormBase form,
 String redirectUrl)

See Also:

• ModelAndViewService.performRedirect(org.kuali.rice.krad.web.form.UifFormBase, java.lang.String)

getMessageView

protected org.springframework.web.servlet.ModelAndView getMessageView(UifFormBase form,
 String headerText,
 String messageText)

See Also:

• ModelAndViewService.getMessageView(org.kuali.rice.krad.web.form.UifFormBase, java.lang.String, java.lang.String)

getModelAndView

protected org.springframework.web.servlet.ModelAndView getModelAndView(UifFormBase form)

See Also:

• ModelAndViewService.getModelAndView(org.kuali.rice.krad.web.form.UifFormBase)

getModelAndView

protected org.springframework.web.servlet.ModelAndView getModelAndView(UifFormBase form,
 String pageId)

See Also:

• ModelAndViewService.getModelAndView(org.kuali.rice.krad.web.form.UifFormBase, java.lang.String)

getModelAndView

protected org.springframework.web.servlet.ModelAndView getModelAndView(UifFormBase form,
 Map<String,Object> additionalViewAttributes)

See Also:

• ModelAndViewService.getModelAndView(org.kuali.rice.krad.web.form.UifFormBase, java.util.Map<java.lang.String,java.lang.Object>)

getModelAndViewWithInit

protected org.springframework.web.servlet.ModelAndView getModelAndViewWithInit(UifFormBase form,
 String viewId)

See Also:

• ModelAndViewService.getModelAndViewWithInit(org.kuali.rice.krad.web.form.UifFormBase, java.lang.String)

getModelAndViewWithInit

protected org.springframework.web.servlet.ModelAndView getModelAndViewWithInit(UifFormBase form,
 String viewId,
 String pageId)

See Also:

• ModelAndViewService.getModelAndViewWithInit(org.kuali.rice.krad.web.form.UifFormBase, java.lang.String, java.lang.String)

getControllerService

protected ControllerService getControllerService()

setControllerService

public void setControllerService(ControllerService controllerService)

getNavigationControllerService

protected NavigationControllerService getNavigationControllerService()

setNavigationControllerService

public void setNavigationControllerService(NavigationControllerService navigationControllerService)

getCollectionControllerService

protected CollectionControllerService getCollectionControllerService()

setCollectionControllerService

public void setCollectionControllerService(CollectionControllerService collectionControllerService)

getRefreshControllerService

protected RefreshControllerService getRefreshControllerService()

setRefreshControllerService

public void setRefreshControllerService(RefreshControllerService refreshControllerService)

getSaveControllerService

public SaveControllerService getSaveControllerService()

setSaveControllerService

public void setSaveControllerService(SaveControllerService saveControllerService)

getQueryControllerService

protected QueryControllerService getQueryControllerService()

setQueryControllerService

public void setQueryControllerService(QueryControllerService queryControllerService)

getFileControllerService

protected FileControllerService getFileControllerService()

setFileControllerService

public void setFileControllerService(FileControllerService fileControllerService)

getModelAndViewService

protected ModelAndViewService getModelAndViewService()

setModelAndViewService

public void setModelAndViewService(ModelAndViewService modelAndViewService)