org.kuali.kra.s2s.service

Interface S2SUtilService

All Known Implementing Classes:

S2SUtilServiceImpl

public interface S2SUtilService

This class is for maintaining all reusable components that are part of S2S module.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Method Summary

Methods

Modifier and Type	Method and Description
Calendar	convertDateStringToCalendar(String dateStr) This method returns a Calendar whose date matches the date passed as String
Calendar	convertDateToCalendar(Date date) This method is used to get Calendar date
String	convertStringArrayToString(String[] stringArray) This method converts String objects in the String array into a String separated by commas and returns it.
String	convertStringListToString(List<String> stringList) Converts String objects in a list into a String separated by commas
void	deleteSystemGeneratedAttachments(ProposalDevelopmentDocument pdDoc) This method is used to delete all auto generated pdfs as part of s2s forms creation
CitizenshipTypes	getCitizenship(ProposalPerson proposalPerson) This method is used to get the citizenship from either warehouse or from person custom element
String	getCognizantFedAgency(DevelopmentProposal developmentProposal) This method gets the Federal Agency for the given DevelopmentProposal
List<ProposalPerson>	getCoInvestigators(ProposalDevelopmentDocument pdDoc) Finds all the co-investigators associated with the provided pdDoc.
DepartmentalPerson	getContactPerson(ProposalDevelopmentDocument pdDoc) This method is used to get the details of Contact person
org.kuali.rice.location.api.country.Country	getCountryFromCode(String countryCode) Finds a Country object from the country code
Calendar	getCurrentCalendar() This method is used to get current Calendar
DepartmentalPerson	getDepartmentalPerson(ProposalDevelopmentDocument pdDoc) This method populates and returns the Departmental Person object for a given proposal document
String	getDivisionName(ProposalDevelopmentDocument pdDoc) This method is to get division name using the OwnedByUnit and traversing through the parent units till the top level
Map<String,String>	getEOStateReview(ProposalDevelopmentDocument pdDoc) This method returns a map containing the answers related to EOState REview for a given proposal
String	getFederalId(ProposalDevelopmentDocument proposalDevelopmentDocument) This method returns the Federal ID for a given proposal
String	getGgTrackingIdFromProposal(InstitutionalProposal proposal) Get the tracking id from the newest development proposal linked to the institutional proposal.
List<ProposalPerson>	getKeyPersons(ProposalDevelopmentDocument pdDoc) Finds all the key Person associated with the provided pdDoc.
List<ProposalPerson>	getNKeyPersons(List<ProposalPerson> keyPersons, boolean firstN, int n) This method limits the number of key persons to n, returns list of key persons, first n in case firstN is true, or all other than first n, in case of firstN being false
BudgetDecimal	getNumberOfMonths(Date dateStart, Date dateEnd)
String	getParameterValue(String parameter) This method fetches system constant parameters
ProposalPerson	getPrincipalInvestigator(ProposalDevelopmentDocument pdDoc) This method is to get PrincipalInvestigator from person list
String	getProperty(String key) This method is used to get the property from configuration file.
List<Answer>	getQuestionnaireAnswers(DevelopmentProposal developmentProposal, String namespace, String formname) Finds all the Questionnaire Answers associates with provided ProposalNumber and questionnaireId.
List<Answer>	getQuestionnaireAnswersForPI(ProposalDevelopmentDocument pdDoc) This method gets the answers from a questionnaire for a proposal person.
org.kuali.rice.location.api.state.State	getStateFromName(String countryAlternateCode, String stateName) Finds a State object from the state name
Map<String,String>	getSubmissionType(ProposalDevelopmentDocument pdDoc) This method creates and returns Map of submission details like submission type, description and Revision code
boolean	keyPersonEqualsBudgetPerson(KeyPersonInfo keyPersonInfo, BudgetPersonnelDetails budgetPersonnelDetails) This method compares a key person with budget person.
boolean	proposalPersonEqualsBudgetPerson(ProposalPerson proposalPerson, BudgetPersonnelDetails budgetPersonnelDetails) This method compares a proposal person with budget person.
String	removeTimezoneFactor(String applicationXmlText)

