org.kuali.kra.award.awardhierarchy

Interface AwardHierarchyService

All Known Implementing Classes:

AwardHierarchyServiceImpl

public interface AwardHierarchyService

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RECURS_HIERARCHY

Method Summary

Methods

Modifier and Type	Method and Description
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 award)
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)
Map<String,AwardHierarchy>	getAwardHierarchy(AwardHierarchy rootNode, List<String> order) Get hierarchy as map, starting with the rootNode.
Map<String,AwardHierarchy>	getAwardHierarchy(String awardNumber, List<String> order)
AwardHierarchy	loadAwardHierarchy(String awardNumber)
AwardHierarchy	loadAwardHierarchyBranch(String parentAwardNumber) 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> awardHierarchyRootNodes) Save all hierarchy nodes for each hierarchy represented by each root node element in the supplied list
void	persistAwardHierarchy(AwardHierarchy awardHierarchy)
void	persistAwardHierarchy(AwardHierarchy awardHierarchy, boolean recurs) 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 doc)

Field Detail

RECURS_HIERARCHY

static final boolean RECURS_HIERARCHY

See Also:

Constant Field Values

Method Detail

copyAwardAndAllDescendantsAsNewHierarchy

AwardHierarchy copyAwardAndAllDescendantsAsNewHierarchy(AwardHierarchy targetNode)

copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy

AwardHierarchy copyAwardAndDescendantsAsChildOfAnAwardInAnotherHierarchy(AwardHierarchy sourceNode,
                                                                       AwardHierarchy targetParentNode)

copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy

AwardHierarchy copyAwardAndDescendantsAsChildOfAnAwardInCurrentHierarchy(AwardHierarchy sourceNode,
                                                                       AwardHierarchy targetParentNode)

copyAwardAsChildOfAnAwardInAnotherHierarchy

AwardHierarchy copyAwardAsChildOfAnAwardInAnotherHierarchy(AwardHierarchy sourceNode,
                                                         AwardHierarchy targetParentNode)

copyAwardAsChildOfAnAwardInCurrentHierarchy

AwardHierarchy copyAwardAsChildOfAnAwardInCurrentHierarchy(AwardHierarchy sourceNode,
                                                         AwardHierarchy targetParentNode)

copyAwardAsNewHierarchy

AwardHierarchy copyAwardAsNewHierarchy(AwardHierarchy award)

createBasicHierarchy

AwardHierarchy createBasicHierarchy(String awardNumber)

createNewAwardBasedOnAnotherAwardInHierarchy

AwardHierarchy createNewAwardBasedOnAnotherAwardInHierarchy(AwardHierarchy nodeToCopyFrom,
                                                          AwardHierarchy targetParentNode)

createNewAwardBasedOnParent

AwardHierarchy createNewAwardBasedOnParent(AwardHierarchy targetNode)

createNewChildAward

AwardHierarchy createNewChildAward(AwardHierarchy targetNode)

loadAwardHierarchy

AwardHierarchy loadAwardHierarchy(String awardNumber)

loadAwardHierarchyBranch

AwardHierarchy loadAwardHierarchyBranch(String parentAwardNumber)

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

Parameters:

parentAwardNumber -

Returns:

The AwardHierarchy tree branch starting with the node at awardNumber

loadFullHierarchyFromAnyNode

AwardHierarchy loadFullHierarchyFromAnyNode(String awardNumber)

Load a full hierarchy, returning the root node

Parameters:

awardNumber -

Returns:

getAwardHierarchy

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

getAwardHierarchy

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

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

Parameters:

rootNode -

Returns:

loadPlaceholderDocument

AwardDocument loadPlaceholderDocument()

persistAwardHierarchy

void persistAwardHierarchy(AwardHierarchy awardHierarchy)

persistAwardHierarchy

void persistAwardHierarchy(AwardHierarchy awardHierarchy,
                         boolean recurs)

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

Parameters:

awardHierarchy -

recurs -

persistAwardHierarchies

void persistAwardHierarchies(Collection<AwardHierarchy> awardHierarchyRootNodes)

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

Parameters:

awardHierarchyRootNodes -

populateAwardHierarchyNodes

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.

Parameters:

awardHierarchyItems -

awardHierarchyNodes -

currentAward -

Throws:

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

populateAwardHierarchyNodesForTandMDoc

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

createNodeMapsOnFormForSummaryPanel

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

createAwardHierarchyNode

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

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.

Parameters:

awardHierarchy -

currentAwardNumber -

currentSequenceNumber -

Returns: