org.kuali.kra.protocol.protocol

Class ProtocolHelperBase

java.lang.Object

org.kuali.kra.protocol.protocol.ProtocolHelperBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IacucProtocolHelper, ProtocolHelper

public abstract class ProtocolHelperBase
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProtocolHelperBase(ProtocolFormBase form)

Method Summary

Methods

Modifier and Type	Method and Description
void	createInitialProtocolAction() Creates the initial PROTOCOL_CREATED action for a new protocol.
protected abstract ProtocolPersonBase	createNewProtocolPersonInstanceHook()
protected abstract ProtocolUnitBase	createNewProtocolUnitInstanceHook()
protected abstract ProtocolActionBase	createProtocolCreatedTypeProtocolActionInstanceHook(ProtocolBase protocol)
List<ProtocolFundingSourceBase>	findNewFundingSources()
protected abstract String	getBillableParameterHook()
boolean	getBillableReadOnly()
List<ProtocolFundingSourceBase>	getDeletedProtocolFundingSources()
boolean	getDisplayBillable()
String	getLeadUnitName()
String	getLeadUnitNumber()
String	getLookupUnitName()
String	getLookupUnitNumber()
boolean	getModifyAreasOfResearch()
boolean	getModifyFundingSource()
boolean	getModifyGeneralInfo()
boolean	getModifyOrganizations()
boolean	getModifyProtocol()
boolean	getModifyReferences()
ProtocolFundingSourceBase	getNewFundingSource()
protected abstract ProtocolTaskBase	getNewInstanceCreateProposalDevelopmentTaskHook(ProtocolBase protocol)
abstract ProtocolTaskBase	getNewInstanceModifyProtocolBillableTaskNewHook(ProtocolBase protocol)
protected abstract ProtocolTaskBase	getNewInstanceModifyProtocolFundingSourceTaskHook(ProtocolBase protocol)
protected abstract ProtocolTaskBase	getNewInstanceModifyProtocolGeneralInfoTaskHook(ProtocolBase protocol)
protected abstract ProtocolTaskBase	getNewInstanceModifyProtocolOrganizationsTaskHook(ProtocolBase protocol)
protected abstract ProtocolTaskBase	getNewInstanceModifyProtocolReferencesTaskHook(ProtocolBase protocol)
protected abstract ProtocolTaskBase	getNewInstanceModifyProtocolResearchAreasTaskHook(ProtocolBase protocol)
protected abstract ProtocolTaskBase	getNewInstanceModifyProtocolTaskHook(ProtocolBase protocol)
protected abstract ProtocolFundingSourceBase	getNewProtocolFundingSourceInstanceHook()
List<ProtocolFundingSourceBase>	getNewProtocolFundingSources()
ProtocolLocationBase	getNewProtocolLocation()
protected abstract ProtocolLocationBase	getNewProtocolLocationInstanceHook()
String	getOrganizationName()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
String	getPersonId()
String	getPrincipalInvestigatorId()
String	getPrincipalInvestigatorName()
protected ProtocolBase	getProtocol()
protected abstract Class<? extends ProtocolDocumentBase>	getProtocolDocumentClassHook()
protected ProtocolFundingSourceService	getProtocolFundingSourceService()
protected abstract Class<? extends ProtocolFundingSourceService>	getProtocolFundingSourceServiceClassHook()
protected abstract ProtocolNumberServiceBase	getProtocolNumberService()
protected abstract ProtocolPersonnelService	getProtocolPersonnelService()
protected abstract boolean	getProtocolProposalDevelopmentLinkingHook()
String	getReferenceId1Label()
protected abstract String	getReferenceID1ParameterNameHook()
String	getReferenceId2Label()
protected abstract String	getReferenceID2ParameterNameHook()
protected org.kuali.rice.kim.api.role.RoleService	getRoleService() Quick method to get the RoleService
String	getRolodexId()
protected RolodexService	getRolodexService()
protected SpecialReviewService	getSpecialReviewService()
protected TaskAuthorizationService	getTaskAuthorizationService()
protected String	getUserIdentifier()
protected void	initializePermissions(ProtocolBase protocol) This method initializes permission related to form.
boolean	isCanCreateProposalDevelopment()
boolean	isEditProtocolFundingSourceName()
boolean	isFundingNumberLookupable()
boolean	isLeadUnitAutoPopulated()
boolean	isNonEmployeeFlag()
boolean	isProtocolProposalDevelopmentLinkingEnabled()
boolean	isSourceNameEditable()
void	prepareRequiredFieldsForSave() This method is a form helper for protocol.
void	prepareView() This method prepares view for rendering UI.
void	setDeletedProtocolFundingSources(List<ProtocolFundingSourceBase> deletedProtocolFundingSources)
void	setDisplayBillable(boolean displayBillable)
void	setEditProtocolFundingSourceName(boolean editProtocolFundingSourceName)
void	setLeadUnitAutoPopulated(boolean leadUnitAutoPopulated)
void	setLeadUnitName(String leadUnitName)
void	setLeadUnitNumber(String leadUnitNumber)
void	setLookupUnitName(String lookupUnitName)
void	setLookupUnitNumber(String lookupUnitNumber)
void	setNewFundingSource(ProtocolFundingSourceBase newFundingSource)
void	setNewProtocolFundingSources(List<ProtocolFundingSourceBase> newProtocolFundingSources)
void	setNewProtocolLocation(ProtocolLocationBase newProtocolLocation)
void	setNonEmployeeFlag(boolean nonEmployeeFlag)
void	setOrganizationName(String organizationName)
void	setPersonId(String personId)
void	setPrincipalInvestigatorId(String principalInvestigatorId)
void	setPrincipalInvestigatorName(String principalInvestigatorName)
void	setReferenceId1Label(String referenceId1Label)
void	setReferenceId2Label(String referenceId2Label)
void	setRolodexId(String rolodexId)
void	syncFundingSources(ProtocolBase protocol)
abstract void	syncSpecialReviewsWithFundingSources()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolHelperBase

