org.kuali.ole.license.controller
Class OleLicenseRequestController

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.ole.license.controller.OleLicenseRequestController

@Controller
@RequestMapping(value="/oleLicenseRequest")
public class OleLicenseRequestController
extends org.kuali.rice.krad.web.controller.MaintenanceDocumentController

OleLicenseRequestController is the controller class for License Request Maintenance Document.

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

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

REDIRECT_PREFIX

Constructor Summary

OleLicenseRequestController()

Method Summary

org.springframework.web.servlet.ModelAndView	addEventLogLine(org.kuali.rice.krad.web.form.UifFormBase uifForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method populates date of the eventlog object thereby adding to the existing list.
org.springframework.web.servlet.ModelAndView	approve(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the approve workflow action on the document
org.springframework.web.servlet.ModelAndView	deleteAgreementDocument(org.kuali.rice.krad.web.form.UifFormBase uifForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will deletes the agreement document from the existing list
org.springframework.web.servlet.ModelAndView	disapprove(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the disapprove workflow action on the document
org.springframework.web.servlet.ModelAndView	downloadAgreement(org.kuali.rice.krad.web.form.UifFormBase uifForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will download the agreement document from the docstore if it is already ingested otherwise will download from the temprovary location.
protected Map<String,String>	getAgendaContext(String agendaName) This method returns agendaContext using agendaName.
protected Map<String,String>	getSelectionContext(String contextName) This method returns selectionContext using contextName.
String	getURL()
org.springframework.web.servlet.ModelAndView	insertAgreementDocument(org.kuali.rice.krad.web.form.UifFormBase uifForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will add the agreement document to the existing list and also stores the attachment to the specified path.
org.springframework.web.servlet.ModelAndView	route(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method sets appropriate LicenseRequestStatusCode and gets the UUIDs for the agreement document from the docstore (ingesting into the docstore) and proceeds with normal routing.
org.springframework.web.servlet.ModelAndView	save(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Saves the document instance contained on the form
org.springframework.web.servlet.ModelAndView	viewAgreement(org.kuali.rice.krad.web.form.UifFormBase uifForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is used to view the agreement linked to the license request
org.springframework.web.servlet.ModelAndView	viewRelatedDocument(org.kuali.rice.krad.web.form.UifFormBase uifForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will populate the url which will be used to view the related Requisition Document

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

createInitialForm, docHandler, getMaintenanceDocumentService, maintenanceCopy, maintenanceEdit, maintenanceNewWithExisting, setupMaintenance, start

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

acknowledge, blanketApprove, buildAuthorizationException, cancel, cancelAttachment, checkAndWarnAboutSensitiveData, combineAdHocRecipients, createDocument, deleteNote, downloadAttachment, fyi, getAttachmentService, getBusinessObjectService, getConfigurationService, getDataDictionaryService, getDocumentDictionaryService, getDocumentService, getNoteService, insertNote, loadDocument, performWorkflowAction, reload, setBusinessObjectService, setDataDictionaryService, setDocumentDictionaryService, setDocumentService, supervisorFunctions

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

addLine, checkViewAuthorization, close, deleteLine, getUIFModelAndView, getUIFModelAndView, getViewService, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, refresh, returnToHistory, returnToHub, returnToPrevious, toggleInactiveRecordDisplay, updateComponent

Methods inherited from class java.lang.Object

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

Constructor Detail

OleLicenseRequestController

public OleLicenseRequestController()

Method Detail

addEventLogLine

@RequestMapping(params="methodToCall=addEventLogLine")
public org.springframework.web.servlet.ModelAndView addEventLogLine(@ModelAttribute(value="KualiForm")
                                                                                   org.kuali.rice.krad.web.form.UifFormBase uifForm,
                                                                                   org.springframework.validation.BindingResult result,
                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                   javax.servlet.http.HttpServletResponse response)

This method populates date of the eventlog object thereby adding to the existing list.

Parameters:

uifForm -

result -

request -

response -

Returns:

ModelAndView

route

@RequestMapping(params="methodToCall=route")
public org.springframework.web.servlet.ModelAndView route(@ModelAttribute(value="KualiForm")
                                                                         org.kuali.rice.krad.web.form.DocumentFormBase form,
                                                                         org.springframework.validation.BindingResult result,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         javax.servlet.http.HttpServletResponse response)

This method sets appropriate LicenseRequestStatusCode and gets the UUIDs for the agreement document from the docstore (ingesting into the docstore) and proceeds with normal routing.

Overrides:

route in class org.kuali.rice.krad.web.controller.MaintenanceDocumentController

Parameters:

form -

result -

result -

request -

response -

Returns:

ModelAndView

approve

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

Performs the approve workflow action on the document

Overrides:

approve in class org.kuali.rice.krad.web.controller.DocumentControllerBase

Parameters:

form - - document form base containing the document instance that will be approved

Returns:

ModelAndView

Throws:

Exception

disapprove

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

Performs the disapprove workflow action on the document

Overrides:

disapprove in class org.kuali.rice.krad.web.controller.DocumentControllerBase

Parameters:

form - - document form base containing the document instance that will be disapproved

Returns:

ModelAndView

Throws:

Exception

getURL

public String getURL()

getSelectionContext

protected Map<String,String> getSelectionContext(String contextName)

This method returns selectionContext using contextName.

Parameters:

contextName -

Returns:

Map

getAgendaContext

protected Map<String,String> getAgendaContext(String agendaName)

This method returns agendaContext using agendaName.

Parameters:

agendaName -

Returns:

Map

insertAgreementDocument

@RequestMapping(params="methodToCall=insertAgreementDocument")
public org.springframework.web.servlet.ModelAndView insertAgreementDocument(@ModelAttribute(value="KualiForm")
                                                                                           org.kuali.rice.krad.web.form.UifFormBase uifForm,
                                                                                           org.springframework.validation.BindingResult result,
                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                           javax.servlet.http.HttpServletResponse response)

This method will add the agreement document to the existing list and also stores the attachment to the specified path.

Parameters:

uifForm - - MaintenanceForm

Returns:

ModelAndView

deleteAgreementDocument

@RequestMapping(params="methodToCall=deleteAgreementDocument")
public org.springframework.web.servlet.ModelAndView deleteAgreementDocument(@ModelAttribute(value="KualiForm")
                                                                                           org.kuali.rice.krad.web.form.UifFormBase uifForm,
                                                                                           org.springframework.validation.BindingResult result,
                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                           javax.servlet.http.HttpServletResponse response)

This method will deletes the agreement document from the existing list

Parameters:

uifForm - - MaintenanceForm

Returns:

ModelAndView

downloadAgreement

@RequestMapping(params="methodToCall=downloadAgreement")
public org.springframework.web.servlet.ModelAndView downloadAgreement(@ModelAttribute(value="KualiForm")
                                                                                     org.kuali.rice.krad.web.form.UifFormBase uifForm,
                                                                                     org.springframework.validation.BindingResult result,
                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                     javax.servlet.http.HttpServletResponse response)

This method will download the agreement document from the docstore if it is already ingested otherwise will download from the temprovary location.

Parameters:

uifForm - - MaintenanceForm

Returns:

ModelAndView

viewRelatedDocument

@RequestMapping(params="methodToCall=viewRelatedDocument")
public org.springframework.web.servlet.ModelAndView viewRelatedDocument(@ModelAttribute(value="KualiForm")
                                                                                       org.kuali.rice.krad.web.form.UifFormBase uifForm,
                                                                                       org.springframework.validation.BindingResult result,
                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                       javax.servlet.http.HttpServletResponse response)

This method will populate the url which will be used to view the related Requisition Document

Parameters:

uifForm - - MaintenanceForm

Returns:

ModelAndView

save

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

Saves the document instance contained on the form

Overrides:

save in class org.kuali.rice.krad.web.controller.DocumentControllerBase

Parameters:

form - - document form base containing the document instance that will be saved

Returns:

ModelAndView

Throws:

Exception

viewAgreement

@RequestMapping(params="methodToCall=viewAgreement")
public org.springframework.web.servlet.ModelAndView viewAgreement(@ModelAttribute(value="KualiForm")
                                                                                 org.kuali.rice.krad.web.form.UifFormBase uifForm,
                                                                                 org.springframework.validation.BindingResult result,
                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                 javax.servlet.http.HttpServletResponse response)

This method is used to view the agreement linked to the license request

Parameters:

uifForm -

result -

request -

response -

Returns: