org.kuali.kra.medusa.service

Class MedusaServiceImpl

java.lang.Object

org.kuali.kra.medusa.service.MedusaServiceImpl

All Implemented Interfaces:

MedusaService

public class MedusaServiceImpl
extends Object
implements MedusaService

Medusa Service provides the methods to get MedusaNodes that describe the tree-like structure that describes the nodes and provides a method of retrieving related BOs for summary display.

Constructor Summary

Constructors

Constructor and Description
MedusaServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEdge(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, org.kuali.rice.krad.bo.BusinessObject bo1, org.kuali.rice.krad.bo.BusinessObject bo2) First adds both bos into the graph as vertexes(using addVertex) and then if the links do not already exist, adds a bi-directional link to the graph.
protected void	addSpecialReviewLinksToGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, List<? extends SpecialReview> specialReviews, org.kuali.rice.krad.bo.BusinessObject existingBo)
protected void	addToGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, org.kuali.rice.krad.bo.BusinessObject newBo, org.kuali.rice.krad.bo.BusinessObject existingBo)
protected org.kuali.rice.krad.bo.BusinessObject	addVertex(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, org.kuali.rice.krad.bo.BusinessObject bo) Adds a new bo to the graph like hash after checking to make sure the same bo is not already added.
protected boolean	areBusinessObjectsEqual(org.kuali.rice.krad.bo.BusinessObject bo1, org.kuali.rice.krad.bo.BusinessObject bo2) Checks the buisness objects for equality assuming they are medusa supported BOs (Development Proposal, Institutional Proposal or Award), this is because the current BOs do not support equality checking.
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, Award award) Builds the graph recursively by finding links from the Award.
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, DevelopmentProposal devProp) Continues to build the graph finding links from the development proposal
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, IacucProtocol protocol)
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, InstitutionalProposal proposal) Builds the graph using links found from the institutional proposal.
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, Negotiation negotiation)
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, Protocol protocol)
protected void	buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, SubAward subAward)
protected org.kuali.rice.krad.bo.BusinessObject	findMatchingBo(Collection<org.kuali.rice.krad.bo.BusinessObject> boSet, org.kuali.rice.krad.bo.BusinessObject bo) Looks through the boSet for a matching medusa BO.
protected SequenceOwner	getActiveOrCurrentVersion(Class clazz, String sequenceName) Gets the active or if not available the most current, not cancelled version of a versioned BO.
protected Award	getAward(Long awardId) Returns the newest active if available or the newest no cancelled award if it is not
protected Award	getAward(String awardNumber)
protected AwardAmountInfoService	getAwardAmountInfoService() Gets the awardAmountInfoService attribute.
protected Collection<Award>	getAwards(InstitutionalProposal ip) Generates and returns a collection of all awards linked to the institutional proposal
protected Collection<Award>	getAwards(SubAward subAward)
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
protected DevelopmentProposal	getDevelopmentProposal(String proposalNumber)
protected Collection<DevelopmentProposal>	getDevelopmentProposals(InstitutionalProposal instProposal) Returns a list of the Development Proposals linked to the institutional proposal.
protected Map<String,Object>	getFieldValues(String key, Object value)
protected IacucProtocol	getIacuc(Long protocolId)
protected IacucProtocol	getIacuc(String protocolNumber)
protected InstitutionalProposal	getInstitutionalProposal(Long proposalId) Returns the newest active institutional proposal if its available otherwise the newest pending and then archived proposal is returned.
protected InstitutionalProposal	getInstitutionalProposal(String proposalNumber)
List<MedusaNode>	getMedusaByAward(String moduleName, Long moduleIdentifier) Returns a list of MedusaNode objects that describe the top level of the tree-like structure of the Medusa object passed in using the Awards(if available) as the top level nodes.
List<MedusaNode>	getMedusaByProposal(String moduleName, Long moduleIdentifier) Returns a list of MedusaNode objects that describe the top level of the tree-like structure of the Medusa object passed in using the Institutional Proposals(if available) as the top level nodes.
MedusaNode	getMedusaNode(String moduleName, Long moduleId) Returns a single MedusaNode that can be used to render the lazy-loaded summary for the BO contained in that node
protected List<MedusaNode>	getMedusaTree(String moduleName, Long moduleIdentifier, String preferredModule) Builds the tree-like structure of MedusaNode objects using the module name and identifier
protected Negotiation	getNegotiation(Long negotiationId)
protected Collection<Negotiation>	getNegotiations(org.kuali.rice.krad.bo.BusinessObject bo)
protected NegotiationService	getNegotiationService()
protected InstitutionalProposal	getNewestProposalByStatus(String proposalNumber, VersionStatus status) Gets and returns the newest active proposal version for the proposal number.
protected MedusaNode	getNode(Award award)
protected MedusaNode	getNode(org.kuali.rice.krad.bo.BusinessObject bo) Creates a MedusaNode for the BO given the BO is supported by Medusa(Award, Dev Prop or Inst Prop).
protected MedusaNode	getNode(DevelopmentProposal proposal)
protected MedusaNode	getNode(IacucProtocol protocol)
protected MedusaNode	getNode(InstitutionalProposal proposal)
protected MedusaNode	getNode(Negotiation negotiation)
protected MedusaNode	getNode(Protocol protocol)
protected MedusaNode	getNode(SubAward subAward)
protected NsfCode	getNsfCode(String nsfCode) Helper function as nsfCode has been wired up such that it needs outside help getting the actual BO loaded.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
protected List<MedusaNode>	getParentNodes(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, String[] preferedOrder) Searches through the graph using the preferred order for Bos to occupy the top level(or parent nodes) and then populates all child nodes of each top level node.
protected Collection<InstitutionalProposal>	getProposals(Award award) Returns all institutional proposals linked to this award.
protected Collection<InstitutionalProposal>	getProposals(DevelopmentProposal devProposal) Gets all institutional proposals linked to this development proposal via the ProposalAdminDetails.
protected Protocol	getProtocol(Long protocolId)
protected Protocol	getProtocol(String protocolNumber)
protected Map<String,Boolean>	getSpecialReviewLinkingEnabled(org.kuali.rice.krad.bo.BusinessObject existingBo)
protected SubAward	getSubAward(Long subAwardId)
protected SubAward	getSubAward(String subAwardCode)
protected Collection<SubAward>	getSubAwards(Award award)
protected SubAwardService	getSubAwardService()
protected VersionHistoryService	getVersionHistoryService()
protected boolean	isBoInList(List<MedusaNode> nodes, org.kuali.rice.krad.bo.BusinessObject bo) Looks through the list of MedusaNodes to see if the BO is equal to the BO of one of the nodes.
protected void	populateChildNodes(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph, MedusaNode node, List<MedusaNode> parentNodes) Using the links defined in the graph hash, add all nodes linked to the current node
void	setAwardAmountInfoService(AwardAmountInfoService awardAmountInfoService) Sets the awardAmountInfoService attribute value.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setNegotiationService(NegotiationService negotiationService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setSubAwardService(SubAwardService subAwardService)
void	setVersionHistoryService(VersionHistoryService versionHistoryService)

Methods inherited from class java.lang.Object

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

Constructor Detail

MedusaServiceImpl

public MedusaServiceImpl()

Method Detail

getMedusaNode

public MedusaNode getMedusaNode(String moduleName,
                       Long moduleId)

Description copied from interface: MedusaService

Returns a single MedusaNode that can be used to render the lazy-loaded summary for the BO contained in that node

Specified by:

getMedusaNode in interface MedusaService

Parameters:

moduleName - name of the module to be looked up (ie. award, IP, DP)

moduleId - the primary key of the object to be looked up in the specified module

Returns:

See Also:

MedusaService.getMedusaNode(java.lang.String, java.lang.Long)

getNsfCode

protected NsfCode getNsfCode(String nsfCode)

Helper function as nsfCode has been wired up such that it needs outside help getting the actual BO loaded.

Parameters:

nsfCode -

Returns:

getMedusaByProposal

public List<MedusaNode> getMedusaByProposal(String moduleName,
                                   Long moduleIdentifier)

Description copied from interface: MedusaService

Returns a list of MedusaNode objects that describe the top level of the tree-like structure of the Medusa object passed in using the Institutional Proposals(if available) as the top level nodes.

Specified by:

getMedusaByProposal in interface MedusaService

Parameters:

moduleName - name of the module to be looked up (ie. award, IP, DP)

moduleIdentifier - the primary key of the object to be looked up in the specified module

Returns:

See Also:

MedusaService.getMedusaByProposal(java.lang.String, java.lang.Long)

getMedusaByAward

public List<MedusaNode> getMedusaByAward(String moduleName,
                                Long moduleIdentifier)

Description copied from interface: MedusaService

Returns a list of MedusaNode objects that describe the top level of the tree-like structure of the Medusa object passed in using the Awards(if available) as the top level nodes.

Specified by:

getMedusaByAward in interface MedusaService

Parameters:

moduleName - name of the module to be looked up (ie. award, IP, DP)

moduleIdentifier - the primary key of the object to be looked up in the specified module

Returns:

See Also:

MedusaService.getMedusaByAward(java.lang.String, java.lang.Long)

getMedusaTree

protected List<MedusaNode> getMedusaTree(String moduleName,
                             Long moduleIdentifier,
                             String preferredModule)

Builds the tree-like structure of MedusaNode objects using the module name and identifier

Parameters:

moduleName - name of the module to be looked up (ie. award, IP, DP)

moduleIdentifier - the primary key of the object to be looked up in the specified module

preferredModule - defines the object type that should be placed at the top level when possible

Returns:

addVertex

protected org.kuali.rice.krad.bo.BusinessObject addVertex(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
                                              org.kuali.rice.krad.bo.BusinessObject bo)

Adds a new bo to the graph like hash after checking to make sure the same bo is not already added. This is done outside of the typical hash uniqueness due to the fact the BOs do not all defined equals and hash code so we do the checks here

Parameters:

graph -

bo -

Returns:

the bo that was already in the graph or was added to the graph

addEdge

protected void addEdge(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
           org.kuali.rice.krad.bo.BusinessObject bo1,
           org.kuali.rice.krad.bo.BusinessObject bo2)

First adds both bos into the graph as vertexes(using addVertex) and then if the links do not already exist, adds a bi-directional link to the graph.

Parameters:

graph -

bo1 -

bo2 -

getParentNodes

protected List<MedusaNode> getParentNodes(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
                              String[] preferedOrder)

Searches through the graph using the preferred order for Bos to occupy the top level(or parent nodes) and then populates all child nodes of each top level node.

Parameters:

graph -

preferedOrder - an array of module names (ie. award, DP, IP)

Returns:

populateChildNodes

protected void populateChildNodes(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
                      MedusaNode node,
                      List<MedusaNode> parentNodes)

Using the links defined in the graph hash, add all nodes linked to the current node

Parameters:

graph -

node -

parentNodes -

isBoInList

protected boolean isBoInList(List<MedusaNode> nodes,
                 org.kuali.rice.krad.bo.BusinessObject bo)

Looks through the list of MedusaNodes to see if the BO is equal to the BO of one of the nodes.

Parameters:

nodes -

bo -

Returns:

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              SubAward subAward)

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              Protocol protocol)

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              IacucProtocol protocol)