Method Detail

getSubmissionType

Map<String,String> getSubmissionType(ProposalDevelopmentDocument pdDoc)

This method creates and returns Map of submission details like submission type, description and Revision code

Parameters:

pdDoc - Proposal Development Document.

Returns:

Map Map of submission details.

getDepartmentalPerson

DepartmentalPerson getDepartmentalPerson(ProposalDevelopmentDocument pdDoc)

This method populates and returns the Departmental Person object for a given proposal document

Parameters:

pdDoc - Proposal Development Document.

Returns:

DepartmentalPerson departmental Person object for a given proposal document.

getEOStateReview

Map<String,String> getEOStateReview(ProposalDevelopmentDocument pdDoc)

This method returns a map containing the answers related to EOState REview for a given proposal

Parameters:

pdDoc - Proposal Development Document.

Returns:

Map map containing the answers related to EOState Review for a given proposal.

getNKeyPersons

List<ProposalPerson> getNKeyPersons(List<ProposalPerson> keyPersons,
                                  boolean firstN,
                                  int n)

This method limits the number of key persons to n, returns list of key persons, first n in case firstN is true, or all other than first n, in case of firstN being false

Parameters:

keyPersons - list of ProposalPerson

firstN - value that determines whether the returned list should contain first n persons or the rest of persons

n - number of key persons that are considered as not extra persons

Returns:

list of ProposalPerson

getFederalId

String getFederalId(ProposalDevelopmentDocument proposalDevelopmentDocument)

This method returns the Federal ID for a given proposal

Parameters:

proposalDevelopmentDocument - Proposal Development Document.

Returns:

Federal ID for a given proposal.

getGgTrackingIdFromProposal

String getGgTrackingIdFromProposal(InstitutionalProposal proposal)

Get the tracking id from the newest development proposal linked to the institutional proposal.

Parameters:

proposal -

Returns:

getParameterValue

String getParameterValue(String parameter)

This method fetches system constant parameters

Parameters:

parameter - String for which value must be fetched

Returns:

String System constant parameters.

convertDateStringToCalendar

Calendar convertDateStringToCalendar(String dateStr)

This method returns a Calendar whose date matches the date passed as String

Parameters:

dateStr - string for which the Calendar value has to be found.

Returns:

Calendar calendar value corresponding to the date string.

getCurrentCalendar

Calendar getCurrentCalendar()

This method is used to get current Calendar

Returns:

Calendar

convertDateToCalendar

Calendar convertDateToCalendar(Date date)

This method is used to get Calendar date

Parameters:

date(Date) - date for which Calendar value has to be found.

Returns:

cal(Calendar) calendar value corresponding to the date.

getDivisionName

String getDivisionName(ProposalDevelopmentDocument pdDoc)

This method is to get division name using the OwnedByUnit and traversing through the parent units till the top level

Parameters:

pdDoc - Proposal development document.

Returns:

divisionName based on the OwnedByUnit.

getPrincipalInvestigator

ProposalPerson getPrincipalInvestigator(ProposalDevelopmentDocument pdDoc)

This method is to get PrincipalInvestigator from person list

Parameters:

pdDoc - Proposal development document.

Returns:

ProposalPerson PrincipalInvestigator for the proposal.

getCountryFromCode

org.kuali.rice.location.api.country.Country getCountryFromCode(String countryCode)

Finds a Country object from the country code

Parameters:

countryCode - Country name

Returns:

Country object matching the code

getStateFromName

org.kuali.rice.location.api.state.State getStateFromName(String countryAlternateCode,
                                                       String stateName)

Finds a State object from the state name

Parameters:

default - country 3-character code

stateName - Name of the state (two-letter state code)

Returns:

State object matching the name.

proposalPersonEqualsBudgetPerson

