org.kuali.rice.krad.document

Interface DocumentPresentationController

All Known Subinterfaces:

MaintenanceDocumentPresentationController, TransactionalDocumentPresentationController

All Known Implementing Classes:

DocumentPresentationControllerBase, DocumentViewPresentationControllerBase, MaintenanceDocumentPresentationControllerBase, MaintenanceViewPresentationControllerBase, TransactionalDocumentPresentationControllerBase, TransactionalDocumentViewPresentationControllerBase

public interface DocumentPresentationController

Determines what actions are applicable to the given document, irrespective of user or other state. These initial actions are used as inputs for further filtering depending on context.

Author:

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

See Also:

DocumentAuthorizer

Method Summary

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	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.
void	setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)

Method Detail

canInitiate

boolean canInitiate(String documentTypeName)

canEdit

boolean canEdit(Document document)

canAnnotate

boolean canAnnotate(Document document)

canReload

boolean canReload(Document document)

canClose

boolean canClose(Document document)

canSave

boolean canSave(Document document)

canRoute

boolean canRoute(Document document)

canCancel

boolean canCancel(Document document)

canCopy

boolean canCopy(Document document)

canPerformRouteReport

boolean canPerformRouteReport(Document document)

canAddAdhocRequests

boolean canAddAdhocRequests(Document document)

canBlanketApprove

boolean canBlanketApprove(Document document)

canApprove

boolean canApprove(Document document)

canDisapprove

boolean canDisapprove(Document document)

canSendAdhocRequests

boolean canSendAdhocRequests(Document document)

canSendNoteFyi

boolean canSendNoteFyi(Document document)

canEditDocumentOverview

boolean canEditDocumentOverview(Document document)

canFyi

boolean canFyi(Document document)

canAcknowledge

boolean canAcknowledge(Document document)

canComplete

boolean canComplete(Document document)

canRecall

boolean canRecall(Document document)

Since:

2.1

canSuperUserTakeAction

boolean canSuperUserTakeAction(Document document)

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

Parameters:

document - document to check

Returns:

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

Since:

2.5

canSuperUserApprove

boolean canSuperUserApprove(Document document)

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

Parameters:

document - document to check

Returns:

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

Since:

2.5

canSuperUserDisapprove

boolean canSuperUserDisapprove(Document document)

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

Parameters:

document - document to check

Returns:

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

Since:

2.5

setDocumentRequestAuthorizationCache

void setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)