org.kuali.rice.krms.controller

Class RuleEditorController

java.lang.Object

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

org.kuali.rice.krad.web.controller.DocumentControllerBase

org.kuali.rice.krad.web.controller.MaintenanceDocumentController

org.kuali.rice.krms.controller.RuleEditorController

Direct Known Subclasses:

EnrolRuleEditorController, ProposalController

public class RuleEditorController
extends MaintenanceDocumentController

Controller for the KS KRMS page.

Author:

Kuali Student Team

Field Summary

Fields inherited from class org.kuali.rice.krad.web.controller.MaintenanceDocumentController

LOG

Fields inherited from class org.kuali.rice.krad.web.controller.DocumentControllerBase

DOCUMENT_LOAD_COMMANDS

Constructor Summary

Constructors

Constructor and Description
RuleEditorController()

Method Summary

Methods

Modifier and Type	Method and Description
ModelAndView	addProposition(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Method to initialize the adding of proposition to rule.
ModelAndView	addRule(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Navigates to rule maintenance page with rule type to initialize adding of new rule.
ModelAndView	ajaxRefresh(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Call the super method to avoid the agenda tree being reloaded from the db.
ModelAndView	cancelEditProposition(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Reverts rule to previous state and refreshes view.
ModelAndView	cancelEditRule(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Reverts rule to previous state and navigates to agenda maintenance page.
protected void	compareRulePropositions(MaintenanceDocumentForm form, RuleEditor ruleEditor)
ModelAndView	compareRules(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Test method for a controller that invokes a dialog lightbox.
ModelAndView	copyRule(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Method to copy rule.
ModelAndView	deleteProposition(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Removes proposition.
ModelAndView	deleteRule(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Deletes selected rule from agenda on Manage Course Requistes page
protected void	doCompareRules(UifFormBase form)
protected MaintenanceDocumentForm	getMaintenanceDocumentForm(UifFormBase form)
protected RuleEditor	getRuleEditor(UifFormBase form) Retrieves selected rule editor from data object.
ModelAndView	getSelectedKey(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Retrieves selected proposition key and initializes edit on propostion.
protected RuleViewHelperService	getViewHelper(UifFormBase form) Returns form's view helper serivce.
ModelAndView	goToEditProposition(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) This method starts an edit on proposition.
ModelAndView	goToRuleView(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Method used to invoke the CO inquiry view from Manage Course Offering screen while search input is Course Offering Code (04a screen)
boolean	isSimpleNode(String nodeType) Returns true if node is of type simple
ModelAndView	movePropositionDown(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Moves proposition down in tree structure.
ModelAndView	movePropositionLeft(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Moves proposition left in tree structure.
ModelAndView	movePropositionRight(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Move proposition right in tree structure.
ModelAndView	movePropositionUp(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Moves proposition up in tree structure.
ModelAndView	pasteProposition(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Paste proposition in selected position in tree structure.
ModelAndView	refreshLogicArea(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Refreshes logic area input field when changing tabs.
protected RuleEditor	retrieveSelectedRuleEditor(MaintenanceDocumentForm document)
ModelAndView	togglePropositionSimpleCompound(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Introduces a new compound proposition between the selected proposition and its parent.
ModelAndView	updateCompoundOperator(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Updates compound operator in tree structure.
ModelAndView	updatePreview(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Updates view with changed logic expressions.
ModelAndView	updateProposition(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Updates rule with new or changed propositions.
ModelAndView	updatePropositionType(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Updates proposition type and reloads view.
ModelAndView	updateRule(UifFormBase form, BindingResult result, HttpServletRequest request, HttpServletResponse response) Updates rule and redirects to agenda maintenance page.

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

createInitialForm, docHandler, downloadBOAttachment, getMaintenanceDocumentService, maintenanceCopy, maintenanceDelete, maintenanceEdit, maintenanceNewWithExisting, route, setupMaintenance, start

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

acknowledge, approve, blanketApprove, buildAuthorizationException, cancel, cancelAttachment, checkAndWarnAboutSensitiveData, combineAdHocRecipients, complete, createDocument, deleteNote, disapprove, downloadAttachment, fyi, generateDisapprovalNote, getAttachmentService, getConfigurationService, getDataDictionaryService, getDocumentDictionaryService, getDocumentService, getLegacyDataAdapter, getNoteService, insertNote, loadDocument, performWorkflowAction, reload, save, sendAdHocRequests, setDataDictionaryService, setDocumentDictionaryService, setDocumentService, setLegacyDataAdapter, supervisorFunctions

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

addBlankLine, addLine, back, checkForm, checkViewAuthorization, defaultMapping, deleteLine, getBooleanDialogResponse, getMessageView, getStringDialogResponse, getUIFModelAndView, getUIFModelAndView, getUIFModelAndView, getUIFModelAndViewWithInit, getViewService, hasDialogBeenAnswered, hasDialogBeenDisplayed, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, refresh, resetDialogStatus, retrieveCollectionPage, returnFromLightbox, returnToHistory, returnToHub, returnToPrevious, saveLine, sessionTimeout, showDialog, tableJsonRetrieval

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleEditorController

public RuleEditorController()

Method Detail

goToRuleView

@RequestMapping(params="methodToCall=goToRuleView")
public ModelAndView goToRuleView(@ModelAttribute(value="KualiForm")
                                             UifFormBase form,
                                             BindingResult result,
                                             HttpServletRequest request,
                                             HttpServletResponse response)

Method used to invoke the CO inquiry view from Manage Course Offering screen while search input is Course Offering Code (04a screen)

Parameters:

form -

result -

request -

response -

Returns:

deleteRule

@MethodAccessible
@RequestMapping(params="methodToCall=deleteRule")
public ModelAndView deleteRule(@ModelAttribute(value="KualiForm")
                                                            UifFormBase form,
                                                            BindingResult result,
                                                            HttpServletRequest request,
                                                            HttpServletResponse response)

Deletes selected rule from agenda on Manage Course Requistes page

Parameters:

form -

result -

request -

response -

Returns:

addRule

@RequestMapping(params="methodToCall=addRule")
public ModelAndView addRule(@ModelAttribute(value="KualiForm")
                                        UifFormBase form,
                                        BindingResult result,
                                        HttpServletRequest request,
                                        HttpServletResponse response)

Navigates to rule maintenance page with rule type to initialize adding of new rule.

Parameters:

form -

result -

request -

response -

Returns:

ajaxRefresh

@RequestMapping(params="methodToCall=ajaxRefresh")
public ModelAndView ajaxRefresh(@ModelAttribute(value="KualiForm")
                                            UifFormBase form,
                                            BindingResult result,
                                            HttpServletRequest request,
                                            HttpServletResponse response)

Call the super method to avoid the agenda tree being reloaded from the db.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

getRuleEditor

protected RuleEditor getRuleEditor(UifFormBase form)

Retrieves selected rule editor from data object.

Parameters:

form -

Returns:

the current rule editor

copyRule

@MethodAccessible
@RequestMapping(params="methodToCall=copyRule")
public ModelAndView copyRule(@ModelAttribute(value="KualiForm")
                                                          UifFormBase form,
                                                          BindingResult result,
                                                          HttpServletRequest request,
                                                          HttpServletResponse response)
                      throws Exception

Method to copy rule.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

goToEditProposition

@MethodAccessible
@RequestMapping(params="methodToCall=goToEditProposition")
public ModelAndView goToEditProposition(@ModelAttribute(value="KualiForm")
                                                                     UifFormBase form,
                                                                     BindingResult result,
                                                                     HttpServletRequest request,
                                                                     HttpServletResponse response)

This method starts an edit on proposition.

Parameters:

form -

result -

request -

response -

Returns:

addProposition

@MethodAccessible
@RequestMapping(params="methodToCall=addProposition")
public ModelAndView addProposition(@ModelAttribute(value="KualiForm")
                                                                UifFormBase form,
                                                                BindingResult result,
                                                                HttpServletRequest request,
                                                                HttpServletResponse response)

Method to initialize the adding of proposition to rule.

Parameters:

form -

result -

request -

response -

Returns:

movePropositionUp

@MethodAccessible
@RequestMapping(params="methodToCall=movePropositionUp")
public ModelAndView movePropositionUp(@ModelAttribute(value="KualiForm")
                                                                   UifFormBase form,
                                                                   BindingResult result,
                                                                   HttpServletRequest request,
                                                                   HttpServletResponse response)

Moves proposition up in tree structure.

Parameters:

form -

result -

request -

response -

Returns:

movePropositionDown

@MethodAccessible
@RequestMapping(params="methodToCall=movePropositionDown")
public ModelAndView movePropositionDown(@ModelAttribute(value="KualiForm")
                                                                     UifFormBase form,
                                                                     BindingResult result,
                                                                     HttpServletRequest request,
                                                                     HttpServletResponse response)

Moves proposition down in tree structure.

Parameters:

form -

result -

request -

response -

Returns:

isSimpleNode

public boolean isSimpleNode(String nodeType)

Returns true if node is of type simple

Parameters:

nodeType -

Returns:

if node is of type simple; false otherwise

movePropositionLeft

@MethodAccessible
@RequestMapping(params="methodToCall=movePropositionLeft")
public ModelAndView movePropositionLeft(@ModelAttribute(value="KualiForm")
                                                                     UifFormBase form,
                                                                     BindingResult result,
                                                                     HttpServletRequest request,
                                                                     HttpServletResponse response)

Moves proposition left in tree structure.

Rough algorithm for moving a node up.

find the following: node := the selected node parent := the selected node's parent, its containing node (via when true or when false relationship) parentsOlderCousin := the parent's level-order predecessor (sibling or cousin)

Parameters:

form -

result -

request -

response -

Returns:

movePropositionRight

@MethodAccessible
@RequestMapping(params="methodToCall=movePropositionRight")
public ModelAndView movePropositionRight(@ModelAttribute(value="KualiForm")
                                                                      UifFormBase form,
                                                                      BindingResult result,
                                                                      HttpServletRequest request,
                                                                      HttpServletResponse response)

Move proposition right in tree structure.

Rough algorithm for moving a node Right if the selected node is above a compound proposition, move it into the compound proposition as the first child if the node is above a simple proposition, do nothing. find the following: node := the selected node parent := the selected node's parent, its containing node nextSibling := the node after the selected node

Parameters:

form -

result -

request -

response -

Returns:

togglePropositionSimpleCompound

@MethodAccessible
@RequestMapping(params="methodToCall=togglePropositionSimpleCompound")
public ModelAndView togglePropositionSimpleCompound(@ModelAttribute(value="KualiForm")
                                                                                 UifFormBase form,
                                                                                 BindingResult result,
                                                                                 HttpServletRequest request,
                                                                                 HttpServletResponse response)

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.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

pasteProposition

@MethodAccessible
@RequestMapping(params="methodToCall=pasteProposition")
public ModelAndView pasteProposition(@ModelAttribute(value="KualiForm")
                                                                  UifFormBase form,
                                                                  BindingResult result,
                                                                  HttpServletRequest request,
                                                                  HttpServletResponse response)

Paste proposition in selected position in tree structure.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

deleteProposition

@MethodAccessible
@RequestMapping(params="methodToCall=deleteProposition")
public ModelAndView deleteProposition(@ModelAttribute(value="KualiForm")
                                                                   UifFormBase form,
                                                                   BindingResult result,
                                                                   HttpServletRequest request,
                                                                   HttpServletResponse response)

Removes proposition.

Parameters:

form -

result -

request -

response -

Returns:

updateCompoundOperator

@MethodAccessible
@RequestMapping(params="methodToCall=updateCompoundOperator")
public ModelAndView updateCompoundOperator(@ModelAttribute(value="KualiForm")
                                                                        UifFormBase form,
                                                                        BindingResult result,
                                                                        HttpServletRequest request,
                                                                        HttpServletResponse response)

Updates compound operator in tree structure.

Parameters:

form -

result -

request -

response -

Returns:

updateProposition

@MethodAccessible
@RequestMapping(params="methodToCall=updateProposition")
public ModelAndView updateProposition(@ModelAttribute(value="KualiForm")
                                                                   UifFormBase form,
                                                                   BindingResult result,
                                                                   HttpServletRequest request,
                                                                   HttpServletResponse response)

Updates rule with new or changed propositions.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

compareRulePropositions

protected void compareRulePropositions(MaintenanceDocumentForm form,
                           RuleEditor ruleEditor)

updateRule

@RequestMapping(params="methodToCall=updateRule")
public ModelAndView updateRule(@ModelAttribute(value="KualiForm")
                                           UifFormBase form,
                                           BindingResult result,
                                           HttpServletRequest request,
                                           HttpServletResponse response)

Updates rule and redirects to agenda maintenance page.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

updatePreview

@RequestMapping(params="methodToCall=updatePreview")
public ModelAndView updatePreview(@ModelAttribute(value="KualiForm")
                                              UifFormBase form,
                                              BindingResult result,
                                              HttpServletRequest request,
                                              HttpServletResponse response)

Updates view with changed logic expressions. Also does validation and displays necessary messages on view.

Parameters:

form -

result -

request -

response -

Returns:

Throws:

Exception

cancelEditProposition

@MethodAccessible
@RequestMapping(params="methodToCall=cancelEditProposition")
public ModelAndView cancelEditProposition(@ModelAttribute(value="KualiForm")
                                                                       UifFormBase form,
                                                                       BindingResult result,
                                                                       HttpServletRequest request,
                                                                       HttpServletResponse response)

Reverts rule to previous state and refreshes view.

Parameters:

form -

result -

request -

response -

Returns:

cancelEditRule

@RequestMapping(params="methodToCall=cancelEditRule")
public ModelAndView cancelEditRule(@ModelAttribute(value="KualiForm")
                                               UifFormBase form,
                                               BindingResult result,
                                               HttpServletRequest request,
                                               HttpServletResponse response)

Reverts rule to previous state and navigates to agenda maintenance page.

Parameters:

form -

result -

request -

response -

Returns:

updatePropositionType

@MethodAccessible
@RequestMapping(params="methodToCall=updatePropositionType")
public ModelAndView updatePropositionType(@ModelAttribute(value="KualiForm")
                                                                       UifFormBase form,
                                                                       BindingResult result,
                                                                       HttpServletRequest request,
                                                                       HttpServletResponse response)

Updates proposition type and reloads view.

Parameters:

form -

result -

request -

response -

Returns:

compareRules

@RequestMapping(params="methodToCall=compareRules")
public ModelAndView compareRules(@ModelAttribute(value="KualiForm")
                                             UifFormBase form,
                                             BindingResult result,
                                             HttpServletRequest request,
                                             HttpServletResponse response)

Test method for a controller that invokes a dialog lightbox.

Parameters:

form - - test form

result - - Spring form binding result

request - - http request

response - - http response

Returns:

doCompareRules

protected void doCompareRules(UifFormBase form)

getViewHelper

protected RuleViewHelperService getViewHelper(UifFormBase form)

Returns form's view helper serivce.

Parameters:

form -

Returns:

getSelectedKey

@RequestMapping(params="methodToCall=getSelectedKey")
public ModelAndView getSelectedKey(@ModelAttribute(value="KualiForm")
                                               UifFormBase form,
                                               BindingResult result,
                                               HttpServletRequest request,
                                               HttpServletResponse response)

Retrieves selected proposition key and initializes edit on propostion.

Parameters:

form -

result -

request -

response -

Returns:

refreshLogicArea

@MethodAccessible
@RequestMapping(params="methodToCall=refreshLogicArea")
public ModelAndView refreshLogicArea(@ModelAttribute(value="KualiForm")
                                                                  UifFormBase form,
                                                                  BindingResult result,
                                                                  HttpServletRequest request,
                                                                  HttpServletResponse response)

Refreshes logic area input field when changing tabs.

Parameters:

form -

result -

request -

response -

Returns:

retrieveSelectedRuleEditor

protected RuleEditor retrieveSelectedRuleEditor(MaintenanceDocumentForm document)

getMaintenanceDocumentForm

protected MaintenanceDocumentForm getMaintenanceDocumentForm(UifFormBase form)