org.kuali.kra.award.contacts

Class AwardPersonUnit

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.award.contacts.AwardPersonUnit

All Implemented Interfaces:

Serializable, Comparable<AwardPersonUnit>, org.apache.ojb.broker.PersistenceBrokerAware, Sequenceable, SequenceAssociate<Award>, 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

public class AwardPersonUnit
extends KraPersistableBusinessObjectBase
implements Comparable<AwardPersonUnit>, SequenceAssociate<Award>

This class associates an AwardContact and a Unit

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	IS_LEAD_UNIT
static boolean	IS_NOT_LEAD_UNIT

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
AwardPersonUnit() Default Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AwardPersonUnitCreditSplit creditSplit)
int	compareTo(AwardPersonUnit other)
boolean	equals(Object obj)
static Unit	findLeadUnit(Collection<AwardPersonUnit> awardPersonUnits) Find the lead unit from among award awardPerson units
Long	getAwardContactId() Gets the awardPersonId attribute.
AwardContact	getAwardPerson()
Long	getAwardPersonUnitId() Gets the awardPersonUnitId attribute.
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
AwardPersonUnitCreditSplit	getCreditSplit(int index)
List<AwardPersonUnitCreditSplit>	getCreditSplits() Gets the creditSplits attribute.
String	getFullName()
List<UnitAdministrator>	getOspAdministrators()
Integer	getSequenceNumber() This gets the current version number.
Award	getSequenceOwner() The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
Unit	getUnit()
String	getUnitName()
String	getUnitNumber()
int	hashCode()
boolean	isLeadUnit()
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setAwardContactId(Long awardPersonId) Sets the awardPersonId attribute value.
void	setAwardPerson(AwardPerson awardPerson)
void	setAwardPersonUnitId(Long awardPersonUnitId) Sets the awardPersonUnitId attribute value.
void	setCreditSplits(List<AwardPersonUnitCreditSplit> creditSplits) Sets the creditSplits attribute value.
void	setLeadUnit(boolean leadUnit)
void	setSequenceOwner(Award newlyVersionedOwner) This sets the sequence owner on the associate.
void	setUnit(Unit unit)
void	setUnitNumber(String unitNumber) Sets the unitNumber attribute value.

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

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

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

toString

Field Detail

IS_LEAD_UNIT

public static final boolean IS_LEAD_UNIT

IS_NOT_LEAD_UNIT

public static final boolean IS_NOT_LEAD_UNIT

Constructor Detail

AwardPersonUnit

public AwardPersonUnit()

Default Constructor

Method Detail

findLeadUnit

public static Unit findLeadUnit(Collection<AwardPersonUnit> awardPersonUnits)

Find the lead unit from among award awardPerson units

Parameters:

awardPersonUnits -

Returns:

add

public void add(AwardPersonUnitCreditSplit creditSplit)

Parameters:

creditSplit -

compareTo

public int compareTo(AwardPersonUnit other)

Specified by:

compareTo in interface Comparable<AwardPersonUnit>

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getAwardContactId

public Long getAwardContactId()

Gets the awardPersonId attribute.

Returns:

Returns the awardPersonId.

getOspAdministrators

public List<UnitAdministrator> getOspAdministrators()

getAwardPerson

public AwardContact getAwardPerson()

Returns:

getAwardPersonUnitId

public Long getAwardPersonUnitId()

Gets the awardPersonUnitId attribute.

Returns:

Returns the awardPersonUnitId.

getCreditSplit

public AwardPersonUnitCreditSplit getCreditSplit(int index)

Parameters:

index -

Returns:

getCreditSplits

public List<AwardPersonUnitCreditSplit> getCreditSplits()

Gets the creditSplits attribute.

Returns:

Returns the creditSplits.

getFullName

public String getFullName()

Returns:

getUnit

public Unit getUnit()

Returns:

getUnitName

public String getUnitName()

Returns:

getUnitNumber

public String getUnitNumber()

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

isLeadUnit

public boolean isLeadUnit()

Returns:

setAwardContactId

public void setAwardContactId(Long awardPersonId)

Sets the awardPersonId attribute value.

Parameters:

awardPersonId - The awardPersonId to set.

setAwardPerson

public void setAwardPerson(AwardPerson awardPerson)

Parameters:

awardPerson -

setAwardPersonUnitId

public void setAwardPersonUnitId(Long awardPersonUnitId)

Sets the awardPersonUnitId attribute value.

Parameters:

awardPersonUnitId - The awardPersonUnitId to set.

setCreditSplits

public void setCreditSplits(List<AwardPersonUnitCreditSplit> creditSplits)

Sets the creditSplits attribute value.

Parameters:

creditSplits - The creditSplits to set.

setLeadUnit

public void setLeadUnit(boolean leadUnit)

Parameters:

leadUnit -

setUnit

public void setUnit(Unit unit)

Parameters:

unit -

setUnitNumber

public void setUnitNumber(String unitNumber)

Sets the unitNumber attribute value.

Parameters:

unitNumber - The unitNumber to set.

getBusinessObjectService

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

Returns:

getSequenceOwner

public Award getSequenceOwner()

Description copied from interface: SequenceAssociate

The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.

Specified by:

getSequenceOwner in interface SequenceAssociate<Award>

Returns:

the SequenceOwner

setSequenceOwner

public void setSequenceOwner(Award newlyVersionedOwner)

Description copied from interface: SequenceAssociate

This sets the sequence owner on the associate. Should no-op if this associate has no sequence owner

Specified by:

setSequenceOwner in interface SequenceAssociate<Award>

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: Sequenceable

This gets the current version number.

Specified by:

getSequenceNumber in interface Sequenceable

Returns:

the sequence number

resetPersistenceState

public void resetPersistenceState()

Description copied from interface: Sequenceable

This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity. During sequencing, the VersioningService needs to be able to signal that a Sequenceable has changed state from an persisted entity to a new, unpersisted one. Otherwise, versioning operations would result earlier SequenceOwners losing the association with older versions of associates. This behavior comes into play whenever an associated object is versioned. Typically, implementers will set primary key fields to null to trigger an INSERT during save.

Specified by:

resetPersistenceState in interface Sequenceable