org.kuali.kra.award.home

Interface AwardService

All Known Implementing Classes:

AwardServiceImpl

public interface AwardService

This class intends to provide basic business service behavior and accessors for Awards.

Method Summary

Methods

Modifier and Type	Method and Description
AwardDocument	createNewAwardVersion(AwardDocument awardDocument) Create new version of the award document
List<Award>	findAwardsForAwardNumber(String awardNumber) This method finds all Awards for the specified awardNumber
Award	getActiveOrNewestAward(String awardNumber) Returns the active award or if none exist, the newest non-cancelled award.
Award	getAward(Long awardId) Get the Award based upon its unique id number.
Award	getAward(String awardId) Deprecated. The identifier for Award is a Long, but this method expects a String
void	synchNewCustomAttributes(Award newAward, Award oldAward) This method is to synch custom attributes.
void	updateAwardSequenceStatus(Award award, VersionStatus status) Update the award to use the new VersionStatus.

Method Detail

getAward

Award getAward(String awardId)

Deprecated. The identifier for Award is a Long, but this method expects a String

Get the Award based upon its unique id number.

Parameters:

awardId - the Award's unique id number

Returns:

the Award or null if not found.

getAward

Award getAward(Long awardId)

Get the Award based upon its unique id number.

Parameters:

awardId -

Returns:

findAwardsForAwardNumber

List<Award> findAwardsForAwardNumber(String awardNumber)

This method finds all Awards for the specified awardNumber

Parameters:

awardId -

Returns:

The list of Awards

createNewAwardVersion

AwardDocument createNewAwardVersion(AwardDocument awardDocument)
                                    throws VersionException,
                                           org.kuali.rice.kew.api.exception.WorkflowException

Create new version of the award document

Parameters:

awardDocument -

Returns:

Throws:

VersionException

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

updateAwardSequenceStatus

void updateAwardSequenceStatus(Award award,
                             VersionStatus status)

Update the award to use the new VersionStatus. If the version status is ACTIVE, any other active version of this award will be set to ARCHIVED.

Parameters:

award -

status -

getActiveOrNewestAward

Award getActiveOrNewestAward(String awardNumber)

Returns the active award or if none exist, the newest non-cancelled award.

Parameters:

awardNumber -

Returns:

synchNewCustomAttributes

void synchNewCustomAttributes(Award newAward,
                            Award oldAward)

This method is to synch custom attributes. During copy process only existing custom attributes available in the old document is copied. We need to make sure we have all the latest custom attributes tied to the new document.

Parameters:

newAward -

oldAward -