org.kuali.kra.proposaldevelopment.service.impl

Class PropDevJavaFunctionKrmsTermServiceImpl

java.lang.Object

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

org.kuali.kra.proposaldevelopment.service.impl.PropDevJavaFunctionKrmsTermServiceImpl

All Implemented Interfaces:

PropDevJavaFunctionKrmsTermService

public class PropDevJavaFunctionKrmsTermServiceImpl
extends KcKrmsJavaFunctionTermServiceBase
implements PropDevJavaFunctionKrmsTermService

Field Summary

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

FALSE, restrictedElements, TRUE

Constructor Summary

Constructors

Constructor and Description
PropDevJavaFunctionKrmsTermServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	activityTypeRule(DevelopmentProposal developmentProposal, String activityTypeCode)
String	agencyProgramCodeNullRule(DevelopmentProposal developmentProposal) This method is a rule to CHECK IF a proposal's agency program code field is null See fn_ag_progcode_is_null_rule
String	allProposalsRule(DevelopmentProposal developmentProposal) This method returns 'true', and is implemented because the original function existed.
String	attachmentFileNameRule(DevelopmentProposal developmentProposal)
String	biosketchFileNameRule(DevelopmentProposal developmentProposal) This method checks to see if the biosketch file names contain any restricted special characters.
String	budgetSubawardOrganizationnameRule(DevelopmentProposal developmentProposal) This method is used to check if a budget sub award organization name contains special characters.
String	checkProposalCoiRule(DevelopmentProposal developmentProposal, String principalId)
String	checkProposalPerson(DevelopmentProposal developmentProposal, String personId) This method is used to check if the passed in personId, is among the proposal people.
String	checkProposalPiRule(DevelopmentProposal developmentProposal, String principalId)
String	costElement(DevelopmentProposal developmentProposal, String costElement)
String	costElementInVersion(DevelopmentProposal developmentProposal, String versionNumber, String costElement) This method is used to verify that a cost element is used in the specified version of the proposal.
String	costElementVersionLimit(DevelopmentProposal developmentProposal, String versionNumber, String costElementName, String limit) This method is used to check if , in any period of the given version of budget, the given cost element has crossed the given limit or not.
String	divisionCodeIsFellowship(DevelopmentProposal developmentProposal, String fellowshipCodes) This method is used to CHECK IF THIS PROPOSAL IS FOR A FELLOWSHIP.
String	divisionCodeRule(DevelopmentProposal developmentProposal) This method is used to CHECK IF a proposal's division code field is null See fn_agency_divcode_is_null_rule
protected Budget	getBudgetVersion(DevelopmentProposal developmentProposal, String versionNumber)
String	grantsFormRule(DevelopmentProposal developmentProposal, String formName) This method checks if the proposal is associated the grants form passed in.
String	incompleteNarrativeRule(DevelopmentProposal developmentProposal)
String	investigatorKeyPersonCertificationRule(DevelopmentProposal developmentProposal) This method is used to verify that each investigator and key person are certified See FN_IS_EPS_PROP_INVKEY_CERT
String	leadUnitBelowRule(DevelopmentProposal developmentProposal, String unitNumber)
String	leadUnitRule(DevelopmentProposal developmentProposal, String unitNumber)
String	monitoredSponsorRule(DevelopmentProposal developmentProposal, String monitoredSponsorHirearchies) This method checks if the proposal is associated with one of monitored sponsored hierarchies.
String	mtdcDeviation(DevelopmentProposal developmentProposal)
protected boolean	mtdcDeviationInBudget(Budget budget)
String	mtdcDeviationInVersion(DevelopmentProposal developmentProposal, String versionNumber)
String	multiplePI(DevelopmentProposal developmentProposal) This method checks if the proposal has multiple PIs set.
String	narrativeFileName(DevelopmentProposal developmentProposal) This method is used to verify no special characters are used.
String	narrativeTypeRule(DevelopmentProposal developmentProposal, String narrativeTypeCode) This method verifies that the activity type is specified.
String	nonFacultyPi(DevelopmentProposal developmentProposal)
String	ospAdminPropPersonRule(DevelopmentProposal developmentProposal) This method checks to see if the OSP administrator is also a personal person.
String	proposalAwardTypeRule(DevelopmentProposal developmentProposal, Integer awardTypeCode)
String	proposalGrantsRule(DevelopmentProposal developmentProposal) This method verifies that there are grans.gov submissions.
String	proposalLeadUnitInHierarchy(DevelopmentProposal developmentProposal, String unitNumberToCheck) This method checks to see if the proposal lead unit is in the unit hierarchy of the passed in unit.
String	proposalTypeRule(DevelopmentProposal developmentProposal, String proposalTypeCode)
String	proposalUnitRule(DevelopmentProposal developmentProposal, String unitNumber)
String	s2s398CoverRule(DevelopmentProposal developmentProposal, String PHSCoverLetters, String narrativeTypeCode) This method is used to verify PHS Cover letter narrative(39) is attached, must include s2s cover letter form.
String	s2sAttachmentNarrativeRule(DevelopmentProposal developmentProposal)
String	s2sBudgetRule(DevelopmentProposal developmentProposal, String formNames) This method checks if the passed in forms are included.
String	s2sExemptionRule(DevelopmentProposal developmentProposal)
String	s2sFederalIdRule(DevelopmentProposal developmentProposal)
String	s2sLeadershipRule(DevelopmentProposal developmentProposal)
String	s2sModularBudgetRule(DevelopmentProposal developmentProposal)
String	s2sResplanRule(DevelopmentProposal developmentProposal, String narativeTypes, String maxNumber) This method determines if the proposal has more than the maximum number of attachments of the types provided in the narativeTypes list.
String	s2sSubawardRule(DevelopmentProposal developmentProposal, String rrFormNames, String phsFromNames) This method verifies that there is not both a restricted set of RR forms along with PHS forms.
String	specialReviewRule(DevelopmentProposal developmentProposal, String specialReviewTypeCode)
Boolean	specifiedGGForm(DevelopmentProposal developmentProposal, String formNames) This method checks if the formName is included in the given proposal
String	sponsor(DevelopmentProposal developmentProposal, String sponsorCode)
String	sponsorGroupRule(DevelopmentProposal developmentProposal, String sponsorGroup)
String	sponsorTypeRule(DevelopmentProposal developmentProposal, String sponsorTypeCode)

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