addSpecialReviewLinksToGraph

protected void addSpecialReviewLinksToGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
                                List<? extends SpecialReview> specialReviews,
                                org.kuali.rice.krad.bo.BusinessObject existingBo)

getSpecialReviewLinkingEnabled

protected Map<String,Boolean> getSpecialReviewLinkingEnabled(org.kuali.rice.krad.bo.BusinessObject existingBo)

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              Award award)

Builds the graph recursively by finding links from the Award.

Parameters:

graph -

award -

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              InstitutionalProposal proposal)

Builds the graph using links found from the institutional proposal.

Parameters:

graph -

proposal -

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              DevelopmentProposal devProp)

Continues to build the graph finding links from the development proposal

Parameters:

graph -

devProp -

buildGraph

protected void buildGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              Negotiation negotiation)

addToGraph

protected void addToGraph(HashMap<org.kuali.rice.krad.bo.BusinessObject,List<org.kuali.rice.krad.bo.BusinessObject>> graph,
              org.kuali.rice.krad.bo.BusinessObject newBo,
              org.kuali.rice.krad.bo.BusinessObject existingBo)

findMatchingBo

protected org.kuali.rice.krad.bo.BusinessObject findMatchingBo(Collection<org.kuali.rice.krad.bo.BusinessObject> boSet,
                                                   org.kuali.rice.krad.bo.BusinessObject bo)

