org.kuali.kra.protocol.actions.submit

Interface ProtocolActionService

All Known Subinterfaces:

IacucProtocolActionService, ProtocolActionService

All Known Implementing Classes:

IacucProtocolActionServiceImpl, ProtocolActionServiceImpl, ProtocolActionServiceImplBase

public interface ProtocolActionService

Method Summary

Methods

Modifier and Type	Method and Description
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
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
void	resetProtocolStatus(ProtocolActionBase protocolActionBo, ProtocolBase protocol) This method is to undo the protocol status or submission status update.
void	updateProtocolStatus(ProtocolActionBase protocolActionBo, ProtocolBase protocol) This method is to update protocol status or submission status after the action is submitted.

Method Detail

getActionsAllowed

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

Parameters:

protocol -

Returns:

updateProtocolStatus

void updateProtocolStatus(ProtocolActionBase protocolActionBo,
                        ProtocolBase protocol)

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

Parameters:

protocolActionBo -

protocol -

resetProtocolStatus

void resetProtocolStatus(ProtocolActionBase protocolActionBo,
                       ProtocolBase protocol)

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

Parameters:

protocolActionBo -

protocol -

isActionAllowed

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.

Parameters:

actionTypeCode -

protocol -

Returns:

isActionOpenForFollowup

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.

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

isProtocolPersonnel

boolean isProtocolPersonnel(ProtocolBase protocol)

Determines whether the logged in user is ProtocolBase Personnel

Parameters:

protocol - The ProtocolBase

Returns:

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