PropDevJavaFunctionKrmsTermServiceImpl

public PropDevJavaFunctionKrmsTermServiceImpl()

Method Detail

specifiedGGForm

public Boolean specifiedGGForm(DevelopmentProposal developmentProposal,
                      String formNames)

This method checks if the formName is included in the given proposal

Specified by:

specifiedGGForm in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if true

multiplePI

public String multiplePI(DevelopmentProposal developmentProposal)

This method checks if the proposal has multiple PIs set. see FN_MULTIPI_RULE.

Specified by:

multiplePI in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if true

s2sBudgetRule

public String s2sBudgetRule(DevelopmentProposal developmentProposal,
                   String formNames)

This method checks if the passed in forms are included. see FN_S2S_BUDGET_RULE.

Specified by:

s2sBudgetRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

formName - a comma delimited list of s2s forms to check against.

Returns:

'true' if true

monitoredSponsorRule

public String monitoredSponsorRule(DevelopmentProposal developmentProposal,
                          String monitoredSponsorHirearchies)

This method checks if the proposal is associated with one of monitored sponsored hierarchies. see FN_COI_MONITORED_SPONSOR_RULE.

Specified by:

monitoredSponsorRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

monitoredSponsorHirearchies - a comma delimited list of sponsored hirearchies.

Returns:

'true' if true

s2sResplanRule

public String s2sResplanRule(DevelopmentProposal developmentProposal,
                    String narativeTypes,
                    String maxNumber)

