org.kuali.kra.protocol

Class ProtocolJavaFunctionKrmsTermServiceBase

java.lang.Object

org.kuali.kra.krms.service.impl.KcKrmsJavaFunctionTermServiceBase

org.kuali.kra.protocol.ProtocolJavaFunctionKrmsTermServiceBase

All Implemented Interfaces:

ProtocolJavaFunctionKrmsTermService

Direct Known Subclasses:

IacucJavaFunctionKrmsTermServiceImpl, IrbJavaFunctionKrmsTermServiceImpl

public abstract class ProtocolJavaFunctionKrmsTermServiceBase
extends KcKrmsJavaFunctionTermServiceBase
implements ProtocolJavaFunctionKrmsTermService

Field Summary

Fields inherited from class org.kuali.kra.krms.service.impl.KcKrmsJavaFunctionTermServiceBase

FALSE, restrictedElements, TRUE

Constructor Summary

Constructors

Constructor and Description
ProtocolJavaFunctionKrmsTermServiceBase()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	allProtocols() This method returns true always.
protected abstract ProtocolBase	getActiveProtocol(String protocolNumber)
KcPersonService	getKcPersonService()
abstract String	getNotifySubmissionTypeCode()
abstract String	getProtocolOrganizationModuleTypeCode()
abstract String	getProtocolPersonnelModuleTypeCode()
abstract String	getRenewalActionTypeCode()
Boolean	hasAllPersonsCompletedTraining(ProtocolBase protocol) This method check if all persons has completed training
Boolean	hasFundingSourceContainsSponsor(ProtocolBase protocol, String sponsor) This method check if the protocol funding source sponsor contains a specified sponsor.
Boolean	hasFundingSourceContainsUnit(ProtocolBase protocol, String unitNumber) This method check if the protocol funding source units contains a specified unit.
Boolean	hasProtocolContainsAreaOfResearch(ProtocolBase protocol, String areaOfResearchCode) This method check if the protocol areas of research contains a specified research area.
Boolean	hasProtocolContainsDocumentType(ProtocolBase protocol, String documentTypeCode) This method check if any of the protocol document type is the specified document type
Boolean	hasProtocolContainsNotifySubmissionQualifierType(ProtocolBase protocol, Integer submissionNumber, String submissionQualifierTypeCode) This method check if the selected submission qualifier type is a specified type
Boolean	hasProtocolContainsOrganization(ProtocolBase protocol, String organizationId) This method check if the protocol organizations contains a specified organization.
Boolean	hasSubmissionType(ProtocolBase protocol, Integer submissionNumber, String submissionTypeCode) This method check if the selected submission type is a specified type
Boolean	isLeadUnitProtocolCampus(ProtocolBase protocol, String campusCode) This method check if the lead unit of the ProtocolBase belong to campus
Boolean	isOrganizationChangedInAmendmentOrRenewal(ProtocolBase protocol) This method check if the Organazation is changed in amendment/renewal.
Boolean	isPiChangedInAmendmentOrRenewal(ProtocolBase protocol) This method check if the Principal Investigator is changed in amendment/renewal.
Boolean	isPINotFaculty(ProtocolBase protocol) This method checks if the principal investigator is not a faculty member.
Boolean	isProtocolAmendment(ProtocolBase protocol) This method check if the protocol is an amendment
Boolean	isProtocolInSubmission(ProtocolBase protocol, String submissionTypeCode) This method check if the protocol is in the specified submission
Boolean	isProtocolLeadUnitBelow(ProtocolBase protocol, String unitNumber) This method check if the lead unit for the protocol is below a specified unit in the hierarchy
Boolean	isProtocolRenewal(ProtocolBase protocol) This method check if the protocol is an renewal
Boolean	isProtocolRenewalWithAmendment(ProtocolBase protocol) This method check if the protocol is renewal with amendment
Boolean	isSpecialReviewExists(ProtocolBase protocol) This method check if the protocol contains a specified special review type.
Boolean	isSubmitUserProtocolPi(ProtocolBase protocol, String submitUserId) This method check if the submit user is the PI of the protocol.
void	setKcPersonService(KcPersonService kcPersonService)

Methods inherited from class org.kuali.kra.krms.service.impl.KcKrmsJavaFunctionTermServiceBase

buildArrayFromCommaList, getBusinessObjectService, getDocumentService, getParameterService, getUnitService, setBusinessObjectService, setDocumentService, setParameterService, setUnitService, specialCharacterRule

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolJavaFunctionKrmsTermServiceBase

public ProtocolJavaFunctionKrmsTermServiceBase()

Method Detail

getRenewalActionTypeCode

public abstract String getRenewalActionTypeCode()

getProtocolPersonnelModuleTypeCode

public abstract String getProtocolPersonnelModuleTypeCode()

getProtocolOrganizationModuleTypeCode

public abstract String getProtocolOrganizationModuleTypeCode()

getNotifySubmissionTypeCode

public abstract String getNotifySubmissionTypeCode()

allProtocols

public Boolean allProtocols()

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method returns true always. This is used for building business rule for any protocols.

Specified by:

allProtocols in interface ProtocolJavaFunctionKrmsTermService

Returns:

