org.kuali.kra.protocol.auth

Class ProtocolAuthorizerBase

java.lang.Object

org.kuali.kra.authorization.TaskAuthorizerImpl

org.kuali.kra.protocol.auth.ProtocolAuthorizerBase

All Implemented Interfaces:

TaskAuthorizer

Direct Known Subclasses:

AbandonProtocolAuthorizer, AddProtocolBillableAuthorizer, AdminCorrectionProtocolAuthorizerBase, AdminCorrectionProtocolUnavailableAuthorizerBase, ContinuationAuthorizer, CreateAmendmentAuthorizerBase, CreateAmendmentUnavailableAuthorizerBase, CreateRenewalAuthorizerBase, CreateRenewalUnavailableAuthorizerBase, ExpediteApprovalAuthorizer, ExpediteApprovalUnavailableAuthorizer, GenericProtocolAuthorizer, IacucProtocolAuthorizer, IacucViewRestrictedNotesProtocolAuthorizer, IrbAcknowledgementAuthorizer, IrbAcknowledgementUnavailableAuthorizer, ModifyAmendmentSectionsAuthorizerBase, ModifyAmendmentSectionsUnavailableAuthorizerBase, ModifyProtocolAuthorizer, ModifyProtocolSubmissionAuthorizer, ModifyProtocolSubmissionUnavailableAuthorizer, NotifyCommitteeAuthorizer, NotifyCommitteeUnavailableAuthorizer, NotifyIrbAuthorizer, NotifyIrbUnavailableAuthorizer, ProtocolApproveOtherAuthorizer, ProtocolAssignCmtSchedAuthorizer, ProtocolAssignCmtSchedUnavailableAuthorizer, ProtocolAssignReviewersAuthorizer, ProtocolAssignReviewersCmtSelAuthorizer, ProtocolAssignReviewersUnavailableAuthorizer, ProtocolAssignToAgendaUnavailableAuthorizer, ProtocolAuthorizer, ProtocolGrantExemptionAuthorizer, ProtocolGrantExemptionUnavailableAuthorizer, ProtocolMaintainOnlineReviewsAuthorizer, ProtocolManageNotesAuthorizer, ProtocolManageNotesUnavailableAuthorizer, ProtocolRequestCloseAuthorizer, ProtocolRequestCloseEnrollmentAuthorizer, ProtocolRequestCloseEnrollmentUnavailableAuthorizer, ProtocolRequestCloseUnavailableAuthorizer, ProtocolRequestDataAnalysisAuthorizer, ProtocolRequestDataAnalysisUnavailableAuthorizer, ProtocolRequestReOpenEnrollmentAuthorizer, ProtocolRequestReOpenEnrollmentUnavailableAuthorizer, ProtocolRequestSuspensionAuthorizer, ProtocolRequestSuspensionUnavailableAuthorizer, ProtocolRequestTerminateAuthorizer, ProtocolRequestTerminateUnavailableAuthorizer, ProtocolReviewNotRequiredAuthorizer, ProtocolReviewNotRequiredUnavailableAuthorizer, ProtocolWithdrawAuthorizer, ProtocolWithdrawUnavailableAuthorizer, ResponseApprovalAuthorizer, ResponseApprovalUnavailableAuthorizer, SubmitProtocolAuthorizer, SubmitProtocolUnavailableAuthorizer, ViewProtocolAuthorizer, ViewRestrictedNotesProtocolAuthorizer

public abstract class ProtocolAuthorizerBase
extends TaskAuthorizerImpl

A ProtocolBase Authorizer determines if a user can perform a given task on a protocol.

Field Summary

Fields

Modifier and Type	Field and Description
protected KraAuthorizationService	kraAuthorizationService

Fields inherited from class org.kuali.kra.authorization.TaskAuthorizerImpl

kcPersonService, kraWorkflowService

Constructor Summary

Constructors

Constructor and Description
ProtocolAuthorizerBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canExecuteAction(ProtocolBase protocol, String protocolActionTypeCode) Can the user on the current thread execute the given action for the given protocol?
protected boolean	hasPermission(String userId, ProtocolBase protocol, String permissionName) Does the given user has the permission for this protocol?
protected boolean	isAdminCorrection(ProtocolTaskBase task)
protected boolean	isAmendment(ProtocolBase protocol) Is the protocol an amendment protocol?
protected boolean	isAmendmentOrRenewal(ProtocolBase protocol) Is the protocol an amendment or renewal protocol? Including continuation here - since continuation is similar to renewal
abstract boolean	isAuthorized(String userId, ProtocolTaskBase task) Is the user authorized to execute the given protocol task?
boolean	isAuthorized(String userId, Task task) Is the user authorized to execute the given task?
protected boolean	isPessimisticLocked(org.kuali.rice.krad.document.Document document)
void	setKraAuthorizationService(KraAuthorizationService kraAuthorizationService) Set the Kra Authorization Service.
void	setProtocolActionService(ProtocolActionService protocolActionService) Set the ProtocolBase Action Service.

Methods inherited from class org.kuali.kra.authorization.TaskAuthorizerImpl

getTaskName, hasUnitPermission, hasUnitPermission, setKcPersonService, setKraWorkflowService, setTaskName, setUnitAuthorizationService

Methods inherited from class java.lang.Object

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

Field Detail

kraAuthorizationService

protected KraAuthorizationService kraAuthorizationService

Constructor Detail

ProtocolAuthorizerBase

public ProtocolAuthorizerBase()

Method Detail

setProtocolActionService

public final void setProtocolActionService(ProtocolActionService protocolActionService)

Set the ProtocolBase Action Service.

Parameters:

protocolActionService -

isAuthorized

public final boolean isAuthorized(String userId,
                   Task task)

Description copied from interface: TaskAuthorizer

Is the user authorized to execute the given task?

task - the task

Returns:

true if the user is authorized; otherwise false

See Also:

TaskAuthorizer.isAuthorized(java.lang.String, org.kuali.kra.authorization.Task)

isAuthorized

public abstract boolean isAuthorized(String userId,
                   ProtocolTaskBase task)

Is the user authorized to execute the given protocol task?

Parameters:

username - the user's unique username

task - the protocol task

Returns:

true if the user is authorized; otherwise false

setKraAuthorizationService

public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)

Set the Kra Authorization Service. Usually injected by the Spring Framework.

Parameters:

kraAuthorizationService -

hasPermission

protected final boolean hasPermission(String userId,
                    ProtocolBase protocol,
                    String permissionName)

Does the given user has the permission for this protocol?

Parameters:

username - the unique username of the user

protocol - the protocol

permissionName - the name of the permission

Returns:

true if the person has the permission; otherwise false

isAmendment

protected final boolean isAmendment(ProtocolBase protocol)

Is the protocol an amendment protocol?

Parameters:

protocol - the protocol

Returns:

true if the protocol is an amendment; otherwise false

isAmendmentOrRenewal

protected final boolean isAmendmentOrRenewal(ProtocolBase protocol)

Is the protocol an amendment or renewal protocol? Including continuation here - since continuation is similar to renewal

Parameters:

protocol - the protocol

Returns:

true if the protocol is an amendment or renewal; otherwise false

isAdminCorrection

protected final boolean isAdminCorrection(ProtocolTaskBase task)

canExecuteAction

protected final boolean canExecuteAction(ProtocolBase protocol,
                       String protocolActionTypeCode)

Can the user on the current thread execute the given action for the given protocol?

Parameters:

protocol -

protocolActionTypeCode -

Returns:

true if the action can be executed; otherwise false

isPessimisticLocked

protected boolean isPessimisticLocked(org.kuali.rice.krad.document.Document document)