public ProtocolHelperBase(ProtocolFormBase form)

Method Detail

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Looks up and returns the ParameterService.

Returns:

the parameter service.

getRolodexService

protected RolodexService getRolodexService()

getProtocolFundingSourceService

protected ProtocolFundingSourceService getProtocolFundingSourceService()

getProtocolFundingSourceServiceClassHook

protected abstract Class<? extends ProtocolFundingSourceService> getProtocolFundingSourceServiceClassHook()

getSpecialReviewService

protected SpecialReviewService getSpecialReviewService()

isEditProtocolFundingSourceName

public boolean isEditProtocolFundingSourceName()

setEditProtocolFundingSourceName

public void setEditProtocolFundingSourceName(boolean editProtocolFundingSourceName)

getDeletedProtocolFundingSources

public List<ProtocolFundingSourceBase> getDeletedProtocolFundingSources()

setDeletedProtocolFundingSources

public void setDeletedProtocolFundingSources(List<ProtocolFundingSourceBase> deletedProtocolFundingSources)

getNewProtocolFundingSourceInstanceHook

protected abstract ProtocolFundingSourceBase getNewProtocolFundingSourceInstanceHook()

getNewProtocolLocationInstanceHook

protected abstract ProtocolLocationBase getNewProtocolLocationInstanceHook()

prepareView

public void prepareView()

This method prepares view for rendering UI. Note: Order of following methods must not be altered. initializeConfigurationParams() must be before initializePermissions(getProtocol()) due to billable requirement.

getProtocol

protected ProtocolBase getProtocol()

getBillableParameterHook

protected abstract String getBillableParameterHook()

getReferenceID1ParameterNameHook

protected abstract String getReferenceID1ParameterNameHook()

getReferenceID2ParameterNameHook

protected abstract String getReferenceID2ParameterNameHook()

initializePermissions

protected void initializePermissions(ProtocolBase protocol)

This method initializes permission related to form. Note: Billable permission is only set if displayBillable is true. Reason: For Institution who does not bill.

Parameters:

protocol -

getNewInstanceModifyProtocolTaskHook

protected abstract ProtocolTaskBase getNewInstanceModifyProtocolTaskHook(ProtocolBase protocol)

getNewInstanceModifyProtocolBillableTaskNewHook

public abstract ProtocolTaskBase getNewInstanceModifyProtocolBillableTaskNewHook(ProtocolBase protocol)

getNewInstanceModifyProtocolGeneralInfoTaskHook

protected abstract ProtocolTaskBase getNewInstanceModifyProtocolGeneralInfoTaskHook(ProtocolBase protocol)

getNewInstanceModifyProtocolFundingSourceTaskHook

protected abstract ProtocolTaskBase getNewInstanceModifyProtocolFundingSourceTaskHook(ProtocolBase protocol)

getNewInstanceModifyProtocolReferencesTaskHook

protected abstract ProtocolTaskBase getNewInstanceModifyProtocolReferencesTaskHook(ProtocolBase protocol)

getNewInstanceModifyProtocolOrganizationsTaskHook

protected abstract ProtocolTaskBase getNewInstanceModifyProtocolOrganizationsTaskHook(ProtocolBase protocol)

getNewInstanceModifyProtocolResearchAreasTaskHook

protected abstract ProtocolTaskBase getNewInstanceModifyProtocolResearchAreasTaskHook(ProtocolBase protocol)

getNewInstanceCreateProposalDevelopmentTaskHook

protected abstract ProtocolTaskBase getNewInstanceCreateProposalDevelopmentTaskHook(ProtocolBase protocol)

getProtocolProposalDevelopmentLinkingHook

protected abstract boolean getProtocolProposalDevelopmentLinkingHook()

isProtocolProposalDevelopmentLinkingEnabled

public boolean isProtocolProposalDevelopmentLinkingEnabled()

getProtocolDocumentClassHook

protected abstract Class<? extends ProtocolDocumentBase> getProtocolDocumentClassHook()

setReferenceId1Label