This method determines if the proposal has more than the maximum number of attachments of the types provided in the narativeTypes list. see FN_S2S_RESPLAN_RULE.

Specified by:

s2sResplanRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal. -

narativeTypes - a comma delimited list of narrative types.

maxNumber - the maximum number to check.

Returns:

'true' if true

grantsFormRule

public String grantsFormRule(DevelopmentProposal developmentProposal,
                    String formName)

This method checks if the proposal is associated the grants form passed in. see FN_GG_FORM_RULE.

Specified by:

grantsFormRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

formName - the grants form to check against.

Returns:

'true' if true

biosketchFileNameRule

public String biosketchFileNameRule(DevelopmentProposal developmentProposal)

This method checks to see if the biosketch file names contain any restricted special characters. See fn_prop_pers_att_name_rule

Specified by:

biosketchFileNameRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if no special characters are found.

ospAdminPropPersonRule

public String ospAdminPropPersonRule(DevelopmentProposal developmentProposal)

This method checks to see if the OSP administrator is also a personal person. See FN_OSP_ADMIN_IS_PERSON

Specified by:

ospAdminPropPersonRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if the OSP admin is also a proposal person, otherwise 'false'

costElementVersionLimit

public String costElementVersionLimit(DevelopmentProposal developmentProposal,
                             String versionNumber,
                             String costElementName,
                             String limit)

This method is used to check if , in any period of the given version of budget, the given cost element has crossed the given limit or not. See fn_cost_element_ver_per_limit AND fn_cost_element_limit_in_ver

Specified by:

costElementVersionLimit in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

versionNumber - the version number to be checked

costElementName - the cost element to be checked

limit - the amount limit to be checked

Returns:

'true' - if the total cost of the CE crossed the limit in any one of the period, otherwise 'false'

divisionCodeRule

public String divisionCodeRule(DevelopmentProposal developmentProposal)

This method is used to CHECK IF a proposal's division code field is null See fn_agency_divcode_is_null_rule

Specified by:

divisionCodeRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' - if the division field is null, otherwise return false.

divisionCodeIsFellowship

public String divisionCodeIsFellowship(DevelopmentProposal developmentProposal,
                              String fellowshipCodes)

This method is used to CHECK IF THIS PROPOSAL IS FOR A FELLOWSHIP. Typically 3 or 7 is a fellowship code. See FN_IS_FELLOWSHIP

Specified by:

divisionCodeIsFellowship in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' - if the division field is a fellowship code, otherwise return false.

budgetSubawardOrganizationnameRule

public String budgetSubawardOrganizationnameRule(DevelopmentProposal developmentProposal)

This method is used to check if a budget sub award organization name contains special characters. See fn_sub_awd_org_name_rule

Specified by:

budgetSubawardOrganizationnameRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' - if it does not contain special characters. If it does have special characters, otherwise returns 'false'.

checkProposalPerson

public String checkProposalPerson(DevelopmentProposal developmentProposal,
                         String personId)

This method is used to check if the passed in personId, is among the proposal people. See FN_CHECK_PROPOSAL_KEY_PERSON

Specified by:

checkProposalPerson in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' - if the logged in user is a proposal person, otherwise returns 'false'.

agencyProgramCodeNullRule

public String agencyProgramCodeNullRule(DevelopmentProposal developmentProposal)

This method is a rule to CHECK IF a proposal's agency program code field is null See fn_ag_progcode_is_null_rule

Specified by:

agencyProgramCodeNullRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' - if the agency program code is NULL, otherwise returns 'false'.

allProposalsRule

public String allProposalsRule(DevelopmentProposal developmentProposal)

This method returns 'true', and is implemented because the original function existed. See FN_ALL_PROPOSALS_RULE

Specified by:

allProposalsRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' always

proposalLeadUnitInHierarchy

public String proposalLeadUnitInHierarchy(DevelopmentProposal developmentProposal,
                                 String unitNumberToCheck)

This method checks to see if the proposal lead unit is in the unit hierarchy of the passed in unit. See FN_LEAD_UNIT_BELOW

