Package org.kuali.rice.krad.document

Class DocumentPresentationControllerBase

java.lang.Object

org.kuali.rice.krad.document.DocumentPresentationControllerBase

All Implemented Interfaces:

Serializable, DocumentPresentationController

Direct Known Subclasses:

MaintenanceDocumentPresentationControllerBase, TransactionalDocumentPresentationControllerBase

public class DocumentPresentationControllerBase
extends Object
implements DocumentPresentationController, Serializable

Author:

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentPresentationControllerBase()

Method Summary

Modifier and Type	Method	Description
boolean	canAcknowledge(Document document)
boolean	canAddAdhocRequests(Document document)
boolean	canAnnotate(Document document)
boolean	canApprove(Document document)
protected boolean	canApproveOrDisapprove(Document document)	Returns whether a super user approve or disapprove action can be taken on the 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.
protected boolean	canTakeAction(Document document)	Returns whether a super user action can be taken on the document.
protected DocumentRequestAuthorizationCache	getDocumentRequestAuthorizationCache(Document document)
protected ParameterService	getParameterService()
protected boolean	hasActionRequests(Document document)	Returns whether the document has any APPROVE or COMPLETE action requests.
protected boolean	isStateInitiatedFinalCancelled(org.kuali.rice.kew.api.document.DocumentStatus status)	Returns whether the document is in a INITIATED, FINAL, or CANCELLED state.
protected boolean	isStateProcessedOrDisapproved(org.kuali.rice.kew.api.document.DocumentStatus status)	Returns whether the document is in a PROCESSED or DISAPPROVED state.
protected boolean	isStateSaved(org.kuali.rice.kew.api.document.DocumentStatus status)	Returns whether the document is in a SAVED state.
void	setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentPresentationControllerBase

public DocumentPresentationControllerBase()

Method Details

canInitiate

public boolean canInitiate(String documentTypeName)

Specified by:

canInitiate in interface DocumentPresentationController

canEdit

public boolean canEdit(Document document)

Specified by:

canEdit in interface DocumentPresentationController

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

hasActionRequests

protected boolean hasActionRequests(Document document)

Returns whether the document has any APPROVE or COMPLETE action requests.

Parameters:

document - the document to check

Returns:

true if the document has any APPROVE or COMPLETE action requests, false otherwise

canTakeAction

protected boolean canTakeAction(Document document)

Returns whether a super user action can be taken on the document.

Typically, actions can only be taken on a document not in INITIATED, FINAL, or CANCELLED status.

Parameters:

document - the document to check

Returns:

true if a super user action can be taken on the document, false otherwise

canApproveOrDisapprove

protected boolean canApproveOrDisapprove(Document document)

Returns whether a super user approve or disapprove action can be taken on the document.

Typically, actions can only be taken on a document not in INITIATED, SAVED, PROCESSED, DISAPPROVED, FINAL, or CANCELLED status.

Parameters:

document - the document to check

Returns:

true if a super user approve or disapprove action can be taken on the document, false otherwise

isStateInitiatedFinalCancelled

protected boolean isStateInitiatedFinalCancelled(org.kuali.rice.kew.api.document.DocumentStatus status)

Returns whether the document is in a INITIATED, FINAL, or CANCELLED state.

Parameters:

status - the document status

Returns:

true if the document is in a INITIATED, FINAL, or CANCELLED state, false otherwise

isStateSaved

protected boolean isStateSaved(org.kuali.rice.kew.api.document.DocumentStatus status)

Returns whether the document is in a SAVED state.

Parameters:

status - the document status

Returns:

true if the document is in a SAVED state, false otherwise

isStateProcessedOrDisapproved

protected boolean isStateProcessedOrDisapproved(org.kuali.rice.kew.api.document.DocumentStatus status)

Returns whether the document is in a PROCESSED or DISAPPROVED state.

Parameters:

status - the document status

Returns:

true if the document is in a PROCESSED or DISAPPROVED state, false otherwise

getParameterService

protected ParameterService getParameterService()

getDocumentRequestAuthorizationCache

protected DocumentRequestAuthorizationCache getDocumentRequestAuthorizationCache(Document document)

setDocumentRequestAuthorizationCache

public void setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)

Specified by:

setDocumentRequestAuthorizationCache in interface DocumentPresentationController