boolean proposalPersonEqualsBudgetPerson(ProposalPerson proposalPerson,
                                       BudgetPersonnelDetails budgetPersonnelDetails)

This method compares a proposal person with budget person. It checks whether the proposal person is from PERSON or ROLODEX and matches the respective person ID with the person in BudgetPersonnelDetails

Parameters:

proposalPerson - - key person from proposal

budgetPersonnelDetails - person from BudgetPersonnelDetails

Returns:

true if persons match, false otherwise

keyPersonEqualsBudgetPerson

boolean keyPersonEqualsBudgetPerson(KeyPersonInfo keyPersonInfo,
                                  BudgetPersonnelDetails budgetPersonnelDetails)

This method compares a key person with budget person. It checks whether the key person is from PERSON or ROLODEX and matches the respective person ID with the person in BudgetPersonnelDetails

Parameters:

keyPersonInfo - - key person to compare

budgetPersonnelDetails - person from BudgetPersonnelDetails

Returns:

true if persons match, false otherwise

getProperty

String getProperty(String key)

This method is used to get the property from configuration file. If there is no value defined, it returns defaultValue

Parameters:

key -

Returns:

value

convertStringArrayToString

String convertStringArrayToString(String[] stringArray)

This method converts String objects in the String array into a String separated by commas and returns it.

Parameters:

stringArray -

Returns:

String created from StringArray

convertStringListToString

String convertStringListToString(List<String> stringList)

Converts String objects in a list into a String separated by commas

Parameters:

stringList -

Returns:

getQuestionnaireAnswers

List<Answer> getQuestionnaireAnswers(DevelopmentProposal developmentProposal,
                                   String namespace,
                                   String formname)

Finds all the Questionnaire Answers associates with provided ProposalNumber and questionnaireId.

Parameters:

DevelopmentProposal -

namespace -

formname -

Returns:

List of Questionnaire Answer.

getQuestionnaireAnswersForPI

List<Answer> getQuestionnaireAnswersForPI(ProposalDevelopmentDocument pdDoc)

This method gets the answers from a questionnaire for a proposal person.

Parameters:

pdDoc -

proposalPerson -

Returns:

getCoInvestigators

List<ProposalPerson> getCoInvestigators(ProposalDevelopmentDocument pdDoc)

Finds all the co-investigators associated with the provided pdDoc.

Parameters:

ProposalDevelopmentDocument -

Returns:

List of Co-Investigators ProposalPerson.

getKeyPersons

List<ProposalPerson> getKeyPersons(ProposalDevelopmentDocument pdDoc)

Finds all the key Person associated with the provided pdDoc.

Parameters:

ProposalDevelopmentDocument -

Returns:

List of Key Persons ProposalPerson.

getContactPerson

DepartmentalPerson getContactPerson(ProposalDevelopmentDocument pdDoc)

This method is used to get the details of Contact person

Parameters:

pdDoc(ProposalDevelopmentDocument) - proposal development document.

contactType(String) - for which the DepartmentalPerson has to be found.

Returns:

depPerson(DepartmentalPerson) corresponding to the contact type.

deleteSystemGeneratedAttachments

void deleteSystemGeneratedAttachments(ProposalDevelopmentDocument pdDoc)

This method is used to delete all auto generated pdfs as part of s2s forms creation

Parameters:

ProposalDevelopmentDocument -

getNumberOfMonths

BudgetDecimal getNumberOfMonths(Date dateStart,
                              Date dateEnd)

getCognizantFedAgency

String getCognizantFedAgency(DevelopmentProposal developmentProposal)

This method gets the Federal Agency for the given DevelopmentProposal

Parameters:

pdDoc - Proposal Development Document.

Returns:

String Federal Agency

getCitizenship

CitizenshipTypes getCitizenship(ProposalPerson proposalPerson)

This method is used to get the citizenship from either warehouse or from person custom element

Parameters:

proposalPerson -

Returns:

removeTimezoneFactor

String removeTimezoneFactor(String applicationXmlText)