Specified by:

proposalLeadUnitInHierarchy in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

unitNumberToCheck -

Returns:

'true' if the lead unit is in the unit hiearchy of the passed in unit, otherwise returns 'false'.

s2sSubawardRule

public String s2sSubawardRule(DevelopmentProposal developmentProposal,
                     String rrFormNames,
                     String phsFromNames)

This method verifies that there is not both a restricted set of RR forms along with PHS forms. See FN_S2S_SUBAWARD_RULE

Specified by:

s2sSubawardRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

rrFormNames -

phsFromNames -

Returns:

'true' if there are RR forms and PHS forms, otherwise returns 'false'.

proposalGrantsRule

public String proposalGrantsRule(DevelopmentProposal developmentProposal)

This method verifies that there are grans.gov submissions. See FN_IS_GG_RULE

Specified by:

proposalGrantsRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if there are grants.gov submssion, otherwise returns 'false'.

narrativeTypeRule

public String narrativeTypeRule(DevelopmentProposal developmentProposal,
                       String narrativeTypeCode)

This method verifies that the activity type is specified. See FN_NARRATIVE_TYPE_RULE

Specified by:

narrativeTypeRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if there an activity type, otherwise returns 'false'.

activityTypeRule

public String activityTypeRule(DevelopmentProposal developmentProposal,
                      String activityTypeCode)

Specified by:

activityTypeRule in interface PropDevJavaFunctionKrmsTermService

attachmentFileNameRule

public String attachmentFileNameRule(DevelopmentProposal developmentProposal)

Specified by:

attachmentFileNameRule in interface PropDevJavaFunctionKrmsTermService

checkProposalCoiRule

public String checkProposalCoiRule(DevelopmentProposal developmentProposal,
                          String principalId)

Specified by:

checkProposalCoiRule in interface PropDevJavaFunctionKrmsTermService

checkProposalPiRule

public String checkProposalPiRule(DevelopmentProposal developmentProposal,
                         String principalId)

Specified by:

checkProposalPiRule in interface PropDevJavaFunctionKrmsTermService

costElement

public String costElement(DevelopmentProposal developmentProposal,
                 String costElement)

Specified by:

costElement in interface PropDevJavaFunctionKrmsTermService

leadUnitBelowRule

public String leadUnitBelowRule(DevelopmentProposal developmentProposal,
                       String unitNumber)

Specified by:

leadUnitBelowRule in interface PropDevJavaFunctionKrmsTermService

leadUnitRule

public String leadUnitRule(DevelopmentProposal developmentProposal,
                  String unitNumber)

Specified by:

leadUnitRule in interface PropDevJavaFunctionKrmsTermService

mtdcDeviation

public String mtdcDeviation(DevelopmentProposal developmentProposal)

Specified by:

mtdcDeviation in interface PropDevJavaFunctionKrmsTermService

mtdcDeviationInVersion

public String mtdcDeviationInVersion(DevelopmentProposal developmentProposal,
                            String versionNumber)

Specified by:

mtdcDeviationInVersion in interface PropDevJavaFunctionKrmsTermService

getBudgetVersion

protected Budget getBudgetVersion(DevelopmentProposal developmentProposal,
                      String versionNumber)

mtdcDeviationInBudget

protected boolean mtdcDeviationInBudget(Budget budget)

nonFacultyPi

public String nonFacultyPi(DevelopmentProposal developmentProposal)

Specified by:

nonFacultyPi in interface PropDevJavaFunctionKrmsTermService

proposalAwardTypeRule

public String proposalAwardTypeRule(DevelopmentProposal developmentProposal,
                           Integer awardTypeCode)

Specified by:

proposalAwardTypeRule in interface PropDevJavaFunctionKrmsTermService

proposalTypeRule

public String proposalTypeRule(DevelopmentProposal developmentProposal,
                      String proposalTypeCode)

Specified by:

proposalTypeRule in interface PropDevJavaFunctionKrmsTermService

proposalUnitRule

