org.kuali.kra.award.awardhierarchy

Class AwardHierarchyBean

java.lang.Object

org.kuali.kra.award.awardhierarchy.AwardHierarchyBean

All Implemented Interfaces:

Serializable

public class AwardHierarchyBean
extends Object
implements Serializable

Assumptions: 1) All hierarchy changes occur in memory only until an explicit save occurs a) Multiple hierarchy changes must be tracked until the save b) Many hierarchy operations require creation of Award copies or new Awards. To keep track of these new Awards, the hierarchy node should keep a transient reference to the new Award 2) Placeholder AwardDocument a) All Awards in all hierarchies will be referenced in a flattened list of awards on a placeholder AwardDocument b) This document will be used to save Awards. (Can BOS be used to handle only new Awards which is all AwardHierarchyService produces?) 3) Service methods will generally return a hierarchy node representing the results of an operation a) Hierarchy operations start with the awardNumber for the UI-selected hierarchy node 4) This bean will a) This bean will keep a reference to that placeholder document once obtained b) Keep the root node of all hierarchy roots (including the current hierarchy) produced during a user session c) Be used by AwardActionsAction (and AwardActions) to interact with hierarchy 5) On save, a) All hierarchy roots will be recursed to produce a flattened list of new hierarchy nodes. These will be saved with the BOS b) No deletes? No updates? (i.e. no move hierarchy?) Bean has been updated to null check the transient awardHierarchyService field before use.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AwardHierarchyBean(AwardForm awardForm) C'tor

Method Summary

Methods

Modifier and Type	Method and Description
AwardHierarchy	copyAwardAndAllDescendantsAsNewHierarchy(String awardNumber)
AwardHierarchy	copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy(String sourceAwardNumber, String targetParentAwardNumber)
AwardHierarchy	copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy(String sourceAwardNumber, String targetParentAwardNumber)
AwardHierarchy	copyAwardAndDescendantsAsChildOfAnotherAward(String sourceAwardNumber, String targetParentAwardNumber)
AwardHierarchy	copyAwardAsChildOfAnAwardInAnotherHierarchy(String sourceAwardNumber, String targetParentAwardNumber)
AwardHierarchy	copyAwardAsChildOfAnAwardInCurrentHierarchy(String sourceAwardNumber, String targetParentAwardNumber)
AwardHierarchy	copyAwardAsChildOfAnotherAward(String sourceAwardNumber, String targetParentAwardNumber)
AwardHierarchy	copyAwardAsNewHierarchy(String awardNumber)
void	createDefaultAwardHierarchy()
AwardHierarchy	createNewAwardBasedOnParent(String awardNumber)
AwardHierarchy	createNewChildAward(String awardNumber)
AwardHierarchy	createNewChildAwardBasedOnAnotherAwardInHierarchy(String nodeToCopyFromAwardNumber, String targetParentNodeAwardNumber)
List<String>	getAllAwardNumbers()
Map<String,AwardHierarchy>	getAwardHierarchy(AwardHierarchy rootNode, List<String> order)
Map<String,AwardHierarchy>	getAwardHierarchy(String awardNumber, List<String> order)
Map<String,AwardHierarchy>	getCurrentAwardHierarchy()
AwardHierarchy	getCurrentAwardHierarchyNode()
List<String>	getCurrentHierarchyOrder()
AwardHierarchy	getCurrentRootNode()
List<String>	getFinalAwardNumbers()
Integer	getMaxAwardNumber()
AwardHierarchy	getRootNode()
Map<String,AwardHierarchy>	getRootNodes()
protected void	loadHierarchy(String awardNumber)
void	recordTargetNodeState(AwardHierarchy targetNode) Method is untestable as a unit test until prevAwardNumber/prevRootAwardNmber is pulled off of form to this bean
void	refreshCurrentHierarchy()
boolean	saveHierarchyChanges()
void	setAllAwardNumbers(List<String> allAwardNumbers)
void	setFinalAwardNumbers(List<String> finalAwardNumbers)
void	setRootNodes(Map<String,AwardHierarchy> rootNodes)

