org.kuali.kra.service

Interface ResearchAreasServiceBase

All Known Subinterfaces:

IacucResearchAreasService, ResearchAreasService

All Known Implementing Classes:

IacucResearchAreasServiceImpl, ResearchAreasServiceBaseImpl, ResearchAreasServiceImpl

public interface ResearchAreasServiceBase

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkResearchAreaAndDescendantsNotReferenced(String researchAreaCode) This method checks that neither the given research area nor any of its descendants are referenced by any committee, committee member or protocol (current or past).
void	deactivateResearchAreaAndDescendants(String researchAreaCode) This method will deactivate the research area that has the given researchAreaCode, and will also recursively deactivate all of its descendant research areas as well.
void	deleteResearchAreaAndDescendants(String researchAreaCode) This method will delete the research area that has the given researchAreaCode and will also recursively delete all of its descendant research areas as well.
ResearchAreaCurrentReferencerHolderBase	getAnyCurrentReferencerForResearchAreaOrDescendant(String researchAreaCode) This method will return some current version of committee, committee member or protocol that references either the given research area or one of its (active) descendants.
CommitteeMembershipBase	getCurrentCommitteeMembershipReferencingResearchArea(String researchAreaCode) This method will return the instance of a current CommitteeMembershipBase BO, saved in the db, that references the research area with the given code.
CommitteeBase	getCurrentCommitteeReferencingResearchArea(String researchAreaCode) This method will return the instance of a current CommitteeBase BO, saved in the db, that references the research area with the given code.
ProtocolBase	getCurrentProtocolReferencingResearchArea(String researchAreaCode) This method will return the instance of a current ProtocolBase BO, saved in the db, that references the research area with the given code.
String	getSubResearchAreasForTreeView(String researchAreaCode, boolean activeOnly) This method to get children research area codes of 'researchAreaCode'.
boolean	isResearchAreaExist(String researchAreaCode, String researchAreas) This method is check whether the new research area code exist in DB.
void	saveResearchAreas(String raChangeXML) This method is updates the research area based on the raChangeXML.

Method Detail

getSubResearchAreasForTreeView

String getSubResearchAreasForTreeView(String researchAreaCode,
                                    boolean activeOnly)

This method to get children research area codes of 'researchAreaCode'.

Parameters:

researchAreaCode -

activeOnly - - if true show only active research areas

Returns:

isResearchAreaExist

boolean isResearchAreaExist(String researchAreaCode,
                          String researchAreas)

This method is check whether the new research area code exist in DB.

Parameters:

researchAreaCode - : new research area code

researchAreas - : list of research area codes that are being removed, but has not been removed from DB yet.

Returns:

checkResearchAreaAndDescendantsNotReferenced

boolean checkResearchAreaAndDescendantsNotReferenced(String researchAreaCode)

This method checks that neither the given research area nor any of its descendants are referenced by any committee, committee member or protocol (current or past). This method should be called and checked to return true before calling the method to delete a research area (and its descendants).

Parameters:

researchAreaCode -

Returns:

getAnyCurrentReferencerForResearchAreaOrDescendant

ResearchAreaCurrentReferencerHolderBase getAnyCurrentReferencerForResearchAreaOrDescendant(String researchAreaCode)

This method will return some current version of committee, committee member or protocol that references either the given research area or one of its (active) descendants. It ignores past versions. If the given research area is not referenced by any current committee, committee member or protocol, then the method returns ResearchAreaCurrentReferencerHolder.NO_REFERENCER. This method should be called and its return value should be checked to ensure that there are no current referencers before calling the method to deactivate a research area (and its descendants).

Parameters:

researchAreaCode -

Returns:

getCurrentProtocolReferencingResearchArea

ProtocolBase getCurrentProtocolReferencingResearchArea(String researchAreaCode)

This method will return the instance of a current ProtocolBase BO, saved in the db, that references the research area with the given code. If no such saved protocol instance exists in the db, then this method returns null.

Parameters:

researchAreaCode -

Returns:

getCurrentCommitteeReferencingResearchArea

CommitteeBase getCurrentCommitteeReferencingResearchArea(String researchAreaCode)

This method will return the instance of a current CommitteeBase BO, saved in the db, that references the research area with the given code. If no such saved committee instance exists in the db, then this method returns null.

Parameters:

researchAreaCode -

Returns:

getCurrentCommitteeMembershipReferencingResearchArea

CommitteeMembershipBase getCurrentCommitteeMembershipReferencingResearchArea(String researchAreaCode)

This method will return the instance of a current CommitteeMembershipBase BO, saved in the db, that references the research area with the given code. If no such saved committee membership instance exists in the db, then this method returns null.

Parameters:

researchAreaCode -

Returns:

deactivateResearchAreaAndDescendants

void deactivateResearchAreaAndDescendants(String researchAreaCode)
                                          throws Exception

This method will deactivate the research area that has the given researchAreaCode, and will also recursively deactivate all of its descendant research areas as well.

Parameters:

researchAreaCode -

Throws:

Exception

deleteResearchAreaAndDescendants

void deleteResearchAreaAndDescendants(String researchAreaCode)
                                      throws Exception

This method will delete the research area that has the given researchAreaCode and will also recursively delete all of its descendant research areas as well.

Parameters:

researchAreaCode -

Throws:

Exception

saveResearchAreas

void saveResearchAreas(String raChangeXML)
                       throws ParserConfigurationException,
                              IOException,
                              SAXException

This method is updates the research area based on the raChangeXML.

Parameters:

raChangeXML - : XML formatted changes that were being performed on questionnaire page.

Throws:

ParserConfigurationException

IOException

SAXException