Package org.kuali.rice.krad.document

Class DocumentAuthorizerBase

java.lang.Object
org.kuali.rice.krad.bo.DataObjectAuthorizerBase
org.kuali.rice.krad.document.DocumentAuthorizerBase
All Implemented Interfaces:
Serializable, DataObjectAuthorizer, DocumentAuthorizer
Direct Known Subclasses:
MaintenanceDocumentAuthorizerBase, TransactionalDocumentAuthorizerBase
public class DocumentAuthorizerBase extends DataObjectAuthorizerBase implements DocumentAuthorizer
Default implementation for DocumentAuthorizer that perform KIM permission checks to authorize the actions
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Details

  • Constructor Details

    • DocumentAuthorizerBase

      public DocumentAuthorizerBase()

  • Method Details

    • canInitiate

      public final boolean canInitiate(String documentTypeName, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Checks if a user has the permissions to initiate a document
      Specified by:
      canInitiate in interface DocumentAuthorizer
      Parameters:
      documentTypeName - document type name
      user - current user
      Returns:
      boolean, true if the user has the permissions to initiate a document else false

    • canOpen

      public boolean canOpen(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Checks if a user has the permissions to open a document
      Specified by:
      canOpen in interface DocumentAuthorizer
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has the permissions to open a document else false

    • canEdit

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

    • canAnnotate

      public boolean canAnnotate(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canAnnotate in interface DocumentAuthorizer

    • canReload

      public boolean canReload(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canReload in interface DocumentAuthorizer

    • canClose

      public boolean canClose(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canClose in interface DocumentAuthorizer

    • canSave

      public boolean canSave(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canSave in interface DocumentAuthorizer

    • canRoute

      public boolean canRoute(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Determines if the user has permission to route the document
      Specified by:
      canRoute in interface DocumentAuthorizer
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has permissions to route a document else false

    • canCancel

      public boolean canCancel(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Determines if the user has permission to cancel the document
      Specified by:
      canCancel in interface DocumentAuthorizer
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has permissions to cancel a document else false

    • canRecall

      public boolean canRecall(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canRecall in interface DocumentAuthorizer

    • canCopy

      public boolean canCopy(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Determines if the user has permission to copy the document
      Specified by:
      canCopy in interface DocumentAuthorizer
      Parameters:
      document - document to check
      user - current user
      Returns:
      boolean, true if the user has permissions to cancel a document else false

    • canPerformRouteReport

      public boolean canPerformRouteReport(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canPerformRouteReport in interface DocumentAuthorizer

    • canBlanketApprove

      public boolean canBlanketApprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canBlanketApprove in interface DocumentAuthorizer

    • canApprove

      public boolean canApprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canApprove in interface DocumentAuthorizer

    • canDisapprove

      public boolean canDisapprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canDisapprove in interface DocumentAuthorizer

    • canSendNoteFyi

      public boolean canSendNoteFyi(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canSendNoteFyi in interface DocumentAuthorizer

    • canFyi

      public boolean canFyi(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canFyi in interface DocumentAuthorizer

    • canAcknowledge

      public boolean canAcknowledge(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canAcknowledge in interface DocumentAuthorizer

    • canReceiveAdHoc

      public boolean canReceiveAdHoc(Document document, org.kuali.rice.kim.api.identity.Person user, String actionRequestCode)
      Specified by:
      canReceiveAdHoc in interface DocumentAuthorizer

    • canAddNoteAttachment

      public boolean canAddNoteAttachment(Document document, String attachmentTypeCode, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canAddNoteAttachment in interface DocumentAuthorizer

    • canDeleteNoteAttachment

      public boolean canDeleteNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canDeleteNoteAttachment in interface DocumentAuthorizer

    • canViewNoteAttachment

      public boolean canViewNoteAttachment(Document document, String attachmentTypeCode, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canViewNoteAttachment in interface DocumentAuthorizer

    • canViewNoteAttachment

      @Deprecated public boolean canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, org.kuali.rice.kim.api.identity.Person user)
      Deprecated.
      Specified by:
      canViewNoteAttachment in interface DocumentAuthorizer

    • canSendAdHocRequests

      public boolean canSendAdHocRequests(Document document, String actionRequestCd, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canSendAdHocRequests in interface DocumentAuthorizer

    • canEditDocumentOverview

      public boolean canEditDocumentOverview(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canEditDocumentOverview in interface DocumentAuthorizer

    • canSendAnyTypeAdHocRequests

      public boolean canSendAnyTypeAdHocRequests(Document document, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canSendAnyTypeAdHocRequests in interface DocumentAuthorizer

    • canTakeRequestedAction

      public boolean canTakeRequestedAction(Document document, String actionRequestCode, org.kuali.rice.kim.api.identity.Person user)
      Specified by:
      canTakeRequestedAction in interface DocumentAuthorizer

    • canSuperUserTakeAction

      public boolean canSuperUserTakeAction(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Determines if the user has permission to take a super user action.
      Specified by:
      canSuperUserTakeAction in interface DocumentAuthorizer
      Parameters:
      document - document to check
      user - current user
      Returns:
      true if the user has permissions to take a super user action, otherwise false

    • canSuperUserApprove

      public boolean canSuperUserApprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Determines if the user has permission to approve a document as a super user.
      Specified by:
      canSuperUserApprove in interface DocumentAuthorizer
      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

    • canSuperUserDisapprove

      public boolean canSuperUserDisapprove(Document document, org.kuali.rice.kim.api.identity.Person user)
      Description copied from interface: DocumentAuthorizer
      Determines if the user has permission to disapprove a document as a super user.
      Specified by:
      canSuperUserDisapprove in interface DocumentAuthorizer
      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

    • addPermissionDetails

      protected void addPermissionDetails(Object dataObject, Map<String,String> attributes)
      Description copied from class: DataObjectAuthorizerBase
      Override this method to populate the permission details from the primary data object or document. This will only be called once per request.
      Overrides:
      addPermissionDetails in class DataObjectAuthorizerBase
      Parameters:
      dataObject - - the primary data object (i.e. the main object instance behind the lookup result row or inquiry) or the document
      attributes - - permission details will be added to this map

    • addRoleQualification

      protected void addRoleQualification(Object dataObject, Map<String,String> attributes)
      Description copied from class: DataObjectAuthorizerBase
      Override this method to populate the role qualifier attributes from the primary data object or document. This will only be called once per request.
      Overrides:
      addRoleQualification in class DataObjectAuthorizerBase
      Parameters:
      dataObject - - the primary data object (i.e. the main object instance behind the lookup result row or inquiry) or the document
      attributes - - role qualifiers will be added to this map

    • addStandardAttributes

      protected void addStandardAttributes(Document document, Map<String,String> attributes)

    • isDocumentInitiator

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

    • getDocumentRequestAuthorizationCache

      protected DocumentRequestAuthorizationCache getDocumentRequestAuthorizationCache(Document document)

    • setDocumentRequestAuthorizationCache

      public void setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)
      Specified by:
      setDocumentRequestAuthorizationCache in interface DocumentAuthorizer