org.kuali.hr.time.authorization
Class TkMaintenanceDocumentAuthorizerBase

java.lang.Object
  org.kuali.hr.time.authorization.TkMaintenanceDocumentAuthorizerBase

All Implemented Interfaces:

org.kuali.rice.kns.authorization.BusinessObjectAuthorizer, org.kuali.rice.kns.bo.authorization.InquiryOrMaintenanceDocumentAuthorizer, org.kuali.rice.krad.bo.DataObjectAuthorizer, org.kuali.rice.krad.document.DocumentAuthorizer, org.kuali.rice.krad.maintenance.MaintenanceDocumentAuthorizer

Direct Known Subclasses:

DepartmentalRuleAuthorizer

public abstract class TkMaintenanceDocumentAuthorizerBase
extends Object
implements org.kuali.rice.kns.document.authorization.MaintenanceDocumentAuthorizer, org.kuali.rice.kns.document.authorization.DocumentAuthorizer

Base class for the implementation of Authorization in KPME Time and Attendance. Role Security Grid Documentation: https://wiki.kuali.org/display/KPME/Role+Security+Grid

Constructor Summary

TkMaintenanceDocumentAuthorizerBase()

Method Summary

boolean	canAcknowledge(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canAddNoteAttachment(org.kuali.rice.krad.document.Document document, String attachmentTypeCode, org.kuali.rice.kim.api.identity.Person user)
boolean	canAnnotate(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canApprove(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canBlanketApprove(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canCancel(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canClose(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canCopy(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canCreate(Class boClass, org.kuali.rice.kim.api.identity.Person user)
boolean	canCreateOrMaintain(org.kuali.rice.krad.maintenance.MaintenanceDocument maintenanceDocument, org.kuali.rice.kim.api.identity.Person user)
boolean	canDeleteNoteAttachment(org.kuali.rice.krad.document.Document document, String attachmentTypeCode, String createdBySelfOnly, org.kuali.rice.kim.api.identity.Person user)
boolean	canDisapprove(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canEdit(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canEditDocumentOverview(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canFyi(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canInitiate(String documentTypeName, org.kuali.rice.kim.api.identity.Person user)
boolean	canMaintain(Object dataObject, org.kuali.rice.kim.api.identity.Person user)
boolean	canOpen(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canPerformRouteReport(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canRecall(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canReceiveAdHoc(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user, String actionRequestCode)
boolean	canReload(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canRoute(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canSave(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canSendAdHocRequests(org.kuali.rice.krad.document.Document document, String actionRequestCd, org.kuali.rice.kim.api.identity.Person user)
boolean	canSendAnyTypeAdHocRequests(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canSendNoteFyi(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canTakeRequestedAction(org.kuali.rice.krad.document.Document document, String actionRequestCode, org.kuali.rice.kim.api.identity.Person user)
boolean	canViewNoteAttachment(org.kuali.rice.krad.document.Document document, String attachmentTypeCode, org.kuali.rice.kim.api.identity.Person user)
boolean	canViewNoteAttachment(org.kuali.rice.krad.document.Document document, String attachmentTypeCode, String authorUniversalIdentifier, org.kuali.rice.kim.api.identity.Person user)
Map<String,String>	getCollectionItemPermissionDetails(org.kuali.rice.krad.bo.BusinessObject collectionItemBusinessObject)
Map<String,String>	getCollectionItemRoleQualifications(org.kuali.rice.krad.bo.BusinessObject collectionItemBusinessObject)
Set<String>	getDocumentActions(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user, Set<String> documentActions) Copied from DocumentAuthorizerBase
UserRoles	getRoles() Returns the UserRoles object for the CURRENT user.
Set<String>	getSecurePotentiallyHiddenSectionIds()
Set<String>	getSecurePotentiallyReadOnlySectionIds()
boolean	isAuthorized(org.kuali.rice.krad.bo.BusinessObject businessObject, String namespaceCode, String permissionName, String principalId)
boolean	isAuthorized(org.kuali.rice.krad.bo.BusinessObject businessObject, String namespaceCode, String permissionName, String principalId, Map<String,String> additionalPermissionDetails, Map<String,String> additionalRoleQualifiers)
boolean	isAuthorized(Object dataObject, String namespaceCode, String permissionName, String principalId)
boolean	isAuthorized(Object dataObject, String namespaceCode, String permissionName, String principalId, Map<String,String> additionalPermissionDetails, Map<String,String> additionalRoleQualifiers)
boolean	isAuthorizedByTemplate(org.kuali.rice.krad.bo.BusinessObject businessObject, String namespaceCode, String permissionTemplateName, String principalId)
boolean	isAuthorizedByTemplate(Object dataObject, String namespaceCode, String permissionTemplateName, String principalId)
boolean	isAuthorizedByTemplate(Object dataObject, String namespaceCode, String permissionTemplateName, String principalId, Map<String,String> additionalPermissionDetails, Map<String,String> additionalRoleQualifiers)
abstract boolean	rolesIndicateGeneralReadAccess() Method to indicate whether or not the Context current user can read objects if the current maintenance type.
abstract boolean	rolesIndicateGeneralWriteAccess() Method to indicate whether or not the Context current user can create/edit objects if the current maintenance type.
abstract boolean	rolesIndicateReadAccess(org.kuali.rice.krad.bo.BusinessObject bo) Indicates whether or not the current Context user has view rights to the provided BusinessObject.
abstract boolean	rolesIndicateWriteAccess(org.kuali.rice.krad.bo.BusinessObject bo) Indicates whether or not the current Context user has create/edit rights to the provided BusinessObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

TkMaintenanceDocumentAuthorizerBase

public TkMaintenanceDocumentAuthorizerBase()

Method Detail

isAuthorized

public boolean isAuthorized(org.kuali.rice.krad.bo.BusinessObject businessObject,
                            String namespaceCode,
                            String permissionName,
                            String principalId)

Specified by:

isAuthorized in interface org.kuali.rice.kns.authorization.BusinessObjectAuthorizer

isAuthorizedByTemplate

public boolean isAuthorizedByTemplate(org.kuali.rice.krad.bo.BusinessObject businessObject,
                                      String namespaceCode,
                                      String permissionTemplateName,
                                      String principalId)

Specified by:

isAuthorizedByTemplate in interface org.kuali.rice.kns.authorization.BusinessObjectAuthorizer

isAuthorized

public boolean isAuthorized(org.kuali.rice.krad.bo.BusinessObject businessObject,
                            String namespaceCode,
                            String permissionName,
                            String principalId,
                            Map<String,String> additionalPermissionDetails,
                            Map<String,String> additionalRoleQualifiers)

Specified by:

isAuthorized in interface org.kuali.rice.kns.authorization.BusinessObjectAuthorizer

isAuthorizedByTemplate

public boolean isAuthorizedByTemplate(Object dataObject,
                                      String namespaceCode,
                                      String permissionTemplateName,
                                      String principalId,
                                      Map<String,String> additionalPermissionDetails,
                                      Map<String,String> additionalRoleQualifiers)

Specified by:

isAuthorizedByTemplate in interface org.kuali.rice.kns.authorization.BusinessObjectAuthorizer

Specified by:

isAuthorizedByTemplate in interface org.kuali.rice.krad.bo.DataObjectAuthorizer

getCollectionItemRoleQualifications

public Map<String,String> getCollectionItemRoleQualifications(org.kuali.rice.krad.bo.BusinessObject collectionItemBusinessObject)

Specified by:

getCollectionItemRoleQualifications in interface org.kuali.rice.kns.authorization.BusinessObjectAuthorizer

getCollectionItemPermissionDetails

public Map<String,String> getCollectionItemPermissionDetails(org.kuali.rice.krad.bo.BusinessObject collectionItemBusinessObject)

Specified by:

getCollectionItemPermissionDetails in interface org.kuali.rice.kns.authorization.BusinessObjectAuthorizer

canCreate

public boolean canCreate(Class boClass,
                         org.kuali.rice.kim.api.identity.Person user)

Specified by:

canCreate in interface org.kuali.rice.krad.maintenance.MaintenanceDocumentAuthorizer

canMaintain

public boolean canMaintain(Object dataObject,
                           org.kuali.rice.kim.api.identity.Person user)

Specified by:

canMaintain in interface org.kuali.rice.krad.maintenance.MaintenanceDocumentAuthorizer

canCreateOrMaintain

public boolean canCreateOrMaintain(org.kuali.rice.krad.maintenance.MaintenanceDocument maintenanceDocument,
                                   org.kuali.rice.kim.api.identity.Person user)

Specified by:

canCreateOrMaintain in interface org.kuali.rice.krad.maintenance.MaintenanceDocumentAuthorizer

getSecurePotentiallyReadOnlySectionIds

public Set<String> getSecurePotentiallyReadOnlySectionIds()

getDocumentActions

public Set<String> getDocumentActions(org.kuali.rice.krad.document.Document document,
                                      org.kuali.rice.kim.api.identity.Person user,
                                      Set<String> documentActions)

Copied from DocumentAuthorizerBase

canInitiate

public boolean canInitiate(String documentTypeName,
                           org.kuali.rice.kim.api.identity.Person user)

Specified by:

canInitiate in interface org.kuali.rice.krad.document.DocumentAuthorizer

canOpen

public boolean canOpen(org.kuali.rice.krad.document.Document document,
                       org.kuali.rice.kim.api.identity.Person user)

Specified by:

canOpen in interface org.kuali.rice.krad.document.DocumentAuthorizer

canEdit

public boolean canEdit(org.kuali.rice.krad.document.Document document,
                       org.kuali.rice.kim.api.identity.Person user)

Specified by:

canEdit in interface org.kuali.rice.krad.document.DocumentAuthorizer

canAnnotate

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

Specified by:

canAnnotate in interface org.kuali.rice.krad.document.DocumentAuthorizer

canReload

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

Specified by:

canReload in interface org.kuali.rice.krad.document.DocumentAuthorizer

canClose

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

Specified by:

canClose in interface org.kuali.rice.krad.document.DocumentAuthorizer

canSave

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

Specified by:

canSave in interface org.kuali.rice.krad.document.DocumentAuthorizer

canRoute

public boolean canRoute(org.kuali.rice.krad.document.Document document,
                        org.kuali.rice.kim.api.identity.Person user)

Specified by:

canRoute in interface org.kuali.rice.krad.document.DocumentAuthorizer

canCancel

public boolean canCancel(org.kuali.rice.krad.document.Document document,
                         org.kuali.rice.kim.api.identity.Person user)

Specified by:

canCancel in interface org.kuali.rice.krad.document.DocumentAuthorizer

canCopy

public boolean canCopy(org.kuali.rice.krad.document.Document document,
                       org.kuali.rice.kim.api.identity.Person user)

Specified by:

canCopy in interface org.kuali.rice.krad.document.DocumentAuthorizer

canPerformRouteReport

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

Specified by:

canPerformRouteReport in interface org.kuali.rice.krad.document.DocumentAuthorizer

canBlanketApprove

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

Specified by:

canBlanketApprove in interface org.kuali.rice.krad.document.DocumentAuthorizer

canApprove

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

Specified by:

canApprove in interface org.kuali.rice.krad.document.DocumentAuthorizer

canDisapprove

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

Specified by:

canDisapprove in interface org.kuali.rice.krad.document.DocumentAuthorizer

canSendNoteFyi

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

Specified by:

canSendNoteFyi in interface org.kuali.rice.krad.document.DocumentAuthorizer

canEditDocumentOverview

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

Specified by:

canEditDocumentOverview in interface org.kuali.rice.krad.document.DocumentAuthorizer

canFyi

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

Specified by:

canFyi in interface org.kuali.rice.krad.document.DocumentAuthorizer

canAcknowledge

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

Specified by:

canAcknowledge in interface org.kuali.rice.krad.document.DocumentAuthorizer

canReceiveAdHoc

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

Specified by:

canReceiveAdHoc in interface org.kuali.rice.krad.document.DocumentAuthorizer

canAddNoteAttachment

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

Specified by:

canAddNoteAttachment in interface org.kuali.rice.krad.document.DocumentAuthorizer

canDeleteNoteAttachment

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

Specified by:

canDeleteNoteAttachment in interface org.kuali.rice.krad.document.DocumentAuthorizer

canViewNoteAttachment

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

canViewNoteAttachment

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

Specified by:

canViewNoteAttachment in interface org.kuali.rice.krad.document.DocumentAuthorizer

canSendAdHocRequests

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

Specified by:

canSendAdHocRequests in interface org.kuali.rice.krad.document.DocumentAuthorizer

canSendAnyTypeAdHocRequests

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

Specified by:

canSendAnyTypeAdHocRequests in interface org.kuali.rice.krad.document.DocumentAuthorizer

canTakeRequestedAction

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

Specified by:

canTakeRequestedAction in interface org.kuali.rice.krad.document.DocumentAuthorizer

canRecall

public boolean canRecall(org.kuali.rice.krad.document.Document document,
                         org.kuali.rice.kim.api.identity.Person user)

Specified by:

canRecall in interface org.kuali.rice.krad.document.DocumentAuthorizer

isAuthorized

public boolean isAuthorized(Object dataObject,
                            String namespaceCode,
                            String permissionName,
                            String principalId)

Specified by:

isAuthorized in interface org.kuali.rice.krad.bo.DataObjectAuthorizer

isAuthorizedByTemplate

public boolean isAuthorizedByTemplate(Object dataObject,
                                      String namespaceCode,
                                      String permissionTemplateName,
                                      String principalId)

Specified by:

isAuthorizedByTemplate in interface org.kuali.rice.krad.bo.DataObjectAuthorizer

isAuthorized

public boolean isAuthorized(Object dataObject,
                            String namespaceCode,
                            String permissionName,
                            String principalId,
                            Map<String,String> additionalPermissionDetails,
                            Map<String,String> additionalRoleQualifiers)

Specified by:

isAuthorized in interface org.kuali.rice.krad.bo.DataObjectAuthorizer

getSecurePotentiallyHiddenSectionIds

public Set<String> getSecurePotentiallyHiddenSectionIds()

Specified by:

getSecurePotentiallyHiddenSectionIds in interface org.kuali.rice.kns.bo.authorization.InquiryOrMaintenanceDocumentAuthorizer

getRoles

public UserRoles getRoles()

Returns the UserRoles object for the CURRENT user. This will take into account target/backdoor user status. Subclasses can override this if necessary.

Returns:

The UserRoles object for the current user.

rolesIndicateGeneralReadAccess

public abstract boolean rolesIndicateGeneralReadAccess()

Method to indicate whether or not the Context current user can read objects if the current maintenance type.

Returns:

true if readable, false otherwise.

rolesIndicateGeneralWriteAccess

public abstract boolean rolesIndicateGeneralWriteAccess()

Method to indicate whether or not the Context current user can create/edit objects if the current maintenance type.

Returns:

true if create/editable, false otherwise.

rolesIndicateWriteAccess

public abstract boolean rolesIndicateWriteAccess(org.kuali.rice.krad.bo.BusinessObject bo)

Indicates whether or not the current Context user has create/edit rights to the provided BusinessObject.

Parameters:

bo - The BusinessObject under investigation.

Returns:

true if editable, false otherwise.

rolesIndicateReadAccess

public abstract boolean rolesIndicateReadAccess(org.kuali.rice.krad.bo.BusinessObject bo)

Indicates whether or not the current Context user has view rights to the provided BusinessObject.

Parameters:

bo - The BusinessObject under investigation.

Returns:

true if editable, false otherwise.