Looks through the boSet for a matching medusa BO.

Parameters:

boSet -

bo -

Returns:

areBusinessObjectsEqual

protected boolean areBusinessObjectsEqual(org.kuali.rice.krad.bo.BusinessObject bo1,
                              org.kuali.rice.krad.bo.BusinessObject bo2)

Checks the buisness objects for equality assuming they are medusa supported BOs (Development Proposal, Institutional Proposal or Award), this is because the current BOs do not support equality checking.

Parameters:

bo1 -

bo2 -

Returns:

getDevelopmentProposal

protected DevelopmentProposal getDevelopmentProposal(String proposalNumber)

getInstitutionalProposal

protected InstitutionalProposal getInstitutionalProposal(Long proposalId)

Returns the newest active institutional proposal if its available otherwise the newest pending and then archived proposal is returned.

Parameters:

proposalId -

Returns:

getInstitutionalProposal

protected InstitutionalProposal getInstitutionalProposal(String proposalNumber)

getAward

protected Award getAward(Long awardId)

Returns the newest active if available or the newest no cancelled award if it is not

Parameters:

awardId -

Returns:

getAward

protected Award getAward(String awardNumber)

getNegotiation

protected Negotiation getNegotiation(Long negotiationId)

getSubAward

protected SubAward getSubAward(Long subAwardId)

