org.kuali.kra.service.impl

Class ResearchAreasServiceBaseImpl

java.lang.Object

org.kuali.kra.service.impl.ResearchAreasServiceBaseImpl

All Implemented Interfaces:

ResearchAreasServiceBase

Direct Known Subclasses:

IacucResearchAreasServiceImpl, ResearchAreasServiceImpl

public abstract class ResearchAreasServiceBaseImpl
extends Object
implements ResearchAreasServiceBase

This class...

Constructor Summary

Constructors

Constructor and Description
ResearchAreasServiceBaseImpl()

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.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected abstract Class<? extends CommitteeBase>	getCommitteeBOClassHook()
protected abstract Class<? extends CommitteeMembershipBase>	getCommitteeMembershipBOClassHook()
protected abstract Class<? extends CommitteeMembershipExpertiseBase>	getCommitteeMembershipExpertiseClassHook()
protected abstract Class<? extends CommitteeResearchAreaBase>	getCommitteeResearchAreaBOClassHook()
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.
protected abstract ResearchAreaBase	getNewResearchAreaInstanceHook(String researchAreaCode, String parentResearchAreaCode, String description, boolean active)
protected abstract Class<? extends ProtocolResearchAreaBase>	getProtocolResearchAreaBOClassHook()
protected abstract Class<? extends ResearchAreaBase>	getResearchAreaBOClassHook()
ResearchAreaReferencesDao	getResearchAreaReferencesDao()
protected List<ResearchAreaBase>	getSubResearchAreas(String researchAreaCode, boolean activeOnly)
String	getSubResearchAreasForTreeView(String researchAreaCode, boolean activeOnly) This method to get children research area codes of 'researchAreaCode'.
protected boolean	isExistInDeletedChildren(String researchAreaCode, String raCode)
boolean	isResearchAreaExist(String researchAreaCode, String researchAreas) This method is check whether the new research area code exist in DB.
void	saveResearchAreas(String raChangeXML) The format is as follows:
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setResearchAreaReferencesDao(ResearchAreaReferencesDao researchAreaReferencesDao)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResearchAreasServiceBaseImpl

public ResearchAreasServiceBaseImpl()

Method Detail

getSubResearchAreasForTreeView

public String getSubResearchAreasForTreeView(String researchAreaCode,
                                    boolean activeOnly)

Description copied from interface: ResearchAreasServiceBase

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

Specified by:

getSubResearchAreasForTreeView in interface ResearchAreasServiceBase

activeOnly - - if true show only active research areas

Returns:

See Also:

org.kuali.kra.irb.service.ResearchAreasService#getSubResearchAreasForTreeView(java.lang.String)

getSubResearchAreas

protected List<ResearchAreaBase> getSubResearchAreas(String researchAreaCode,
                                         boolean activeOnly)

isResearchAreaExist

public boolean isResearchAreaExist(String researchAreaCode,
                          String researchAreas)

Description copied from interface: ResearchAreasServiceBase

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

Specified by:

isResearchAreaExist in interface ResearchAreasServiceBase

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:

See Also:

ResearchAreasServiceBase.isResearchAreaExist(java.lang.String, java.lang.String)

checkResearchAreaAndDescendantsNotReferenced

public boolean checkResearchAreaAndDescendantsNotReferenced(String researchAreaCode)

Description copied from interface: ResearchAreasServiceBase

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).

Specified by:

checkResearchAreaAndDescendantsNotReferenced in interface ResearchAreasServiceBase

Returns:

See Also:

TODO: optimize by checking only active descendants? Could use the getSubResearchAreas method above

deleteResearchAreaAndDescendants

public void deleteResearchAreaAndDescendants(String researchAreaCode)

Description copied from interface: ResearchAreasServiceBase

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.

Specified by:

deleteResearchAreaAndDescendants in interface ResearchAreasServiceBase

See Also:

ResearchAreasServiceBase.deleteResearchAreaAndDescendants(java.lang.String)

isExistInDeletedChildren

protected boolean isExistInDeletedChildren(String researchAreaCode,
                               String raCode)

saveResearchAreas

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

