Package org.kuali.rice.krad.document

Class TransactionalDocumentControllerServiceImpl

java.lang.Object

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

org.kuali.rice.krad.document.DocumentControllerServiceImpl

org.kuali.rice.krad.document.TransactionalDocumentControllerServiceImpl

All Implemented Interfaces:

DocumentControllerService, TransactionalDocumentControllerService, ControllerService

public class TransactionalDocumentControllerServiceImpl
extends DocumentControllerServiceImpl
implements TransactionalDocumentControllerService

Default implementation of the transactional document controller service.

Author:

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

Field Summary

Fields inherited from class org.kuali.rice.krad.document.DocumentControllerServiceImpl

DOCUMENT_LOAD_COMMANDS, EXPLANATION_DIALOG, SENSITIVE_DATA_DIALOG

Constructor Summary

Constructors

Constructor	Description
TransactionalDocumentControllerServiceImpl()

Method Summary

Modifier and Type	Method	Description
org.springframework.web.servlet.ModelAndView	acknowledge(DocumentFormBase form)	Sends a acknowledge workflow action for the document contained on the form.
org.springframework.web.servlet.ModelAndView	approve(DocumentFormBase form)	Sends a approve workflow action for the document contained on the form.
org.springframework.web.servlet.ModelAndView	cancel(UifFormBase form)	Navigates back to a previous point (depending on how the view was requested).
org.springframework.web.servlet.ModelAndView	close(DocumentFormBase form)	Closes the document and returns to the hub.
org.springframework.web.servlet.ModelAndView	copy(TransactionalDocumentFormBase form)	Invoked to copy the current transactional document into a new document.
org.springframework.web.servlet.ModelAndView	disapprove(DocumentFormBase form)	Sends a disapprove workflow action for the document contained on the form.
protected PessimisticLockService	getPessimisticLockService()
protected void	releasePessimisticLocks(DocumentFormBase form)	Releases the pessimistic locks for the current user.
org.springframework.web.servlet.ModelAndView	route(DocumentFormBase form)	Sends a route workflow action for the document contained on the form.
protected void	setPessimisticLockService(PessimisticLockService pessimisticLockService)

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

blanketApprove, buildAuthorizationException, cancelAttachment, checkSensitiveDataAndWarningDialog, combineAdHocRecipients, complete, createDocument, deleteNote, docHandler, downloadAttachment, fyi, generateDisapprovalNote, getAddLineNoteInstance, getAttachmentService, getCollectionControllerService, getConfigurationService, getDataDictionaryService, getDocumentDictionaryService, getDocumentService, getLegacyDataAdapter, getModelAndViewService, getNavigationControllerService, getNewNoteAttachment, getNoteService, getParameterService, getWorkflowDocumentActionsService, insertNote, loadDocument, performSuperUserWorkflowAction, performSuperUserWorkflowAction, performWorkflowAction, performWorkflowAction, recall, reload, save, save, saveNewNote, sendAdHocRequests, setAttachmentService, setCollectionControllerService, setConfigurationService, setDataDictionaryService, setDocumentDictionaryService, setDocumentService, setLegacyDataAdapter, setModelAndViewService, setNavigationControllerService, setNewNoteProperties, setNoteService, setParameterService, superUserApprove, superUserDisapprove, superUserTakeActions, supervisorFunctions

Methods inherited from class org.kuali.rice.krad.web.service.impl.ControllerServiceImpl

checkViewAuthorization, sessionTimeout, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.web.service.ControllerService

checkViewAuthorization, sessionTimeout, start

Methods inherited from interface org.kuali.rice.krad.document.DocumentControllerService

blanketApprove, cancelAttachment, complete, deleteNote, docHandler, downloadAttachment, fyi, insertNote, performSuperUserWorkflowAction, performSuperUserWorkflowAction, performWorkflowAction, performWorkflowAction, recall, reload, save, save, sendAdHocRequests, superUserApprove, superUserDisapprove, superUserTakeActions, supervisorFunctions

Constructor Details

TransactionalDocumentControllerServiceImpl

public TransactionalDocumentControllerServiceImpl()

Method Details

copy

public org.springframework.web.servlet.ModelAndView copy(TransactionalDocumentFormBase form)

Invoked to copy the current transactional document into a new document.

Specified by:

copy in interface TransactionalDocumentControllerService

Parameters:

form - form instance containing the transactional document data

Returns:

ModelAndView instance for rendering the document view

cancel

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

Navigates back to a previous point (depending on how the view was requested). Invoked when the cancel action is invoked on a view. org.kuali.rice.krad.web.service.impl.NavigationControllerServiceImpl#back(org.kuali.rice.krad.web.form.UifFormBase, boolean)

Releases the pessimistic locks before continuing.

Specified by:

cancel in interface ControllerService

Overrides:

cancel in class DocumentControllerServiceImpl

Parameters:

form - form instance containing the model data

Returns:

ModelAndView instance for rendering the view

route

public org.springframework.web.servlet.ModelAndView route(DocumentFormBase form)

Sends a route workflow action for the document contained on the form.

Releases the pessimistic locks before continuing.

Specified by:

route in interface DocumentControllerService

Overrides:

route in class DocumentControllerServiceImpl

Parameters:

form - form instance containing the document the route request will be generated for

Returns:

ModelAndView instance for rendering the document view

approve

public org.springframework.web.servlet.ModelAndView approve(DocumentFormBase form)

Sends a approve workflow action for the document contained on the form.

Releases the pessimistic locks before continuing.

Specified by:

approve in interface DocumentControllerService

Overrides:

approve in class DocumentControllerServiceImpl

Parameters:

form - form instance containing the document the approve request will be generated for

Returns:

ModelAndView instance for rendering the document view

disapprove

public org.springframework.web.servlet.ModelAndView disapprove(DocumentFormBase form)

Sends a disapprove workflow action for the document contained on the form.

Releases the pessimistic locks before continuing.

Specified by:

disapprove in interface DocumentControllerService

Overrides:

disapprove in class DocumentControllerServiceImpl

Parameters:

form - form instance containing the document the disapprove request will be generated for

Returns:

ModelAndView instance for rendering the document view

acknowledge

public org.springframework.web.servlet.ModelAndView acknowledge(DocumentFormBase form)

Sends a acknowledge workflow action for the document contained on the form.

Releases the pessimistic locks before continuing.

Specified by:

acknowledge in interface DocumentControllerService

Overrides:

acknowledge in class DocumentControllerServiceImpl

Parameters:

form - form instance containing the document the acknowledge request will be generated for

Returns:

ModelAndView instance for rendering the document view

close

public org.springframework.web.servlet.ModelAndView close(DocumentFormBase form)

Closes the document and returns to the hub.

Prompts for save and releases the pessimistic locks before continuing.

Specified by:

close in interface DocumentControllerService

Overrides:

close in class DocumentControllerServiceImpl

Parameters:

form - form instance containing the document instance

Returns:

ModelAndView instance for rendering the document view

releasePessimisticLocks

protected void releasePessimisticLocks(DocumentFormBase form)

Releases the pessimistic locks for the current user.

Parameters:

form - form instance containing the transactional document data

getPessimisticLockService

protected PessimisticLockService getPessimisticLockService()

setPessimisticLockService

protected void setPessimisticLockService(PessimisticLockService pessimisticLockService)