org.kuali.rice.krad.document

Class DocumentViewPresentationControllerBase

java.lang.Object

org.kuali.rice.krad.uif.view.ViewPresentationControllerBase

org.kuali.rice.krad.document.DocumentViewPresentationControllerBase

All Implemented Interfaces:

Serializable, DocumentPresentationController, ViewPresentationController

Direct Known Subclasses:

MaintenanceViewPresentationControllerBase, TransactionalDocumentViewPresentationControllerBase

public class DocumentViewPresentationControllerBase
extends ViewPresentationControllerBase
implements DocumentPresentationController

Implementation of ViewPresentationController for DocumentView instances

Adds flags for various document actions like save, route, cancel

By default delegates to the DocumentPresentationController configured for the document in the data dictionary

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentViewPresentationControllerBase()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAcknowledge(Document document)
boolean	canAddAdhocRequests(Document document)
boolean	canAnnotate(Document document)
boolean	canApprove(Document document)
boolean	canBlanketApprove(Document document)
boolean	canCancel(Document document)
boolean	canClose(Document document)
boolean	canComplete(Document document)
boolean	canCopy(Document document)
boolean	canDisapprove(Document document)
boolean	canEdit(Document document)
boolean	canEditDocumentOverview(Document document)
boolean	canEditView(View view, ViewModel model) Verify the document can be edited in addition to the view
boolean	canFyi(Document document)
boolean	canInitiate(String documentTypeName)
boolean	canPerformRouteReport(Document document)
boolean	canRecall(Document document)
boolean	canReload(Document document)
boolean	canRoute(Document document)
boolean	canSave(Document document)
boolean	canSendAdhocRequests(Document document)
boolean	canSendNoteFyi(Document document)
boolean	canSuperUserApprove(Document document) Determines if the document state should allow a super user approving the document.
boolean	canSuperUserDisapprove(Document document) Determines if the document state should allow a super user disapproving the document.
boolean	canSuperUserTakeAction(Document document) Determines if the document state should allow a super user taking an action.
Set<String>	getActionFlags(View view, UifFormBase model)
DocumentPresentationController	getDocumentPresentationController()
protected DocumentRequestAuthorizationCache	getDocumentRequestAuthorizationCache(Document document)
void	setDocumentPresentationController(DocumentPresentationController documentPresentationController)
void	setDocumentPresentationControllerClass(Class<? extends DocumentPresentationController> documentPresentationControllerClass)
void	setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)
void	setRequestAuthorizationCache(RequestAuthorizationCache requestAuthorizationCache)

Methods inherited from class org.kuali.rice.krad.uif.view.ViewPresentationControllerBase

canEditField, canEditGroup, canEditLine, canEditLineField, canEditWidget, canPerformAction, canPerformLineAction, canViewField, canViewGroup, canViewLine, canViewLineField, canViewWidget, fieldIsRequired, getEditModes, getRequestAuthorizationCache

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentViewPresentationControllerBase

public DocumentViewPresentationControllerBase()

Method Detail

getActionFlags

public Set<String> getActionFlags(View view,
                         UifFormBase model)

Specified by:

getActionFlags in interface ViewPresentationController

Overrides:

getActionFlags in class ViewPresentationControllerBase

See Also:

ViewPresentationController.getActionFlags(org.kuali.rice.krad.uif.view.View, org.kuali.rice.krad.web.form.UifFormBase)

canInitiate

public boolean canInitiate(String documentTypeName)

Specified by:

canInitiate in interface DocumentPresentationController

canEdit

public boolean canEdit(Document document)

Specified by:

canEdit in interface DocumentPresentationController

canEditView

public boolean canEditView(View view,
                  ViewModel model)

Verify the document can be edited in addition to the view

Specified by:

canEditView in interface ViewPresentationController

Overrides:

canEditView in class ViewPresentationControllerBase

Parameters:

view - - view instance to check whether editing is allowed

model - - object containing the view data

Returns:

boolean true if editing on the view is allowed, false otherwise

See Also:

ViewPresentationController.canEditView(org.kuali.rice.krad.uif.view.View, org.kuali.rice.krad.uif.view.ViewModel)

