org.kuali.kra.protocol.actions.submit

Class ProtocolActionServiceImplBase

java.lang.Object

org.kuali.kra.protocol.actions.submit.ProtocolActionServiceImplBase

All Implemented Interfaces:

ProtocolActionService

Direct Known Subclasses:

IacucProtocolActionServiceImpl, ProtocolActionServiceImpl

public abstract class ProtocolActionServiceImplBase
extends Object
implements ProtocolActionService

This class is to provide the 'protocol' action pre validation and post update. pre-validation include canperform and authorization check. post-update will update protocol status or submission status.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	actions
protected static String	AMEND
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected DroolsRuleHandler	canPerformRuleHandler
protected static String	DEFAULT_ORGANIZATION_UNIT
protected FollowupActionService<?>	followupActionService
protected KraAuthorizationService	kraAuthorizationService
protected static String	MODIFY_ANY_PROTOCOL
protected static String	NONE
protected static String	RENEW
protected List<DroolsRuleHandler>	rulesList
protected UnitAuthorizationService	unitAuthorizationService

Constructor Summary

Constructors

Constructor and Description
ProtocolActionServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPerformAction(String actionTypeCode, ProtocolBase protocol) This method is to check whether 'actionTypeCode' can be performed based on protocol's status code or submission code or other condition specified in rule.
protected abstract String[]	getActionCodesArrayHook()
List<String>	getActionsAllowed(ProtocolBase protocol) This method is to get a list of protocol actions that can be performed based on this protocol's status or submission status and user's permission
DroolsRuleHandler	getCanPerformRuleHandler() Compile rules if rulehandler is not set.
protected abstract org.apache.commons.logging.Log	getLOGHook()
protected abstract ProtocolActionMappingBase	getNewProtocolActionMappingInstanceHook(String actionTypeCode, String submissionStatusCode, String submissionTypeCode, String protocolReviewTypeCode, String protocolStatusCode, String scheduleId, Integer submissionNumber)
protected abstract ProtocolActionUpdateMapping	getNewProtocolActionUpdateMappingHook(String protocolActionTypeCode, String submissionTypeCode, String protocolStatusCode, String specialCondition)
protected abstract String	getPerformActionFileNameHook()
protected abstract int	getPerformActionRuleIndexHook()
protected abstract int	getUpdateRuleIndexHook()
protected String	getUserIdentifier()
protected abstract boolean	hasPermissionLeadUnit(String actionTypeCode, ProtocolBase protocol, ActionRightMapping rightMapper)
protected abstract boolean	hasPermissionToSubmit(String actionTypeCode, ProtocolBase protocol, ActionRightMapping rightMapper)
boolean	isActionAllowed(String actionTypeCode, ProtocolBase protocol) This method is to check if this protocol action can be performed based on protocol status or submission status and also check if the user is authorized to perform this action.
boolean	isActionOpenForFollowup(String protocolActionTypeCode, ProtocolBase protocol) Determines whether the given action in the protocol should be opened, based on whether it is a followup action.
boolean	isProtocolPersonnel(ProtocolBase protocol) Determines whether the logged in user is ProtocolBase Personnel
protected void	loadRules(List<String> ruleFiles)
abstract void	resetProtocolStatus(ProtocolActionBase protocolActionBo, ProtocolBase protocol) This method is to undo the protocol status or submission status update.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setFollowupActionService(FollowupActionService<?> followupActionService)
void	setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)
void	setProtocolDao(ProtocolDao<? extends ProtocolBase> protocolDao)
void	setRuleFiles(List<String> ruleFiles) This method sets the rule file.
void	setUnitAuthorizationService(UnitAuthorizationService unitAuthorizationService)
void	updateProtocolStatus(ProtocolActionBase protocolActionBo, ProtocolBase protocol) This method is to update protocol status or submission status after the action is submitted.

Methods inherited from class java.lang.Object

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

Field Detail

MODIFY_ANY_PROTOCOL

protected static final String MODIFY_ANY_PROTOCOL

See Also:

Constant Field Values

DEFAULT_ORGANIZATION_UNIT

protected static final String DEFAULT_ORGANIZATION_UNIT

See Also:

Constant Field Values

AMEND

protected static final String AMEND

See Also:

Constant Field Values

RENEW

protected static final String RENEW

See Also:

Constant Field Values

NONE

protected static final String NONE

See Also:

Constant Field Values

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

kraAuthorizationService

protected KraAuthorizationService kraAuthorizationService

unitAuthorizationService

protected UnitAuthorizationService unitAuthorizationService

followupActionService

protected FollowupActionService<?> followupActionService

canPerformRuleHandler

protected DroolsRuleHandler canPerformRuleHandler

actions

protected List<String> actions

rulesList

protected List<DroolsRuleHandler> rulesList

Constructor Detail

ProtocolActionServiceImplBase

public ProtocolActionServiceImplBase()

Method Detail

getActionCodesArrayHook

protected abstract String[] getActionCodesArrayHook()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

setKraAuthorizationService

public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)