Methods inherited from class java.lang.Object

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

Constructor Detail

AwardHierarchyBean

public AwardHierarchyBean(AwardForm awardForm)

C'tor

Parameters:

awardForm -

Method Detail

copyAwardAndDescendantsAsChildOfAnotherAward

public AwardHierarchy copyAwardAndDescendantsAsChildOfAnotherAward(String sourceAwardNumber,
                                                          String targetParentAwardNumber)

copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy

public AwardHierarchy copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy(String sourceAwardNumber,
                                                                       String targetParentAwardNumber)

copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy

public AwardHierarchy copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy(String sourceAwardNumber,
                                                                       String targetParentAwardNumber)

copyAwardAsChildOfAnotherAward

public AwardHierarchy copyAwardAsChildOfAnotherAward(String sourceAwardNumber,
                                            String targetParentAwardNumber)

copyAwardAsChildOfAnAwardInCurrentHierarchy

public AwardHierarchy copyAwardAsChildOfAnAwardInCurrentHierarchy(String sourceAwardNumber,
                                                         String targetParentAwardNumber)

copyAwardAsChildOfAnAwardInAnotherHierarchy

public AwardHierarchy copyAwardAsChildOfAnAwardInAnotherHierarchy(String sourceAwardNumber,
                                                         String targetParentAwardNumber)

copyAwardAndAllDescendantsAsNewHierarchy

public AwardHierarchy copyAwardAndAllDescendantsAsNewHierarchy(String awardNumber)

copyAwardAsNewHierarchy

public AwardHierarchy copyAwardAsNewHierarchy(String awardNumber)

Parameters:

awardNumber -

Returns:

createNewChildAward

public AwardHierarchy createNewChildAward(String awardNumber)

Parameters:

awardNumber -

Returns:

createNewChildAwardBasedOnAnotherAwardInHierarchy

public AwardHierarchy createNewChildAwardBasedOnAnotherAwardInHierarchy(String nodeToCopyFromAwardNumber,
                                                               String targetParentNodeAwardNumber)

createNewAwardBasedOnParent

public AwardHierarchy createNewAwardBasedOnParent(String awardNumber)

getCurrentAwardHierarchy

public Map<String,AwardHierarchy> getCurrentAwardHierarchy()

getCurrentHierarchyOrder

public List<String> getCurrentHierarchyOrder()

getAwardHierarchy

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

getAwardHierarchy

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

createDefaultAwardHierarchy

public void createDefaultAwardHierarchy()

getCurrentAwardHierarchyNode

public AwardHierarchy getCurrentAwardHierarchyNode()

Returns:

Returns the nodeForCurrentAward.

getCurrentRootNode

public AwardHierarchy getCurrentRootNode()

saveHierarchyChanges

public boolean saveHierarchyChanges()

Returns:

getMaxAwardNumber

public Integer getMaxAwardNumber()

getRootNode

public AwardHierarchy getRootNode()

refreshCurrentHierarchy

public void refreshCurrentHierarchy()

loadHierarchy

protected void loadHierarchy(String awardNumber)

recordTargetNodeState

public void recordTargetNodeState(AwardHierarchy targetNode)

Method is untestable as a unit test until prevAwardNumber/prevRootAwardNmber is pulled off of form to this bean

Parameters:

targetNode -

getAllAwardNumbers

public List<String> getAllAwardNumbers()

setAllAwardNumbers

public void setAllAwardNumbers(List<String> allAwardNumbers)

getFinalAwardNumbers

public List<String> getFinalAwardNumbers()

setFinalAwardNumbers

public void setFinalAwardNumbers(List<String> finalAwardNumbers)

getRootNodes

public Map<String,AwardHierarchy> getRootNodes()

setRootNodes

public void setRootNodes(Map<String,AwardHierarchy> rootNodes)