Package org.kuali.rice.krad.document

Interface DocumentAuthorizer

All Superinterfaces:
DataObjectAuthorizer
All Known Subinterfaces:
MaintenanceDocumentAuthorizer, TransactionalDocumentAuthorizer
All Known Implementing Classes:
DocumentAuthorizerBase, DocumentViewAuthorizerBase, MaintenanceDocumentAuthorizerBase, MaintenanceViewAuthorizerBase, TransactionalDocumentAuthorizerBase, TransactionalDocumentViewAuthorizerBase
public interface DocumentAuthorizer extends DataObjectAuthorizer
Authorizer class for Document instances

Authorizer provides user based authorization

The document authorizer is associated with a document type through its data dictionary DocumentEntry. This is then used by the framework to authorize certain actions and in addition used for view presentation logic

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

  • Method Details

    • canInitiate

      boolean canInitiate(String documentTypeName, org.kuali.rice.kim.api.identity.Person user)
      Checks if a user has the permissions to initiate a document
      Parameters:
      documentTypeName - document type name
      user - current user
      Returns:
      boolean, true if the user has the permissions to initiate a document else false

    • canOpen

      boolean canOpen(Document document, org.kuali.rice.kim.api.identity.Person user)
      Checks if a user has the permissions to open a document
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has the permissions to open a document else false

    • canEdit

      boolean canEdit(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the document can be edited; if false is returned, then all fields are in a read only state
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has the permissions to edit a document else false

    • canAnnotate

      boolean canAnnotate(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canReload

      boolean canReload(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canClose

      boolean canClose(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canSave

      boolean canSave(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canRoute

      boolean canRoute(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the user has permission to route the document
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has permissions to route a document else false

    • canCancel

      boolean canCancel(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the user has permission to cancel the document
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has permissions to cancel a document else false

    • canCopy

      boolean canCopy(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the user has permission to copy the document
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has permissions to cancel a document else false

    • canPerformRouteReport

      boolean canPerformRouteReport(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canBlanketApprove

      boolean canBlanketApprove(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canApprove

      boolean canApprove(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canDisapprove

      boolean canDisapprove(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canSendNoteFyi

      boolean canSendNoteFyi(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canEditDocumentOverview

      boolean canEditDocumentOverview(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canFyi

      boolean canFyi(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canAcknowledge

      boolean canAcknowledge(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canReceiveAdHoc

      boolean canReceiveAdHoc(Document document, org.kuali.rice.kim.api.identity.Person user, String actionRequestCode)

    • canAddNoteAttachment

      boolean canAddNoteAttachment(Document document, String attachmentTypeCode, org.kuali.rice.kim.api.identity.Person user)

    • canDeleteNoteAttachment

      boolean canDeleteNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, org.kuali.rice.kim.api.identity.Person user)

    • canViewNoteAttachment

      boolean canViewNoteAttachment(Document document, String attachmentTypeCode, org.kuali.rice.kim.api.identity.Person user)

    • canViewNoteAttachment

      @Deprecated boolean canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, org.kuali.rice.kim.api.identity.Person user)
      Deprecated.

    • canSendAdHocRequests

      boolean canSendAdHocRequests(Document document, String actionRequestCd, org.kuali.rice.kim.api.identity.Person user)

    • canSendAnyTypeAdHocRequests

      boolean canSendAnyTypeAdHocRequests(Document document, org.kuali.rice.kim.api.identity.Person user)

    • canTakeRequestedAction

      boolean canTakeRequestedAction(Document document, String actionRequestCode, org.kuali.rice.kim.api.identity.Person user)

    • canRecall

      boolean canRecall(Document document, org.kuali.rice.kim.api.identity.Person user)
      Since:
      2.1

    • canSuperUserTakeAction

      boolean canSuperUserTakeAction(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the user has permission to take a super user action.
      Parameters:
      document - document to check
      user - current user
      Returns:
      true if the user has permissions to take a super user action, otherwise false
      Since:
      2.5

    • canSuperUserApprove

      boolean canSuperUserApprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the user has permission to approve a document as a super user.
      Parameters:
      document - document to check
      user - current user
      Returns:
      true if the user has permissions to approve a document as a super user, otherwise false
      Since:
      2.5

    • canSuperUserDisapprove

      boolean canSuperUserDisapprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Determines if the user has permission to disapprove a document as a super user.
      Parameters:
      document - document to check
      user - current user
      Returns:
      true if the user has permissions to disapprove a document as a super user, otherwise false
      Since:
      2.5

    • setDocumentRequestAuthorizationCache

      void setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)