org.kuali.kra.coi.disclosure

Interface CoiDisclosureService

All Known Implementing Classes:

CoiDisclosureServiceImpl

public interface CoiDisclosureService

Method Summary

Methods

Modifier and Type	Method and Description
void	addDisclosureReporterUnit(DisclosureReporter disclosureReporter, DisclosureReporterUnit newDisclosureReporterUnit) This method is to add a disclosure reporter unit
CoiDispositionStatus	calculateMaximumDispositionStatus(CoiDisclosure coiDisclosure) Loops through all projects and financial entities and sets the project disclosure to the maximum disposition in that project and returns the maximum disposition status from the disclosure.
Integer	calculateMaximumDispositionStatusCode(CoiDisclosure coiDisclosure)
boolean	checkScreeningQuestionnaireRule(CoiDisclosureDocument coiDisclosureDocument) Check the KRMS rule designated in KRMS_SCREENING_QUESTIONNAIRE_RULE to see if the screening questionnaire rule has passed or not.
void	createDisclosuresGroupedByEvent(MasterDisclosureBean masterDisclosureBean) This method is to group all disclosures by event
void	createDisclosuresGroupedByFinancialEntity(CoiDisclosure coiDisclosure, MasterDisclosureBean masterDisclosureBean) This method is to group all project disclosures by financial entity
void	deleteDisclosureReporterUnit(DisclosureReporter disclosureReporter, List<? extends DisclosureReporterUnit> deletedUnits, int unitIndex) This method is to delete a disclosure reporter unit
List<CoiDisclosure>	getAllDisclosuresForUser(String userId) return a list of all disclosures for the given user
List<Award>	getAwards(String personId) This method is to get a list of Award that need coi disclosure
CoiDisclosure	getCurrentDisclosure()
DisclosurePerson	getDisclosureReporter(String personId, Long coiDisclosureId) This method is to get disclosure reporter when initiate a new disclosure.
List<CoiDispositionStatus>	getDispositionStatuses(String disclosureStatusCode)
List<IacucProtocol>	getIacucProtocols(String personId) This method is to get a list of protocols that need coi disclosure
List<InstitutionalProposal>	getInstitutionalProposals(String personId) This method is to get a list of Institutional Proposal that need coi disclosure
MasterDisclosureBean	getMasterDisclosureDetail(CoiDisclosure coiDisclosure) This method is to set up form bean to display master disclosure projects
List<DevelopmentProposal>	getProposals(String personId) This method is to get a list of PD that need coi disclosure
List<Protocol>	getProtocols(String personId) This method is to get a list of protocols that need coi disclosure
List<CoiDisclosureUndisclosedEvents>	getUndisclosedEvents(Map<String,String> searchCriteria) This method is to get a list of undisclosed events from all projects based on search criteria.
List<CoiGroupedMasterDisclosureBean>	getUndisclosedProjectsGroupedByEvent(List<CoiDisclProject> coiDisclProjects) This method is to group undisclosed projects by event type
List<CoiGroupedMasterDisclosureBean>	getUndisclosedProjectsGroupedByFinancialEntity(List<CoiDisclProject> coiDisclProjects) This method is to group undisclosed projects by financial entity
void	initDisclosureFromMasterDisclosure(CoiDisclosure coiDisclosure)
void	initializeDisclosureDetails(CoiDisclosure coiDisclosure) This method is for annual disclosure to populate all FE to projects eligible for disclosure
void	initializeDisclosureDetails(CoiDisclProject coiDisclProject) This method is to initialize disclosure FE for manual project
void	initializeDisclosureProject(CoiDisclosure coiDisclosure, String projectId) This method sets up a disclosure project and its corresponding details
boolean	isReporter() This method is to check whether this user has active projects to disclose
void	populateProposalsAndAwardToCompleteDisclosure(String userId, DisclosureHelper disclosureHelper)
void	resetLeadUnit(DisclosureReporter disclosureReporter) This method is to reset the lead unit if there is lead unit change
boolean	setDisclProjectForSave(CoiDisclosure coiDisclosure, MasterDisclosureBean masterDisclosureBean) This method sets up the disclosure projects and details for save
void	updateDisclosureAndProjectDisposition(CoiDisclosure coiDisclosure)
void	updateDisclosureDetails(CoiDisclProject coiDisclProject) This method is to update disclosure FE for manual project.
CoiDisclosure	versionCoiDisclosure() This method is to create new version of COI disclosure if there is disclosure exist for the reporter

Method Detail

getDisclosureReporter

DisclosurePerson getDisclosureReporter(String personId,
                                     Long coiDisclosureId)

This method is to get disclosure reporter when initiate a new disclosure.

Parameters:

personId -

coiDisclosureId -

Returns:

addDisclosureReporterUnit

void addDisclosureReporterUnit(DisclosureReporter disclosureReporter,
                             DisclosureReporterUnit newDisclosureReporterUnit)

This method is to add a disclosure reporter unit

Parameters:

disclosureReporter -

newDisclosureReporterUnit -

deleteDisclosureReporterUnit

void deleteDisclosureReporterUnit(DisclosureReporter disclosureReporter,
                                List<? extends DisclosureReporterUnit> deletedUnits,
                                int unitIndex)

This method is to delete a disclosure reporter unit

Parameters:

disclosureReporter -

deletedUnits -

unitIndex -

resetLeadUnit

void resetLeadUnit(DisclosureReporter disclosureReporter)

This method is to reset the lead unit if there is lead unit change