getProtocol

protected Protocol getProtocol(Long protocolId)

getProtocol

protected Protocol getProtocol(String protocolNumber)

getIacuc

protected IacucProtocol getIacuc(Long protocolId)

getIacuc

protected IacucProtocol getIacuc(String protocolNumber)

getActiveOrCurrentVersion

protected SequenceOwner getActiveOrCurrentVersion(Class clazz,
                                      String sequenceName)

Gets the active or if not available the most current, not cancelled version of a versioned BO. Currently only Awards use the Version History framework though

Parameters:

clazz -

sequenceName -

Returns:

getNode

protected MedusaNode getNode(org.kuali.rice.krad.bo.BusinessObject bo)

Creates a MedusaNode for the BO given the BO is supported by Medusa(Award, Dev Prop or Inst Prop).

Parameters:

bo -

Returns:

getNode

protected MedusaNode getNode(Award award)

getNode

protected MedusaNode getNode(InstitutionalProposal proposal)

getNode

protected MedusaNode getNode(DevelopmentProposal proposal)

getNode

protected MedusaNode getNode(Negotiation negotiation)

getNode

protected MedusaNode getNode(SubAward subAward)

getNode

protected MedusaNode getNode(Protocol protocol)

getNode

protected MedusaNode getNode(IacucProtocol protocol)

getDevelopmentProposals

protected Collection<DevelopmentProposal> getDevelopmentProposals(InstitutionalProposal instProposal)

Returns a list of the Development Proposals linked to the institutional proposal. This will involve a search through all institutional proposal versions for a matching ProposalAdminDetails object as the admin details are not versioned with the institutional proposal.

Parameters:

instProposal -

Returns:

getAwards

protected Collection<Award> getAwards(SubAward subAward)

getSubAward

protected SubAward getSubAward(String subAwardCode)

getSubAwards

protected Collection<SubAward> getSubAwards(Award award)

getAwards

protected Collection<Award> getAwards(InstitutionalProposal ip)

Generates and returns a collection of all awards linked to the institutional proposal

Parameters:

ip -

Returns:

getNewestProposalByStatus

protected InstitutionalProposal getNewestProposalByStatus(String proposalNumber,
                                              VersionStatus status)

Gets and returns the newest active proposal version for the proposal number.

Parameters:

proposalNumber -

Returns:

getProposals

protected Collection<InstitutionalProposal> getProposals(Award award)

Returns all institutional proposals linked to this award. This will involve a search through all award versions as award funding proposals are not versioned with the award. It will also look through all institutional proposals to see if the institutional proposal lists the award id and it not funded and the currently active version.

Parameters:

award -

Returns:

getProposals

protected Collection<InstitutionalProposal> getProposals(DevelopmentProposal devProposal)

Gets all institutional proposals linked to this development proposal via the ProposalAdminDetails.

Parameters:

devProposal -

Returns:

getNegotiations

protected Collection<Negotiation> getNegotiations(org.kuali.rice.krad.bo.BusinessObject bo)

getBusinessObjectService

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

Gets the businessObjectService attribute.

Returns:

Returns the businessObjectService.

setBusinessObjectService

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

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

getFieldValues

protected Map<String,Object> getFieldValues(String key,
                                Object value)

getAwardAmountInfoService

protected AwardAmountInfoService getAwardAmountInfoService()

Gets the awardAmountInfoService attribute.

Returns:

Returns the awardAmountInfoService.

setAwardAmountInfoService

public void setAwardAmountInfoService(AwardAmountInfoService awardAmountInfoService)

Sets the awardAmountInfoService attribute value.

Parameters:

awardAmountInfoService - The awardAmountInfoService to set.

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

setVersionHistoryService

public void setVersionHistoryService(VersionHistoryService versionHistoryService)

getNegotiationService

protected NegotiationService getNegotiationService()

setNegotiationService

public void setNegotiationService(NegotiationService negotiationService)

getSubAwardService

protected SubAwardService getSubAwardService()

setSubAwardService

public void setSubAwardService(SubAwardService subAwardService)

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)