setUnitAuthorizationService

public void setUnitAuthorizationService(UnitAuthorizationService unitAuthorizationService)

setProtocolDao

public void setProtocolDao(ProtocolDao<? extends ProtocolBase> protocolDao)

setFollowupActionService

public void setFollowupActionService(FollowupActionService<?> followupActionService)

isActionAllowed

public boolean isActionAllowed(String actionTypeCode,
                      ProtocolBase protocol)

Description copied from interface: ProtocolActionService

This method is to check if this protocol action can be performed based on protocol status or submission status and also check if the user is authorized to perform this action.

Specified by:

isActionAllowed in interface ProtocolActionService

Returns:

See Also:

ProtocolActionService.isActionAllowed(java.lang.String, org.kuali.kra.protocol.ProtocolBase)

getActionsAllowed

public List<String> getActionsAllowed(ProtocolBase protocol)

Description copied from interface: ProtocolActionService

This method is to get a list of protocol actions that can be performed based on this protocol's status or submission status and user's permission

Specified by:

getActionsAllowed in interface ProtocolActionService

Returns:

See Also:

ProtocolActionService.getActionsAllowed(org.kuali.kra.protocol.ProtocolBase)

hasPermissionLeadUnit

protected abstract boolean hasPermissionLeadUnit(String actionTypeCode,
                            ProtocolBase protocol,
                            ActionRightMapping rightMapper)

hasPermissionToSubmit

protected abstract boolean hasPermissionToSubmit(String actionTypeCode,
                            ProtocolBase protocol,
                            ActionRightMapping rightMapper)

isProtocolPersonnel

public boolean isProtocolPersonnel(ProtocolBase protocol)

Description copied from interface: ProtocolActionService

Determines whether the logged in user is ProtocolBase Personnel

Specified by:

isProtocolPersonnel in interface ProtocolActionService

Parameters:

protocol - The ProtocolBase

Returns:

true, if the logged in user is protocol personnel else returns false

getUserIdentifier

protected String getUserIdentifier()

canPerformAction

public boolean canPerformAction(String actionTypeCode,
                       ProtocolBase protocol)

This method is to check whether 'actionTypeCode' can be performed based on protocol's status code or submission code or other condition specified in rule.

getLOGHook

protected abstract org.apache.commons.logging.Log getLOGHook()

getPerformActionRuleIndexHook

protected abstract int getPerformActionRuleIndexHook()

getNewProtocolActionMappingInstanceHook

protected abstract ProtocolActionMappingBase getNewProtocolActionMappingInstanceHook(String actionTypeCode,
                                                                String submissionStatusCode,
                                                                String submissionTypeCode,
                                                                String protocolReviewTypeCode,
                                                                String protocolStatusCode,
                                                                String scheduleId,
                                                                Integer submissionNumber)

updateProtocolStatus

public void updateProtocolStatus(ProtocolActionBase protocolActionBo,
                        ProtocolBase protocol)

Description copied from interface: ProtocolActionService

This method is to update protocol status or submission status after the action is submitted.

Specified by:

updateProtocolStatus in interface ProtocolActionService

See Also:

ProtocolActionService.updateProtocolStatus(org.kuali.kra.protocol.actions.ProtocolActionBase, org.kuali.kra.protocol.ProtocolBase)

getNewProtocolActionUpdateMappingHook

protected abstract ProtocolActionUpdateMapping getNewProtocolActionUpdateMappingHook(String protocolActionTypeCode,
                                                                String submissionTypeCode,
                                                                String protocolStatusCode,
                                                                String specialCondition)

getUpdateRuleIndexHook

protected abstract int getUpdateRuleIndexHook()

resetProtocolStatus

public abstract void resetProtocolStatus(ProtocolActionBase protocolActionBo,
                       ProtocolBase protocol)

Description copied from interface: ProtocolActionService

This method is to undo the protocol status or submission status update.

Specified by:

resetProtocolStatus in interface ProtocolActionService

isActionOpenForFollowup

public boolean isActionOpenForFollowup(String protocolActionTypeCode,
                              ProtocolBase protocol)

Determines whether the given action in the protocol should be opened, based on whether it is a followup action.

Specified by:

isActionOpenForFollowup in interface ProtocolActionService

Parameters:

protocolActionTypeCode - The code for the protocol action

protocol - The ProtocolBase

Returns:

true, if the Drools rules state that the action should now be open for followup, false otherwise

See Also:

org.kuali.kra.protocol.actions.ProtocolActionFollowupService#isActionOpenForFollowup(java.lang.String, org.kuali.kra.protocol.ProtocolBase)

getCanPerformRuleHandler

public DroolsRuleHandler getCanPerformRuleHandler()

Compile rules if rulehandler is not set.

getPerformActionFileNameHook

protected abstract String getPerformActionFileNameHook()

setRuleFiles

public void setRuleFiles(List<String> ruleFiles)
                  throws IOException

This method sets the rule file.

Parameters:

ruleFiles -

Throws:

IOException

loadRules

protected void loadRules(List<String> ruleFiles)