org.kuali.rice.krad.document

Interface DocumentAuthorizer

All Superinterfaces:

DataObjectAuthorizer

All Known Subinterfaces:

DocumentAuthorizer, MaintenanceDocumentAuthorizer, MaintenanceDocumentAuthorizer, TransactionalDocumentAuthorizer, TransactionalDocumentAuthorizer

All Known Implementing Classes:

AgendaEditorAuthorizer, DocumentAuthorizerBase, DocumentAuthorizerBase, DocumentViewAuthorizerBase, IdentityManagementKimDocumentAuthorizer, LabsTravelAccountViewAuthorizer, MaintenanceDocumentAuthorizerBase, MaintenanceDocumentAuthorizerBase, MaintenanceViewAuthorizerBase, TransactionalDocumentAuthorizerBase, TransactionalDocumentAuthorizerBase, TransactionalDocumentViewAuthorizerBase, TravelDocumentAuthorizer

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 Summary

Methods

Modifier and Type	Method and Description
boolean	canAcknowledge(Document document, Person user)
boolean	canAddNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	canAnnotate(Document document, Person user)
boolean	canApprove(Document document, Person user)
boolean	canBlanketApprove(Document document, Person user)
boolean	canCancel(Document document, Person user) Determines if the user has permission to cancel the document
boolean	canClose(Document document, Person user)
boolean	canCopy(Document document, Person user) Determines if the user has permission to copy the document
boolean	canDeleteNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
boolean	canDisapprove(Document document, Person user)
boolean	canEdit(Document document, Person user) Determines if the document can be edited; if false is returned, then all fields are in a read only state
boolean	canEditDocumentOverview(Document document, Person user)
boolean	canFyi(Document document, Person user)
boolean	canInitiate(String documentTypeName, Person user) Checks if a user has the permissions to initiate a document
boolean	canOpen(Document document, Person user) Checks if a user has the permissions to open a document
boolean	canPerformRouteReport(Document document, Person user)
boolean	canRecall(Document document, Person user)
boolean	canReceiveAdHoc(Document document, Person user, String actionRequestCode)
boolean	canReload(Document document, Person user)
boolean	canRoute(Document document, Person user) Determines if the user has permission to route the document
boolean	canSave(Document document, Person user)
boolean	canSendAdHocRequests(Document document, String actionRequestCd, Person user)
boolean	canSendAnyTypeAdHocRequests(Document document, Person user)
boolean	canSendNoteFyi(Document document, Person user)
boolean	canSuperUserApprove(Document document, Person user) Determines if the user has permission to approve a document as a super user.
boolean	canSuperUserDisapprove(Document document, Person user) Determines if the user has permission to disapprove a document as a super user.
boolean	canSuperUserTakeAction(Document document, Person user) Determines if the user has permission to take a super user action.
boolean	canTakeRequestedAction(Document document, String actionRequestCode, Person user)
boolean	canViewNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user) Deprecated.
void	setDocumentRequestAuthorizationCache(DocumentRequestAuthorizationCache documentRequestAuthorizationCache)

Methods inherited from interface org.kuali.rice.krad.bo.DataObjectAuthorizer

isAuthorized, isAuthorized, isAuthorizedByTemplate, isAuthorizedByTemplate

Method Detail

canInitiate

boolean canInitiate(String documentTypeName,
                  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,
              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,
              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,
                  Person user)

canReload

boolean canReload(Document document,
                Person user)

canClose

boolean canClose(Document document,
               Person user)

canSave

boolean canSave(Document document,
              Person user)

canRoute

boolean canRoute(Document document,
               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,
                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,
              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,
                            Person user)

canBlanketApprove

boolean canBlanketApprove(Document document,
                        Person user)

canApprove

boolean canApprove(Document document,
                 Person user)

canDisapprove

boolean canDisapprove(Document document,
                    Person user)

canSendNoteFyi

boolean canSendNoteFyi(Document document,
                     Person user)

canEditDocumentOverview

boolean canEditDocumentOverview(Document document,
                              Person user)

canFyi

boolean canFyi(Document document,
             Person user)

canAcknowledge

boolean canAcknowledge(Document document,
                     Person user)

canReceiveAdHoc

boolean canReceiveAdHoc(Document document,
                      Person user,
                      String actionRequestCode)

canAddNoteAttachment

boolean canAddNoteAttachment(Document document,
                           String attachmentTypeCode,
                           Person user)

canDeleteNoteAttachment

boolean canDeleteNoteAttachment(Document document,
                              String attachmentTypeCode,
                              String authorUniversalIdentifier,
                              Person user)

canViewNoteAttachment

boolean canViewNoteAttachment(Document document,
                            String attachmentTypeCode,
                            Person user)

canViewNoteAttachment

@Deprecated
boolean canViewNoteAttachment(Document document,
                                       String attachmentTypeCode,
                                       String authorUniversalIdentifier,
                                       Person user)

Deprecated.

canSendAdHocRequests

boolean canSendAdHocRequests(Document document,
                           String actionRequestCd,
                           Person user)

canSendAnyTypeAdHocRequests

boolean canSendAnyTypeAdHocRequests(Document document,
                                  Person user)

canTakeRequestedAction

boolean canTakeRequestedAction(Document document,
                             String actionRequestCode,
                             Person user)

canRecall

boolean canRecall(Document document,
                Person user)

Since:

2.1

canSuperUserTakeAction

boolean canSuperUserTakeAction(Document document,
                             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,
                          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,
                             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)