public void setReferenceId1Label(String referenceId1Label)

getReferenceId1Label

public String getReferenceId1Label()

setReferenceId2Label

public void setReferenceId2Label(String referenceId2Label)

getReferenceId2Label

public String getReferenceId2Label()

getModifyProtocol

public boolean getModifyProtocol()

getBillableReadOnly

public boolean getBillableReadOnly()

getTaskAuthorizationService

protected TaskAuthorizationService getTaskAuthorizationService()

getUserIdentifier

protected String getUserIdentifier()

syncFundingSources

public void syncFundingSources(ProtocolBase protocol)

getPrincipalInvestigatorId

public String getPrincipalInvestigatorId()

setPrincipalInvestigatorId

public void setPrincipalInvestigatorId(String principalInvestigatorId)

getPrincipalInvestigatorName

public String getPrincipalInvestigatorName()

setPrincipalInvestigatorName

public void setPrincipalInvestigatorName(String principalInvestigatorName)

getPersonId

public String getPersonId()

setPersonId

public void setPersonId(String personId)

getRolodexId

public String getRolodexId()

setRolodexId

public void setRolodexId(String rolodexId)

getLeadUnitNumber

public String getLeadUnitNumber()

setLeadUnitNumber

public void setLeadUnitNumber(String leadUnitNumber)

getLeadUnitName

public String getLeadUnitName()

setLeadUnitName

public void setLeadUnitName(String leadUnitName)

isNonEmployeeFlag

public boolean isNonEmployeeFlag()

setNonEmployeeFlag

public void setNonEmployeeFlag(boolean nonEmployeeFlag)

getLookupUnitName

public String getLookupUnitName()

setLookupUnitName

public void setLookupUnitName(String lookupUnitName)

getLookupUnitNumber

public String getLookupUnitNumber()

setLookupUnitNumber

public void setLookupUnitNumber(String lookupUnitNumber)

isLeadUnitAutoPopulated

public boolean isLeadUnitAutoPopulated()

setLeadUnitAutoPopulated

public void setLeadUnitAutoPopulated(boolean leadUnitAutoPopulated)

prepareRequiredFieldsForSave

public void prepareRequiredFieldsForSave()

This method is a form helper for protocol. It is needed to push the transient form fields into principal investigator /lead unit. Due to table structure, these are stored as lists in protocol and protocol investigator respectively, but aren't provided (by design) an explicit "add" element in the required fields panel view like most growing lists

createInitialProtocolAction

public void createInitialProtocolAction()

Creates the initial PROTOCOL_CREATED action for a new protocol.

createProtocolCreatedTypeProtocolActionInstanceHook

protected abstract ProtocolActionBase createProtocolCreatedTypeProtocolActionInstanceHook(ProtocolBase protocol)

syncSpecialReviewsWithFundingSources

public abstract void syncSpecialReviewsWithFundingSources()
                                                   throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getProtocolNumberService

protected abstract ProtocolNumberServiceBase getProtocolNumberService()

createNewProtocolUnitInstanceHook

protected abstract ProtocolUnitBase createNewProtocolUnitInstanceHook()

createNewProtocolPersonInstanceHook

protected abstract ProtocolPersonBase createNewProtocolPersonInstanceHook()

getNewProtocolLocation

public ProtocolLocationBase getNewProtocolLocation()

setNewProtocolLocation

public void setNewProtocolLocation(ProtocolLocationBase newProtocolLocation)

getOrganizationName

public String getOrganizationName()

setOrganizationName

public void setOrganizationName(String organizationName)

getProtocolPersonnelService

protected abstract ProtocolPersonnelService getProtocolPersonnelService()

getDisplayBillable

public boolean getDisplayBillable()

setDisplayBillable

public void setDisplayBillable(boolean displayBillable)

getNewFundingSource

public ProtocolFundingSourceBase getNewFundingSource()

setNewFundingSource

public void setNewFundingSource(ProtocolFundingSourceBase newFundingSource)

getModifyFundingSource

public boolean getModifyFundingSource()

getModifyGeneralInfo

public boolean getModifyGeneralInfo()

getModifyReferences

public boolean getModifyReferences()

getModifyOrganizations

public boolean getModifyOrganizations()

getModifyAreasOfResearch

public boolean getModifyAreasOfResearch()

isCanCreateProposalDevelopment

public boolean isCanCreateProposalDevelopment()

isFundingNumberLookupable

public boolean isFundingNumberLookupable()

isSourceNameEditable

public boolean isSourceNameEditable()

getRoleService

protected org.kuali.rice.kim.api.role.RoleService getRoleService()

Quick method to get the RoleService

Returns:

RoleService reference

getNewProtocolFundingSources

public List<ProtocolFundingSourceBase> getNewProtocolFundingSources()

setNewProtocolFundingSources

public void setNewProtocolFundingSources(List<ProtocolFundingSourceBase> newProtocolFundingSources)

findNewFundingSources

public List<ProtocolFundingSourceBase> findNewFundingSources()