org.kuali.kra.award.awardhierarchy

Class AwardHierarchyServiceImpl

java.lang.Object

org.kuali.kra.award.awardhierarchy.AwardHierarchyServiceImpl

All Implemented Interfaces:

AwardHierarchyService

@Transactional
public class AwardHierarchyServiceImpl
extends Object
implements AwardHierarchyService

Field Summary

Fields inherited from interface org.kuali.kra.award.awardhierarchy.AwardHierarchyService

RECURS_HIERARCHY

Constructor Summary

Constructors

Constructor and Description
AwardHierarchyServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNewAwardToPlaceholderDocument(AwardDocument doc, AwardHierarchy node)
protected void	clearFilteredAttributes(Award newAward)
void	copyAwardAmountDateInfo(Award source, Award copy)
void	copyAwardAmountDateInfoToNewChild(Award source, Award copy) When we create a new child award that is not a copy of the parent, we still need copy dates from parent to child.
AwardHierarchy	copyAwardAndAllDescendantsAsNewHierarchy(AwardHierarchy targetNode)
AwardHierarchy	copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy(AwardHierarchy sourceNode, AwardHierarchy targetParentNode)
AwardHierarchy	copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy(AwardHierarchy sourceNode, AwardHierarchy targetParentNode)
AwardHierarchy	copyAwardAsChildOfAnAwardInAnotherHierarchy(AwardHierarchy sourceNode, AwardHierarchy targetParentNode)
AwardHierarchy	copyAwardAsChildOfAnAwardInCurrentHierarchy(AwardHierarchy sourceNode, AwardHierarchy targetParentNode)
AwardHierarchy	copyAwardAsNewHierarchy(AwardHierarchy targetNode)
AwardHierarchyNode	createAwardHierarchyNode(AwardHierarchy awardHierarchy, String currentAwardNumber, String currentSequenceNumber) Returns an AwardHierarchyNode for the awardHierarchy.
AwardHierarchy	createBasicHierarchy(String awardNumber)
AwardHierarchy	createNewAwardBasedOnAnotherAwardInHierarchy(AwardHierarchy nodeToCopyFrom, AwardHierarchy targetParentNode)
AwardHierarchy	createNewAwardBasedOnParent(AwardHierarchy targetNode)
AwardHierarchy	createNewChildAward(AwardHierarchy targetNode)
void	createNodeMapsOnFormForSummaryPanel(Map<String,AwardHierarchyNode> awardHierarchyNodes, Map<String,String> previousNodeMap, Map<String,String> nextNodeMap)
protected void	finalizeAward(Award newAward)
ActivePendingTransactionsService	getActivePendingTransactionsService() Gets the activePendingTransactionsService attribute.
AwardAmountInfoService	getAwardAmountInfoService() Gets the awardAmountInfoService attribute.
Map<String,AwardHierarchy>	getAwardHierarchy(AwardHierarchy anyNode, List<String> order) Get hierarchy as map, starting with the rootNode.
Map<String,AwardHierarchy>	getAwardHierarchy(String awardNumber, List<String> order)
protected Map<String,Object>	getAwardHierarchyCriteriaMap(String awardNumber)
protected AwardHierarchy	getAwardHierarchyRootNode(String someNodeAwardNumberInHierarchy)
AwardService	getAwardService()
AwardVersionService	getAwardVersionService()
protected AwardHierarchy	getCopyOfSourceNode(AwardHierarchy sourceNode)
protected ReportClass	getPaymentAndInvoicesReportClass()
protected AwardHierarchy	getRootNode(String rootAwardNumber)
AwardHierarchy	loadAwardHierarchy(String awardNumber)
AwardHierarchy	loadAwardHierarchyBranch(String awardNumber) This method loads the AwardHierarchy and recurs through all children (if any)
AwardHierarchy	loadFullHierarchyFromAnyNode(String awardNumber) Load a full hierarchy, returning the root node
AwardDocument	loadPlaceholderDocument()
void	persistAwardHierarchies(Collection<AwardHierarchy> rootNodes) Save all hierarchy nodes for each hierarchy represented by each root node element in the supplied list
void	persistAwardHierarchy(AwardHierarchy node)
void	persistAwardHierarchy(AwardHierarchy branchNode, boolean recurse) This method saves a node.
void	populateAwardHierarchyNodes(Map<String,AwardHierarchy> awardHierarchyItems, Map<String,AwardHierarchyNode> awardHierarchyNodes, String currentAwardNumber, String currentSequenceNumber) This method populates the AwardHierarchyNodes with relevant information required from other objects.
void	populateAwardHierarchyNodesForTandMDoc(Map<String,AwardHierarchy> awardHierarchyItems, Map<String,AwardHierarchyNode> awardHierarchyNodes, String currentAwardNumber, String currentSequenceNumber, TimeAndMoneyDocument timeAndMoneyDocument)
protected void	restoreOriginalAwardPropertiesAfterCopy(Award award, String originalAwardNumber, Integer originalSequenceNumber)
protected void	saveNodeWithAward(AwardHierarchy node, AwardDocument doc)
protected void	savePlaceholderDocument(AwardDocument doc)
void	setActivePendingTransactionsService(ActivePendingTransactionsService activePendingTransactionsService) Sets the activePendingTransactionsService attribute value.
void	setAwardAmountInfoService(AwardAmountInfoService awardAmountInfoService) Sets the awardAmountInfoService attribute value.
void	setAwardNumberService(AwardNumberService awardNumberService)
void	setAwardService(AwardService awardService)
void	setAwardVersionService(AwardVersionService awardVersionService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setVersionHistoryService(VersionHistoryService versionHistoryService)
void	setVersioningService(VersioningService versioningService)
protected RuntimeException	uncheckedException(Exception e)
protected Award	useOriginalAwardAsTemplateForCopy(Award award, String nextAwardNumber)

Methods inherited from class java.lang.Object

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

Constructor Detail

AwardHierarchyServiceImpl

public AwardHierarchyServiceImpl()

Method Detail

copyAwardAndAllDescendantsAsNewHierarchy

public AwardHierarchy copyAwardAndAllDescendantsAsNewHierarchy(AwardHierarchy targetNode)

Specified by:

copyAwardAndAllDescendantsAsNewHierarchy in interface AwardHierarchyService

Parameters:

targetNode -

Returns:

copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy

public AwardHierarchy copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy(AwardHierarchy sourceNode,
                                                                       AwardHierarchy targetParentNode)

Specified by:

copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy in interface AwardHierarchyService

copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy

public AwardHierarchy copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy(AwardHierarchy sourceNode,
                                                                       AwardHierarchy targetParentNode)

Specified by:

copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy in interface AwardHierarchyService

copyAwardAsChildOfAnAwardInAnotherHierarchy

public AwardHierarchy copyAwardAsChildOfAnAwardInAnotherHierarchy(AwardHierarchy sourceNode,
                                                         AwardHierarchy targetParentNode)

Specified by:

copyAwardAsChildOfAnAwardInAnotherHierarchy in interface AwardHierarchyService

copyAwardAsChildOfAnAwardInCurrentHierarchy

public AwardHierarchy copyAwardAsChildOfAnAwardInCurrentHierarchy(AwardHierarchy sourceNode,
                                                         AwardHierarchy targetParentNode)

Specified by:

copyAwardAsChildOfAnAwardInCurrentHierarchy in interface AwardHierarchyService

copyAwardAsNewHierarchy

public AwardHierarchy copyAwardAsNewHierarchy(AwardHierarchy targetNode)

Specified by:

copyAwardAsNewHierarchy in interface AwardHierarchyService

See Also:

AwardHierarchyService.copyAwardAsNewHierarchy(AwardHierarchy)

createBasicHierarchy

public AwardHierarchy createBasicHierarchy(String awardNumber)

Specified by:

createBasicHierarchy in interface AwardHierarchyService

See Also:

AwardHierarchyService.createBasicHierarchy(java.lang.String)

createNewAwardBasedOnAnotherAwardInHierarchy

public AwardHierarchy createNewAwardBasedOnAnotherAwardInHierarchy(AwardHierarchy nodeToCopyFrom,
                                                          AwardHierarchy targetParentNode)

Specified by:

createNewAwardBasedOnAnotherAwardInHierarchy in interface AwardHierarchyService

copyAwardAmountDateInfo

public void copyAwardAmountDateInfo(Award source,
                           Award copy)

createNewAwardBasedOnParent

public AwardHierarchy createNewAwardBasedOnParent(AwardHierarchy targetNode)

Specified by:

createNewAwardBasedOnParent in interface AwardHierarchyService

Parameters:

targetNode -

Returns:

copyAwardAmountDateInfoToNewChild

public void copyAwardAmountDateInfoToNewChild(Award source,
                                     Award copy)

When we create a new child award that is not a copy of the parent, we still need copy dates from parent to child.

Parameters:

source -

copy -

createNewChildAward

public AwardHierarchy createNewChildAward(AwardHierarchy targetNode)

Specified by:

createNewChildAward in interface AwardHierarchyService

loadAwardHierarchy

public AwardHierarchy loadAwardHierarchy(String awardNumber)

Specified by:

loadAwardHierarchy in interface AwardHierarchyService

See Also:

AwardHierarchyService.loadAwardHierarchy(java.lang.String)

loadAwardHierarchyBranch

public AwardHierarchy loadAwardHierarchyBranch(String awardNumber)

Description copied from interface: AwardHierarchyService

This method loads the AwardHierarchy and recurs through all children (if any)

Specified by:

loadAwardHierarchyBranch in interface AwardHierarchyService

Returns:

The AwardHierarchy tree branch starting with the node at awardNumber

See Also:

AwardHierarchyService.loadAwardHierarchy(java.lang.String)

getAwardHierarchy

public Map<String,AwardHierarchy> getAwardHierarchy(AwardHierarchy anyNode,
                                           List<String> order)

Description copied from interface: AwardHierarchyService

Get hierarchy as map, starting with the rootNode. Suppose the hiearchy looks like this: Root _______|______ | | Node 1 Node 2 |- Node 1.1 |- Node 2.1 |- Node 1.2 |- Node 2.2 | -Node 3.2 The default flattened (i.e. List) presentation will be: Root Node 1 Node 1.1 Node 1.2 Node 2 Node 2.1 Node 2.2

Specified by:

getAwardHierarchy in interface AwardHierarchyService

Returns:

getAwardHierarchy

public Map<String,AwardHierarchy> getAwardHierarchy(String awardNumber,
                                           List<String> order)

Specified by:

getAwardHierarchy in interface AwardHierarchyService

See Also:

AwardHierarchyService.getAwardHierarchy(java.lang.String, java.util.List)

loadFullHierarchyFromAnyNode

public AwardHierarchy loadFullHierarchyFromAnyNode(String awardNumber)

Description copied from interface: AwardHierarchyService

Load a full hierarchy, returning the root node

Specified by:

loadFullHierarchyFromAnyNode in interface AwardHierarchyService

Returns:

See Also:

AwardHierarchyService.loadFullHierarchyFromAnyNode(java.lang.String)

loadPlaceholderDocument

public AwardDocument loadPlaceholderDocument()

Specified by:

loadPlaceholderDocument in interface AwardHierarchyService

See Also:

AwardHierarchyService.loadPlaceholderDocument()

persistAwardHierarchy

public void persistAwardHierarchy(AwardHierarchy node)

Specified by:

persistAwardHierarchy in interface AwardHierarchyService

See Also:

AwardHierarchyService.persistAwardHierarchy(org.kuali.kra.award.awardhierarchy.AwardHierarchy)

persistAwardHierarchies

public void persistAwardHierarchies(Collection<AwardHierarchy> rootNodes)

Description copied from interface: AwardHierarchyService

Save all hierarchy nodes for each hierarchy represented by each root node element in the supplied list

Specified by:

persistAwardHierarchies in interface AwardHierarchyService

Parameters:

rootNodes -

persistAwardHierarchy

public void persistAwardHierarchy(AwardHierarchy branchNode,
                         boolean recurse)

Description copied from interface: AwardHierarchyService

This method saves a node. If recurs is true, save complete branch; i.e. all child nodes, grandchildren, etc.

Specified by:

persistAwardHierarchy in interface AwardHierarchyService

See Also:

AwardHierarchyService.persistAwardHierarchy(org.kuali.kra.award.awardhierarchy.AwardHierarchy, boolean)

setAwardNumberService

public void setAwardNumberService(AwardNumberService awardNumberService)

Parameters:

awardNumberService -

setBusinessObjectService

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

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

Parameters:

documentService -

setVersioningService

public void setVersioningService(VersioningService versioningService)

Parameters:

versioningService -

getRootNode

protected AwardHierarchy getRootNode(String rootAwardNumber)

clearFilteredAttributes

protected void clearFilteredAttributes(Award newAward)

getPaymentAndInvoicesReportClass

protected ReportClass getPaymentAndInvoicesReportClass()

getCopyOfSourceNode

protected AwardHierarchy getCopyOfSourceNode(AwardHierarchy sourceNode)

finalizeAward

protected void finalizeAward(Award newAward)

addNewAwardToPlaceholderDocument

protected void addNewAwardToPlaceholderDocument(AwardDocument doc,
                                    AwardHierarchy node)

getAwardHierarchyRootNode

protected AwardHierarchy getAwardHierarchyRootNode(String someNodeAwardNumberInHierarchy)

getAwardHierarchyCriteriaMap

protected Map<String,Object> getAwardHierarchyCriteriaMap(String awardNumber)

restoreOriginalAwardPropertiesAfterCopy

protected void restoreOriginalAwardPropertiesAfterCopy(Award award,
                                           String originalAwardNumber,
                                           Integer originalSequenceNumber)

saveNodeWithAward

protected void saveNodeWithAward(AwardHierarchy node,
                     AwardDocument doc)

savePlaceholderDocument

protected void savePlaceholderDocument(AwardDocument doc)

uncheckedException

protected RuntimeException uncheckedException(Exception e)

useOriginalAwardAsTemplateForCopy

protected Award useOriginalAwardAsTemplateForCopy(Award award,
                                      String nextAwardNumber)
                                           throws VersionException

Throws:

VersionException

populateAwardHierarchyNodes

public void populateAwardHierarchyNodes(Map<String,AwardHierarchy> awardHierarchyItems,
                               Map<String,AwardHierarchyNode> awardHierarchyNodes,
                               String currentAwardNumber,
                               String currentSequenceNumber)

Description copied from interface: AwardHierarchyService

This method populates the AwardHierarchyNodes with relevant information required from other objects.

Specified by:

populateAwardHierarchyNodes in interface AwardHierarchyService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

org.kuali.kra.award.awardhierarchy.AwardHierarchyService#populateAwardHierarchyNodes(java.util.Map, java.util.Map)

createAwardHierarchyNode

public AwardHierarchyNode createAwardHierarchyNode(AwardHierarchy awardHierarchy,
                                          String currentAwardNumber,
                                          String currentSequenceNumber)

Description copied from interface: AwardHierarchyService

Returns an AwardHierarchyNode for the awardHierarchy. If the awardHierarchy is for the currentAwardNumber, then will use the currentSequenceNumber if it is pending instead of the usual method for determining the current award.

Specified by:

createAwardHierarchyNode in interface AwardHierarchyService

Returns:

populateAwardHierarchyNodesForTandMDoc

public void populateAwardHierarchyNodesForTandMDoc(Map<String,AwardHierarchy> awardHierarchyItems,
                                          Map<String,AwardHierarchyNode> awardHierarchyNodes,
                                          String currentAwardNumber,
                                          String currentSequenceNumber,
                                          TimeAndMoneyDocument timeAndMoneyDocument)

Specified by:

populateAwardHierarchyNodesForTandMDoc in interface AwardHierarchyService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

org.kuali.kra.award.awardhierarchy.AwardHierarchyService#populateAwardHierarchyNodes(java.util.Map, java.util.Map)

getAwardVersionService

public AwardVersionService getAwardVersionService()

createNodeMapsOnFormForSummaryPanel

public void createNodeMapsOnFormForSummaryPanel(Map<String,AwardHierarchyNode> awardHierarchyNodes,
                                       Map<String,String> previousNodeMap,
                                       Map<String,String> nextNodeMap)

Specified by:

createNodeMapsOnFormForSummaryPanel in interface AwardHierarchyService

getAwardAmountInfoService

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

getActivePendingTransactionsService

public ActivePendingTransactionsService getActivePendingTransactionsService()

Gets the activePendingTransactionsService attribute.

Returns:

Returns the activePendingTransactionsService.

setActivePendingTransactionsService

public void setActivePendingTransactionsService(ActivePendingTransactionsService activePendingTransactionsService)

Sets the activePendingTransactionsService attribute value.

Parameters:

activePendingTransactionsService - The activePendingTransactionsService to set.

setVersionHistoryService

public void setVersionHistoryService(VersionHistoryService versionHistoryService)

getAwardService

public AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)

setAwardVersionService

public void setAwardVersionService(AwardVersionService awardVersionService)

setParameterService

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