org.kuali.rice.krms.impl.ui

Class AgendaEditorController

java.lang.Object

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

org.kuali.rice.krad.document.DocumentControllerBase

org.kuali.rice.krad.maintenance.MaintenanceDocumentController

org.kuali.rice.krms.impl.ui.AgendaEditorController

@Controller
@RequestMapping(value="krmsAgendaEditor")
public class AgendaEditorController
extends MaintenanceDocumentController

Controller for the Test UI Page

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AgendaEditorController.AgendaItemChildAccessor This class abstracts getting and setting a child of an AgendaItemBo, making some recursive operations require less boiler plate.

Constructor Summary

Constructors

Constructor and Description
AgendaEditorController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	addProposition(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	addRule(UifFormBase form) This method adds the newly create rule to the agenda.
org.springframework.web.servlet.ModelAndView	ajaxCut(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxDelete(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxMoveDown(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxMoveLeft(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxMoveRight(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxMoveUp(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxPaste(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	ajaxRefresh(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	ajaxValidRuleName(String name, String namespace) Exposes Ajax callback to UI to validate entered rule name to copy
org.springframework.web.servlet.ModelAndView	copyRule(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	cutProposition(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	deleteProposition(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	editRule(UifFormBase form) This method updates the existing rule in the agenda.
protected Map<String,String>	getCustomOperatorValueMap(UifFormBase form) Gets a map from function ID to custom operator key.
protected String	getDefaultAddLocationPropositionId(Node<RuleTreeNode,String> root) This method gets the last propostion in the topmost branch.
protected Node<RuleTreeNode,String>	getLastSimpleNode(List<Node<RuleTreeNode,String>> grandChildren) This method returns the last simple node in the topmost branch.
org.springframework.web.servlet.ModelAndView	goToAddRule(UifFormBase form) This method updates the existing rule in the agenda.
org.springframework.web.servlet.ModelAndView	goToEditProposition(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method starts an edit proposition.
org.springframework.web.servlet.ModelAndView	goToEditRule(UifFormBase form) This method updates the existing rule in the agenda.
org.springframework.web.servlet.ModelAndView	movePropositionDown(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	movePropositionLeft(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	movePropositionRight(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	movePropositionUp(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	pasteProposition(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	preprocessCustomOperators(PropositionBo proposition, Map<String,String> customOperatorValuesMap) Looks for any custom function calls within simple propositions and attempts to convert them to custom operator keys.
org.springframework.web.servlet.ModelAndView	refresh(UifFormBase form) This overridden method does extra work on refresh to update the namespace when the context has been changed.
org.springframework.web.servlet.ModelAndView	route(DocumentFormBase form) Override route to set the setSelectedAgendaItemId to empty and disable all the buttons
org.springframework.web.servlet.ModelAndView	setupMaintenanceEdit(MaintenanceDocumentForm form)
org.springframework.web.servlet.ModelAndView	togglePropositionSimpleCompound(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) introduces a new compound proposition between the selected proposition and its parent.
org.springframework.web.servlet.ModelAndView	updateCompoundOperator(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.kuali.rice.krad.maintenance.MaintenanceDocumentController

createInitialForm, downloadDataObjectAttachment, getControllerService, maintenanceDelete, setControllerService, setupMaintenanceCopy, setupMaintenanceNewWithExisting

Methods inherited from class org.kuali.rice.krad.document.DocumentControllerBase

acknowledge, approve, blanketApprove, cancelAttachment, complete, deleteNote, disapprove, docHandler, downloadAttachment, fyi, insertNote, recall, reload, save, save, sendAdHocRequests, superUserApprove, superUserDisapprove, superUserTakeActions, supervisorFunctions

Methods inherited from class org.kuali.rice.krad.web.controller.UifControllerBase

addBlankLine, addFileUploadLine, addLine, back, cancel, checkForm, defaultMapping, deleteFileUploadLine, deleteLine, editLine, getCollectionControllerService, getFileControllerService, getFileFromLine, getMessageView, getModelAndView, getModelAndView, getModelAndView, getModelAndViewService, getModelAndViewWithInit, getModelAndViewWithInit, getNavigationControllerService, getQueryControllerService, getRefreshControllerService, getSaveControllerService, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, retrieveCollectionPage, returnToHub, returnToPrevious, saveField, saveLine, sessionTimeout, setCollectionControllerService, setFileControllerService, setModelAndViewService, setNavigationControllerService, setQueryControllerService, setRefreshControllerService, setSaveControllerService, showDialog, start, tableJsonRetrieval

Methods inherited from class java.lang.Object

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

Constructor Detail

AgendaEditorController

public AgendaEditorController()

Method Detail

route

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

Override route to set the setSelectedAgendaItemId to empty and disable all the buttons

Overrides:

route in class DocumentControllerBase

See Also:

(DocumentFormBase, BindingResult, HttpServletRequest, HttpServletResponse)

refresh

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

This overridden method does extra work on refresh to update the namespace when the context has been changed.

Overrides:

refresh in class UifControllerBase

See Also:

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

setupMaintenanceEdit

public org.springframework.web.servlet.ModelAndView setupMaintenanceEdit(MaintenanceDocumentForm form)

Overrides:

setupMaintenanceEdit in class MaintenanceDocumentController

See Also:

MaintenanceDocumentControllerService.setupMaintenanceEdit(org.kuali.rice.krad.web.form.MaintenanceDocumentForm)

goToAddRule

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

This method updates the existing rule in the agenda.

Throws:

Exception

goToEditRule

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

This method updates the existing rule in the agenda.

Throws:

Exception

getCustomOperatorValueMap

protected Map<String,String> getCustomOperatorValueMap(UifFormBase form)

Gets a map from function ID to custom operator key.

The key for a custom operator uses a special prefix and format.

Parameters:

form - the form containing the agenda editor

Returns:

the map from function id to custom operator key

preprocessCustomOperators

protected void preprocessCustomOperators(PropositionBo proposition,
                             Map<String,String> customOperatorValuesMap)

Looks for any custom function calls within simple propositions and attempts to convert them to custom operator keys.

Parameters:

proposition - the proposition to search within and convert

customOperatorValuesMap - a map from function ID to custom operator key, used for the conversion

addRule

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

This method adds the newly create rule to the agenda.

Throws:

Exception

editRule

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

This method updates the existing rule in the agenda.

Throws:

Exception

ajaxRefresh

@RequestMapping(params="methodToCall=ajaxRefresh")
public org.springframework.web.servlet.ModelAndView ajaxRefresh(@ModelAttribute(value="KualiForm")
                                                                      UifFormBase form,
                                                                      org.springframework.validation.BindingResult result,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                         throws Exception

Throws:

Exception

ajaxMoveUp

@RequestMapping(params="methodToCall=ajaxMoveUp")
public org.springframework.web.servlet.ModelAndView ajaxMoveUp(@ModelAttribute(value="KualiForm")
                                                                     UifFormBase form,
                                                                     org.springframework.validation.BindingResult result,
                                                                     javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)
                                                        throws Exception

Throws:

Exception

ajaxValidRuleName

@RequestMapping(params="methodToCall=ajaxValidRuleName",
                method=GET)
@ResponseBody
public boolean ajaxValidRuleName(@RequestParam
                                                    String name,
                                                    @RequestParam
                                                    String namespace)

Exposes Ajax callback to UI to validate entered rule name to copy

Parameters:

name - the copyRuleName

namespace - the rule namespace

Returns:

true or false

ajaxMoveDown

@RequestMapping(params="methodToCall=ajaxMoveDown")
public org.springframework.web.servlet.ModelAndView ajaxMoveDown(@ModelAttribute(value="KualiForm")
                                                                       UifFormBase form,
                                                                       org.springframework.validation.BindingResult result,
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Throws:

Exception

ajaxMoveLeft

@RequestMapping(params="methodToCall=ajaxMoveLeft")
public org.springframework.web.servlet.ModelAndView ajaxMoveLeft(@ModelAttribute(value="KualiForm")
                                                                       UifFormBase form,
                                                                       org.springframework.validation.BindingResult result,
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Throws:

Exception

ajaxMoveRight

@RequestMapping(params="methodToCall=ajaxMoveRight")
public org.springframework.web.servlet.ModelAndView ajaxMoveRight(@ModelAttribute(value="KualiForm")
                                                                        UifFormBase form,
                                                                        org.springframework.validation.BindingResult result,
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        javax.servlet.http.HttpServletResponse response)
                                                           throws Exception

Throws:

Exception

ajaxDelete

@RequestMapping(params="methodToCall=ajaxDelete")
public org.springframework.web.servlet.ModelAndView ajaxDelete(@ModelAttribute(value="KualiForm")
                                                                     UifFormBase form,
                                                                     org.springframework.validation.BindingResult result,
                                                                     javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)
                                                        throws Exception

Throws:

Exception

ajaxCut

@RequestMapping(params="methodToCall=ajaxCut")
public org.springframework.web.servlet.ModelAndView ajaxCut(@ModelAttribute(value="KualiForm")
                                                                  UifFormBase form,
                                                                  org.springframework.validation.BindingResult result,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                     throws Exception

Throws:

Exception

ajaxPaste

@RequestMapping(params="methodToCall=ajaxPaste")
public org.springframework.web.servlet.ModelAndView ajaxPaste(@ModelAttribute(value="KualiForm")
                                                                    UifFormBase form,
                                                                    org.springframework.validation.BindingResult result,
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response)
                                                       throws Exception

Throws:

Exception

copyRule

@RequestMapping(params="methodToCall=copyRule")
public org.springframework.web.servlet.ModelAndView copyRule(@ModelAttribute(value="KualiForm")
                                                                   UifFormBase form,
                                                                   org.springframework.validation.BindingResult result,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response)
                                                      throws Exception

Throws:

Exception

goToEditProposition

@RequestMapping(params="methodToCall=goToEditProposition")
public org.springframework.web.servlet.ModelAndView goToEditProposition(@ModelAttribute(value="KualiForm")
                                                                              UifFormBase form,
                                                                              org.springframework.validation.BindingResult result,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

This method starts an edit proposition.

Throws:

Exception

getLastSimpleNode

protected Node<RuleTreeNode,String> getLastSimpleNode(List<Node<RuleTreeNode,String>> grandChildren)

This method returns the last simple node in the topmost branch.

Parameters:

grandChildren -

Returns:

getDefaultAddLocationPropositionId

protected String getDefaultAddLocationPropositionId(Node<RuleTreeNode,String> root)

This method gets the last propostion in the topmost branch.

Parameters:

root -

Returns:

addProposition

@RequestMapping(params="methodToCall=addProposition")
public org.springframework.web.servlet.ModelAndView addProposition(@ModelAttribute(value="KualiForm")
                                                                         UifFormBase form,
                                                                         org.springframework.validation.BindingResult result,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         javax.servlet.http.HttpServletResponse response)
                                                            throws Exception

Throws:

Exception

movePropositionUp

@RequestMapping(params="methodToCall=movePropositionUp")
public org.springframework.web.servlet.ModelAndView movePropositionUp(@ModelAttribute(value="KualiForm")
                                                                            UifFormBase form,
                                                                            org.springframework.validation.BindingResult result,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)
                                                               throws Exception

Throws:

Exception

movePropositionDown

@RequestMapping(params="methodToCall=movePropositionDown")
public org.springframework.web.servlet.ModelAndView movePropositionDown(@ModelAttribute(value="KualiForm")
                                                                              UifFormBase form,
                                                                              org.springframework.validation.BindingResult result,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

Throws:

Exception

movePropositionLeft

@RequestMapping(params="methodToCall=movePropositionLeft")
public org.springframework.web.servlet.ModelAndView movePropositionLeft(@ModelAttribute(value="KualiForm")
                                                                              UifFormBase form,
                                                                              org.springframework.validation.BindingResult result,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

Throws:

Exception

movePropositionRight

@RequestMapping(params="methodToCall=movePropositionRight")
public org.springframework.web.servlet.ModelAndView movePropositionRight(@ModelAttribute(value="KualiForm")
                                                                               UifFormBase form,
                                                                               org.springframework.validation.BindingResult result,
                                                                               javax.servlet.http.HttpServletRequest request,
                                                                               javax.servlet.http.HttpServletResponse response)
                                                                  throws Exception

Throws:

Exception

togglePropositionSimpleCompound

@RequestMapping(params="methodToCall=togglePropositionSimpleCompound")
public org.springframework.web.servlet.ModelAndView togglePropositionSimpleCompound(@ModelAttribute(value="KualiForm")
                                                                                          UifFormBase form,
                                                                                          org.springframework.validation.BindingResult result,
                                                                                          javax.servlet.http.HttpServletRequest request,
                                                                                          javax.servlet.http.HttpServletResponse response)
                                                                             throws Exception

introduces a new compound proposition between the selected proposition and its parent. Additionally, it puts a new blank simple proposition underneath the compound proposition as a sibling to the selected proposition.

Throws:

Exception

cutProposition

@RequestMapping(params="methodToCall=cutProposition")
public org.springframework.web.servlet.ModelAndView cutProposition(@ModelAttribute(value="KualiForm")
                                                                         UifFormBase form,
                                                                         org.springframework.validation.BindingResult result,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         javax.servlet.http.HttpServletResponse response)
                                                            throws Exception

Throws:

Exception

pasteProposition

@RequestMapping(params="methodToCall=pasteProposition")
public org.springframework.web.servlet.ModelAndView pasteProposition(@ModelAttribute(value="KualiForm")
                                                                           UifFormBase form,
                                                                           org.springframework.validation.BindingResult result,
                                                                           javax.servlet.http.HttpServletRequest request,
                                                                           javax.servlet.http.HttpServletResponse response)
                                                              throws Exception

Throws:

Exception

deleteProposition

@RequestMapping(params="methodToCall=deleteProposition")
public org.springframework.web.servlet.ModelAndView deleteProposition(@ModelAttribute(value="KualiForm")
                                                                            UifFormBase form,
                                                                            org.springframework.validation.BindingResult result,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)
                                                               throws Exception

Throws:

Exception

updateCompoundOperator

@RequestMapping(params="methodToCall=updateCompoundOperator")
public org.springframework.web.servlet.ModelAndView updateCompoundOperator(@ModelAttribute(value="KualiForm")
                                                                                 UifFormBase form,
                                                                                 org.springframework.validation.BindingResult result,
                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                 javax.servlet.http.HttpServletResponse response)
                                                                    throws Exception

Throws:

Exception