Parameters:

disclosureReporter -

initializeDisclosureDetails

void initializeDisclosureDetails(CoiDisclosure coiDisclosure)

This method is for annual disclosure to populate all FE to projects eligible for disclosure

Parameters:

coiDisclosure -

initializeDisclosureDetails

void initializeDisclosureDetails(CoiDisclProject coiDisclProject)

This method is to initialize disclosure FE for manual project

Parameters:

coiDisclProject -

updateDisclosureDetails

void updateDisclosureDetails(CoiDisclProject coiDisclProject)

This method is to update disclosure FE for manual project.

Parameters:

coiDisclProject -

versionCoiDisclosure

CoiDisclosure versionCoiDisclosure()
                                   throws VersionException

This method is to create new version of COI disclosure if there is disclosure exist for the reporter

Returns:

Throws:

VersionException

getProtocols

List<Protocol> getProtocols(String personId)

This method is to get a list of protocols that need coi disclosure

Parameters:

personId -

Returns:

getIacucProtocols

List<IacucProtocol> getIacucProtocols(String personId)

This method is to get a list of protocols that need coi disclosure

Parameters:

personId -

Returns:

getProposals

List<DevelopmentProposal> getProposals(String personId)

This method is to get a list of PD that need coi disclosure

Parameters:

personId -

Returns:

getAwards

List<Award> getAwards(String personId)

This method is to get a list of Award that need coi disclosure

Parameters:

personId -

Returns:

getInstitutionalProposals

List<InstitutionalProposal> getInstitutionalProposals(String personId)

This method is to get a list of Institutional Proposal that need coi disclosure

Parameters:

personId -

Returns:

isReporter

boolean isReporter()

This method is to check whether this user has active projects to disclose

Returns:

getMasterDisclosureDetail

MasterDisclosureBean getMasterDisclosureDetail(CoiDisclosure coiDisclosure)

This method is to set up form bean to display master disclosure projects

Parameters:

coiDisclosure -

Returns:

getDispositionStatuses

List<CoiDispositionStatus> getDispositionStatuses(String disclosureStatusCode)

initDisclosureFromMasterDisclosure

void initDisclosureFromMasterDisclosure(CoiDisclosure coiDisclosure)

initializeDisclosureProject

void initializeDisclosureProject(CoiDisclosure coiDisclosure,
                               String projectId)

This method sets up a disclosure project and its corresponding details

Parameters:

coiDisclosure -

projectId -

setDisclProjectForSave

boolean setDisclProjectForSave(CoiDisclosure coiDisclosure,
                             MasterDisclosureBean masterDisclosureBean)

This method sets up the disclosure projects and details for save

Parameters:

coiDisclosure -

masterDisclosureBean -

getCurrentDisclosure

CoiDisclosure getCurrentDisclosure()

populateProposalsAndAwardToCompleteDisclosure

void populateProposalsAndAwardToCompleteDisclosure(String userId,
                                                 DisclosureHelper disclosureHelper)

createDisclosuresGroupedByFinancialEntity

void createDisclosuresGroupedByFinancialEntity(CoiDisclosure coiDisclosure,
                                             MasterDisclosureBean masterDisclosureBean)

This method is to group all project disclosures by financial entity

Parameters:

coiDisclosure -

masterDisclosureBean -

createDisclosuresGroupedByEvent

void createDisclosuresGroupedByEvent(MasterDisclosureBean masterDisclosureBean)

This method is to group all disclosures by event

Parameters:

masterDisclosureBean -

getAllDisclosuresForUser

List<CoiDisclosure> getAllDisclosuresForUser(String userId)

return a list of all disclosures for the given user

checkScreeningQuestionnaireRule

boolean checkScreeningQuestionnaireRule(CoiDisclosureDocument coiDisclosureDocument)

Check the KRMS rule designated in KRMS_SCREENING_QUESTIONNAIRE_RULE to see if the screening questionnaire rule has passed or not.

Returns:

getUndisclosedEvents

List<CoiDisclosureUndisclosedEvents> getUndisclosedEvents(Map<String,String> searchCriteria)

This method is to get a list of undisclosed events from all projects based on search criteria.

Parameters:

searchCriteria -

Returns:

calculateMaximumDispositionStatus

CoiDispositionStatus calculateMaximumDispositionStatus(CoiDisclosure coiDisclosure)

Loops through all projects and financial entities and sets the project disclosure to the maximum disposition in that project and returns the maximum disposition status from the disclosure. Returns in progress when the disclosure is in progress and not conflict exists when no financial entities exist.

Parameters:

coiDisclosure -

Returns:

calculateMaximumDispositionStatusCode

Integer calculateMaximumDispositionStatusCode(CoiDisclosure coiDisclosure)

updateDisclosureAndProjectDisposition

void updateDisclosureAndProjectDisposition(CoiDisclosure coiDisclosure)

getUndisclosedProjectsGroupedByEvent

List<CoiGroupedMasterDisclosureBean> getUndisclosedProjectsGroupedByEvent(List<CoiDisclProject> coiDisclProjects)

This method is to group undisclosed projects by event type

Parameters:

coiDisclProjects -

Returns:

getUndisclosedProjectsGroupedByFinancialEntity

List<CoiGroupedMasterDisclosureBean> getUndisclosedProjectsGroupedByFinancialEntity(List<CoiDisclProject> coiDisclProjects)

This method is to group undisclosed projects by financial entity

Parameters:

coiDisclProjects -

Returns: