org.kuali.kra.award.awardhierarchy

Class AwardHierarchy

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.award.awardhierarchy.AwardHierarchy

All Implemented Interfaces:

Serializable, Cloneable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

AwardHierarchyNode

public class AwardHierarchy
extends KraPersistableBusinessObjectBase
implements Cloneable

AwardHierarchy is version agnostic. It should always reference the active version of the Award if one is present. If not present, it will reference the one and only pending Award matching the AwardHierarchy awardNumber.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOTS_PARENT_AWARD_NUMBER
static String	UNIQUE_IDENTIFIER_FIELD

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
AwardHierarchy() Default C'tor
AwardHierarchy(AwardHierarchy rootNode, AwardHierarchy parentNode, String awardNumber, String originatingAwardNumber) C'tor
AwardHierarchy(String rootAwardNumber, String parentAwardNumber, String awardNumber)
AwardHierarchy(String rootAwardNumber, String parentAwardNumber, String awardNumber, String originatingAwardNumber)

Method Summary

Methods

Modifier and Type	Method and Description
int	childCount() Convenience method to get child count
AwardHierarchy	clone()
static AwardHierarchy	createRootNode(Award award) Factory method for creating a root node from an Award
static AwardHierarchy	createRootNode(String awardNumber) Factory method for creating a root node from an awardNumber
boolean	equals(Object obj)
AwardHierarchy	findNodeInHierarchy(String awardNumber)
String	generateNextAwardNumberInSequence()
Award	getAward()
Long	getAwardHierarchyId() Method here for future JPA use
String	getAwardNumber()
List<AwardHierarchy>	getChildren() Gets the children attribute.
List<AwardHierarchy>	getFlattenedListOfNodesInHierarchy()
Map<String,AwardHierarchy>	getMapOfNodesInHierarchy()
String	getOriginatingAwardNumber()
AwardHierarchy	getParent() Gets the parent attribute.
String	getParentAwardNumber()
AwardHierarchy	getRoot() Gets the root attribute.
String	getRootAwardNumber()
boolean	hasChildren() This method dtermines if children are present
int	hashCode()
int	hierarchySize()
Boolean	isActive()
boolean	isNew()
boolean	isPersisted()
boolean	isRootNode() Node is root if the awardNumber === rootAwardNumber
void	setActive(Boolean active)
void	setAward(Award award)
void	setAwardHierarchyId(Long awardHierarchyId) Method here for future JPA use
void	setAwardNumber(String awardNumber)
void	setChildren(List<AwardHierarchy> children) Sets the children attribute value.
void	setOriginatingAwardNumber(String originatingDocumentNumber)
void	setParent(AwardHierarchy parent) Sets the parent attribute value.
void	setParentAwardNumber(String parentAwardNumber)
void	setRoot(AwardHierarchy root) Sets the root attribute value.
void	setRootAwardNumber(String rootAwardNumber)

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

ROOTS_PARENT_AWARD_NUMBER

public static final String ROOTS_PARENT_AWARD_NUMBER

See Also:

Constant Field Values

UNIQUE_IDENTIFIER_FIELD

public static final String UNIQUE_IDENTIFIER_FIELD

See Also:

Constant Field Values

Constructor Detail

AwardHierarchy

public AwardHierarchy()

Default C'tor

AwardHierarchy

public AwardHierarchy(AwardHierarchy rootNode,
              AwardHierarchy parentNode,
              String awardNumber,
              String originatingAwardNumber)

C'tor

Parameters:

rootNode -

parentNode -

awardNumber -

originatingAwardNumber -

AwardHierarchy

public AwardHierarchy(String rootAwardNumber,
              String parentAwardNumber,
              String awardNumber,
              String originatingAwardNumber)

Parameters:

rootAwardNumber -

parentAwardNumber -

awardNumber -

originatingAwardNumber -

AwardHierarchy

public AwardHierarchy(String rootAwardNumber,
              String parentAwardNumber,
              String awardNumber)

Parameters:

rootAwardNumber -

parentAwardNumber -

awardNumber -

Method Detail

childCount

public int childCount()

Convenience method to get child count

Returns:

createRootNode

public static AwardHierarchy createRootNode(Award award)

Factory method for creating a root node from an Award

Parameters:

award -

Returns:

createRootNode

public static AwardHierarchy createRootNode(String awardNumber)

Factory method for creating a root node from an awardNumber

Parameters:

awardNumber -

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getAward

public Award getAward()

Returns:

getAwardHierarchyId

public Long getAwardHierarchyId()

Method here for future JPA use

Returns:

getAwardNumber

public String getAwardNumber()

Returns:

getChildren

public List<AwardHierarchy> getChildren()

Gets the children attribute.

Returns:

Returns the children.

getOriginatingAwardNumber

public String getOriginatingAwardNumber()

getParent

public AwardHierarchy getParent()

Gets the parent attribute.

Returns:

Returns the parent.

getParentAwardNumber

public String getParentAwardNumber()

getRoot

public AwardHierarchy getRoot()

Gets the root attribute.

Returns:

Returns the root.

getFlattenedListOfNodesInHierarchy

public List<AwardHierarchy> getFlattenedListOfNodesInHierarchy()

getMapOfNodesInHierarchy

public Map<String,AwardHierarchy> getMapOfNodesInHierarchy()

getRootAwardNumber

public String getRootAwardNumber()

Returns:

hasChildren

public boolean hasChildren()

This method dtermines if children are present

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

isRootNode

public boolean isRootNode()

Node is root if the awardNumber === rootAwardNumber

Returns:

findNodeInHierarchy

public AwardHierarchy findNodeInHierarchy(String awardNumber)

Parameters:

awardNumber -

Returns:

generateNextAwardNumberInSequence

public String generateNextAwardNumberInSequence()

Returns:

setAward

public void setAward(Award award)

Parameters:

award -

setAwardHierarchyId

public void setAwardHierarchyId(Long awardHierarchyId)

Method here for future JPA use

Parameters:

awardHierarchyId -

setAwardNumber

public void setAwardNumber(String awardNumber)

Parameters:

awardNumber -

setChildren

public void setChildren(List<AwardHierarchy> children)

Sets the children attribute value.

Parameters:

children - The children to set.

setOriginatingAwardNumber

public void setOriginatingAwardNumber(String originatingDocumentNumber)

setParent

public void setParent(AwardHierarchy parent)

Sets the parent attribute value.

Parameters:

parent - The parent to set.

setParentAwardNumber

public void setParentAwardNumber(String parentAwardNumber)

setRoot

public void setRoot(AwardHierarchy root)

Sets the root attribute value.

Parameters:

root - The root to set.

setRootAwardNumber

public void setRootAwardNumber(String rootAwardNumber)

hierarchySize

public int hierarchySize()

Returns:

Size of hierarchy (# of nodes)

isNew

public boolean isNew()

isPersisted

public boolean isPersisted()

clone

public AwardHierarchy clone()

Overrides:

clone in class Object

isActive

public Boolean isActive()

setActive

public void setActive(Boolean active)