isProtocolAmendment

public Boolean isProtocolAmendment(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol is an amendment

Specified by:

isProtocolAmendment in interface ProtocolJavaFunctionKrmsTermService

Returns:

isProtocolRenewal

public Boolean isProtocolRenewal(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol is an renewal

Specified by:

isProtocolRenewal in interface ProtocolJavaFunctionKrmsTermService

Returns:

isProtocolLeadUnitBelow

public Boolean isProtocolLeadUnitBelow(ProtocolBase protocol,
                              String unitNumber)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the lead unit for the protocol is below a specified unit in the hierarchy

Specified by:

isProtocolLeadUnitBelow in interface ProtocolJavaFunctionKrmsTermService

Returns:

isPINotFaculty

public Boolean isPINotFaculty(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method checks if the principal investigator is not a faculty member.

Specified by:

isPINotFaculty in interface ProtocolJavaFunctionKrmsTermService

Returns:

isSpecialReviewExists

public Boolean isSpecialReviewExists(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol contains a specified special review type.

Specified by:

isSpecialReviewExists in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasProtocolContainsOrganization

public Boolean hasProtocolContainsOrganization(ProtocolBase protocol,
                                      String organizationId)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol organizations contains a specified organization.

Specified by:

hasProtocolContainsOrganization in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasAllPersonsCompletedTraining

public Boolean hasAllPersonsCompletedTraining(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if all persons has completed training

Specified by:

hasAllPersonsCompletedTraining in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasFundingSourceContainsSponsor

public Boolean hasFundingSourceContainsSponsor(ProtocolBase protocol,
                                      String sponsor)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol funding source sponsor contains a specified sponsor.

Specified by:

hasFundingSourceContainsSponsor in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasFundingSourceContainsUnit

public Boolean hasFundingSourceContainsUnit(ProtocolBase protocol,
                                   String unitNumber)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol funding source units contains a specified unit.

Specified by:

hasFundingSourceContainsUnit in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasProtocolContainsAreaOfResearch

public Boolean hasProtocolContainsAreaOfResearch(ProtocolBase protocol,
                                        String areaOfResearchCode)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol areas of research contains a specified research area.

Specified by:

hasProtocolContainsAreaOfResearch in interface ProtocolJavaFunctionKrmsTermService

Returns:

getActiveProtocol

protected abstract ProtocolBase getActiveProtocol(String protocolNumber)

isPiChangedInAmendmentOrRenewal

public Boolean isPiChangedInAmendmentOrRenewal(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the Principal Investigator is changed in amendment/renewal.

Specified by:

isPiChangedInAmendmentOrRenewal in interface ProtocolJavaFunctionKrmsTermService

Returns:

isOrganizationChangedInAmendmentOrRenewal

public Boolean isOrganizationChangedInAmendmentOrRenewal(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the Organazation is changed in amendment/renewal.

Specified by:

isOrganizationChangedInAmendmentOrRenewal in interface ProtocolJavaFunctionKrmsTermService

Returns:

isSubmitUserProtocolPi

public Boolean isSubmitUserProtocolPi(ProtocolBase protocol,
                             String submitUserId)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the submit user is the PI of the protocol.

Specified by:

isSubmitUserProtocolPi in interface ProtocolJavaFunctionKrmsTermService

Returns:

isLeadUnitProtocolCampus

public Boolean isLeadUnitProtocolCampus(ProtocolBase protocol,
                               String campusCode)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the lead unit of the ProtocolBase belong to campus

Specified by:

isLeadUnitProtocolCampus in interface ProtocolJavaFunctionKrmsTermService

Returns:

isProtocolRenewalWithAmendment

public Boolean isProtocolRenewalWithAmendment(ProtocolBase protocol)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol is renewal with amendment

Specified by:

isProtocolRenewalWithAmendment in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasProtocolContainsDocumentType

public Boolean hasProtocolContainsDocumentType(ProtocolBase protocol,
                                      String documentTypeCode)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if any of the protocol document type is the specified document type

Specified by:

hasProtocolContainsDocumentType in interface ProtocolJavaFunctionKrmsTermService

Returns:

isProtocolInSubmission

public Boolean isProtocolInSubmission(ProtocolBase protocol,
                             String submissionTypeCode)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the protocol is in the specified submission

Specified by:

isProtocolInSubmission in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasProtocolContainsNotifySubmissionQualifierType

public Boolean hasProtocolContainsNotifySubmissionQualifierType(ProtocolBase protocol,
                                                       Integer submissionNumber,
                                                       String submissionQualifierTypeCode)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the selected submission qualifier type is a specified type

Specified by:

hasProtocolContainsNotifySubmissionQualifierType in interface ProtocolJavaFunctionKrmsTermService

Returns:

hasSubmissionType

public Boolean hasSubmissionType(ProtocolBase protocol,
                        Integer submissionNumber,
                        String submissionTypeCode)

Description copied from interface: ProtocolJavaFunctionKrmsTermService

This method check if the selected submission type is a specified type

Specified by:

hasSubmissionType in interface ProtocolJavaFunctionKrmsTermService

Returns:

getKcPersonService

public KcPersonService getKcPersonService()

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)