canAnnotate

public boolean canAnnotate(Document document)

Specified by:

canAnnotate in interface DocumentPresentationController

canReload

public boolean canReload(Document document)

Specified by:

canReload in interface DocumentPresentationController

canClose

public boolean canClose(Document document)

Specified by:

canClose in interface DocumentPresentationController

canSave

public boolean canSave(Document document)

Specified by:

canSave in interface DocumentPresentationController

canRoute

public boolean canRoute(Document document)

Specified by:

canRoute in interface DocumentPresentationController

canCancel

public boolean canCancel(Document document)

Specified by:

canCancel in interface DocumentPresentationController

canRecall

public boolean canRecall(Document document)

Specified by:

canRecall in interface DocumentPresentationController

canCopy

public boolean canCopy(Document document)

Specified by:

canCopy in interface DocumentPresentationController

canPerformRouteReport

public boolean canPerformRouteReport(Document document)

Specified by:

canPerformRouteReport in interface DocumentPresentationController

canAddAdhocRequests

public boolean canAddAdhocRequests(Document document)

Specified by:

canAddAdhocRequests in interface DocumentPresentationController

canBlanketApprove

public boolean canBlanketApprove(Document document)

Specified by:

canBlanketApprove in interface DocumentPresentationController

canApprove

public boolean canApprove(Document document)

Specified by:

canApprove in interface DocumentPresentationController

canDisapprove

public boolean canDisapprove(Document document)

Specified by:

canDisapprove in interface DocumentPresentationController

canSendAdhocRequests

public boolean canSendAdhocRequests(Document document)

Specified by:

canSendAdhocRequests in interface DocumentPresentationController

canSendNoteFyi

public boolean canSendNoteFyi(Document document)

Specified by:

canSendNoteFyi in interface DocumentPresentationController

canEditDocumentOverview

public boolean canEditDocumentOverview(Document document)

Specified by:

canEditDocumentOverview in interface DocumentPresentationController

canFyi

public boolean canFyi(Document document)

Specified by:

canFyi in interface DocumentPresentationController

canAcknowledge

public boolean canAcknowledge(Document document)

Specified by:

canAcknowledge in interface DocumentPresentationController

canComplete

public boolean canComplete(Document document)

Specified by:

canComplete in interface DocumentPresentationController

canSuperUserTakeAction

public boolean canSuperUserTakeAction(Document document)

Determines if the document state should allow a super user taking an action.

Specified by:

canSuperUserTakeAction in interface DocumentPresentationController

Parameters:

document - document to check

Returns:

true the document state should allow a super user taking an action, otherwise false

canSuperUserApprove

public boolean canSuperUserApprove(Document document)

Determines if the document state should allow a super user approving the document.

Specified by:

canSuperUserApprove in interface DocumentPresentationController

Parameters:

document - document to check

Returns:

true if the document state should allow a super user approving the document, otherwise false

canSuperUserDisapprove

public boolean canSuperUserDisapprove(Document document)

Determines if the document state should allow a super user disapproving the document.

Specified by:

canSuperUserDisapprove in interface DocumentPresentationController

Parameters:

document - document to check

Returns:

true if the document state should allow a super user disapproving the document, otherwise false

getDocumentPresentationController

public DocumentPresentationController getDocumentPresentationController()

setDocumentPresentationController

public void setDocumentPresentationController(DocumentPresentationController documentPresentationController)

setDocumentPresentationControllerClass

public void setDocumentPresentationControllerClass(Class<? extends DocumentPresentationController> documentPresentationControllerClass)

getDocumentRequestAuthorizationCache

protected DocumentRequestAuthorizationCache getDocumentRequestAuthorizationCache(Document document)

setDocumentRequestAuthorizationCache

public void setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)

Specified by:

setDocumentRequestAuthorizationCache in interface DocumentPresentationController

setRequestAuthorizationCache

public void setRequestAuthorizationCache(RequestAuthorizationCache requestAuthorizationCache)

Specified by:

setRequestAuthorizationCache in interface ViewPresentationController

Overrides:

setRequestAuthorizationCache in class ViewPresentationControllerBase