The format is as follows:

 <RaChanges>
   <RaChangesElement>
       <RaCreate>
           <Code></Code>
           <ParentCode></ParentCode>
           <Description></Description>
           <Active></Active>
       </RaCreate>
       <RaUpdateDescription>
           <Code></Code>
           <Description></Description>
       </RaUpdateDescription>
       <RaUpdateActiveIndicator>
           <Code></Code>
           <Active></Active>
       </RaUpdateActiveIndicator>
       <RaUpdateParent>
           <Code></Code>
           <OldParent></OldParent>
           <NewParent></NewParent>
       </RaUpdateParent>
       <RaDelete>
           <Code></Code>
       </RaDelete>
   </RaChangesElement>
 </RaChanges>
 
 

Specified by:

saveResearchAreas in interface ResearchAreasServiceBase

Parameters:

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

Throws:

SAXException

IOException

ParserConfigurationException

See Also:

ResearchAreasServiceBase.saveResearchAreas(java.lang.String)

getCurrentProtocolReferencingResearchArea

public ProtocolBase getCurrentProtocolReferencingResearchArea(String researchAreaCode)

Description copied from interface: ResearchAreasServiceBase

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.

Specified by:

getCurrentProtocolReferencingResearchArea in interface ResearchAreasServiceBase

Returns:

See Also:

ResearchAreasServiceBase.getCurrentProtocolReferencingResearchArea(java.lang.String)

getCurrentCommitteeReferencingResearchArea

public CommitteeBase getCurrentCommitteeReferencingResearchArea(String researchAreaCode)

Description copied from interface: ResearchAreasServiceBase

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.

Specified by:

getCurrentCommitteeReferencingResearchArea in interface ResearchAreasServiceBase

Returns:

See Also:

ResearchAreasServiceBase.getCurrentCommitteeReferencingResearchArea(java.lang.String)

getCurrentCommitteeMembershipReferencingResearchArea

public CommitteeMembershipBase getCurrentCommitteeMembershipReferencingResearchArea(String researchAreaCode)

Description copied from interface: ResearchAreasServiceBase

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.

Specified by:

getCurrentCommitteeMembershipReferencingResearchArea in interface ResearchAreasServiceBase

Returns:

See Also:

ResearchAreasServiceBase.getCurrentCommitteeMembershipReferencingResearchArea(java.lang.String)

getCommitteeMembershipBOClassHook

protected abstract Class<? extends CommitteeMembershipBase> getCommitteeMembershipBOClassHook()

getCommitteeMembershipExpertiseClassHook

protected abstract Class<? extends CommitteeMembershipExpertiseBase> getCommitteeMembershipExpertiseClassHook()

deactivateResearchAreaAndDescendants

public void deactivateResearchAreaAndDescendants(String researchAreaCode)
                                          throws Exception

Description copied from interface: ResearchAreasServiceBase

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.

Specified by:

deactivateResearchAreaAndDescendants in interface ResearchAreasServiceBase

Throws:

Exception

See Also:

ResearchAreasServiceBase.deactivateResearchAreaAndDescendants(java.lang.String)

getAnyCurrentReferencerForResearchAreaOrDescendant

public ResearchAreaCurrentReferencerHolderBase getAnyCurrentReferencerForResearchAreaOrDescendant(String researchAreaCode)

Description copied from interface: ResearchAreasServiceBase

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).

Specified by:

getAnyCurrentReferencerForResearchAreaOrDescendant in interface ResearchAreasServiceBase

Returns:

See Also:

ResearchAreasServiceBase.getAnyCurrentReferencerForResearchAreaOrDescendant(java.lang.String)

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

getResearchAreaReferencesDao

public ResearchAreaReferencesDao getResearchAreaReferencesDao()

setResearchAreaReferencesDao

public void setResearchAreaReferencesDao(ResearchAreaReferencesDao researchAreaReferencesDao)

getCommitteeBOClassHook

protected abstract Class<? extends CommitteeBase> getCommitteeBOClassHook()

getCommitteeResearchAreaBOClassHook

protected abstract Class<? extends CommitteeResearchAreaBase> getCommitteeResearchAreaBOClassHook()

getProtocolResearchAreaBOClassHook

protected abstract Class<? extends ProtocolResearchAreaBase> getProtocolResearchAreaBOClassHook()

getResearchAreaBOClassHook

protected abstract Class<? extends ResearchAreaBase> getResearchAreaBOClassHook()

getNewResearchAreaInstanceHook

protected abstract ResearchAreaBase getNewResearchAreaInstanceHook(String researchAreaCode,
                                              String parentResearchAreaCode,
                                              String description,
                                              boolean active)