public String proposalUnitRule(DevelopmentProposal developmentProposal,
                      String unitNumber)

Specified by:

proposalUnitRule in interface PropDevJavaFunctionKrmsTermService

s2sAttachmentNarrativeRule

public String s2sAttachmentNarrativeRule(DevelopmentProposal developmentProposal)

Specified by:

s2sAttachmentNarrativeRule in interface PropDevJavaFunctionKrmsTermService

s2sExemptionRule

public String s2sExemptionRule(DevelopmentProposal developmentProposal)

Specified by:

s2sExemptionRule in interface PropDevJavaFunctionKrmsTermService

s2sFederalIdRule

public String s2sFederalIdRule(DevelopmentProposal developmentProposal)

Specified by:

s2sFederalIdRule in interface PropDevJavaFunctionKrmsTermService

s2sLeadershipRule

public String s2sLeadershipRule(DevelopmentProposal developmentProposal)

Specified by:

s2sLeadershipRule in interface PropDevJavaFunctionKrmsTermService

s2sModularBudgetRule

public String s2sModularBudgetRule(DevelopmentProposal developmentProposal)

Specified by:

s2sModularBudgetRule in interface PropDevJavaFunctionKrmsTermService

specialReviewRule

public String specialReviewRule(DevelopmentProposal developmentProposal,
                       String specialReviewTypeCode)

Specified by:

specialReviewRule in interface PropDevJavaFunctionKrmsTermService

sponsor

public String sponsor(DevelopmentProposal developmentProposal,
             String sponsorCode)

Specified by:

sponsor in interface PropDevJavaFunctionKrmsTermService

sponsorGroupRule

public String sponsorGroupRule(DevelopmentProposal developmentProposal,
                      String sponsorGroup)

Specified by:

sponsorGroupRule in interface PropDevJavaFunctionKrmsTermService

s2s398CoverRule

public String s2s398CoverRule(DevelopmentProposal developmentProposal,
                     String PHSCoverLetters,
                     String narrativeTypeCode)

This method is used to verify PHS Cover letter narrative(39) is attached, must include s2s cover letter form. See FN_S2S_398COVER_RULE

Specified by:

s2s398CoverRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

PHSCoverLetters - PHS Cover letter names, comma separated list

narrativeTypeCode - The narrative type code to check.

Returns:

'false' if the passed in narrative type is used, and a PHS cover letter is not attached, otherwise returns 'true'

narrativeFileName

public String narrativeFileName(DevelopmentProposal developmentProposal)

This method is used to verify no special characters are used. See fn_narrative_file_name_rule

Specified by:

narrativeFileName in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'false' if there is a special character in the file name, otherwise returns 'true'

costElementInVersion

public String costElementInVersion(DevelopmentProposal developmentProposal,
                          String versionNumber,
                          String costElement)

This method is used to verify that a cost element is used in the specified version of the proposal. See fn_cost_element_in_version

Specified by:

costElementInVersion in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

versionNumber -

costElement -

Returns:

'false' if the cost element is not in the version of the proposal, otherwise returns 'true'

investigatorKeyPersonCertificationRule

public String investigatorKeyPersonCertificationRule(DevelopmentProposal developmentProposal)

This method is used to verify that each investigator and key person are certified See FN_IS_EPS_PROP_INVKEY_CERT

Specified by:

investigatorKeyPersonCertificationRule in interface PropDevJavaFunctionKrmsTermService

Parameters:

developmentProposal -

Returns:

'true' if all the investigators and key person have completed their questionaires, otherwise return 'false'

sponsorTypeRule

public String sponsorTypeRule(DevelopmentProposal developmentProposal,
                     String sponsorTypeCode)

Specified by:

sponsorTypeRule in interface PropDevJavaFunctionKrmsTermService

incompleteNarrativeRule

public String incompleteNarrativeRule(DevelopmentProposal developmentProposal)

Specified by:

incompleteNarrativeRule in interface PropDevJavaFunctionKrmsTermService