org.kuali.kra.award.web.struts.action

Class SponsorTermActionHelper

java.lang.Object

org.kuali.kra.award.web.struts.action.SponsorTermActionHelper

All Implemented Interfaces:

Serializable

public class SponsorTermActionHelper
extends Object
implements Serializable

This is a helper class for AwardPaymentReportsandTermsAction.java

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SponsorTermActionHelper()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAwardSponsorTerm(AwardSponsorTerm newAwardSponsorTerm, SponsorTermFormHelper formHelper, javax.servlet.http.HttpServletRequest request) Helper method to add sponsorTerm to Award.
protected void	addAwardSponsorTermFromMultiValueLookup(AwardSponsorTerm newAwardSponsorTerm, SponsorTermFormHelper formHelper, javax.servlet.http.HttpServletRequest request) Helper method to add sponsorTerm to Award.
AwardSponsorTerm	addSponsorTerm(SponsorTermFormHelper formHelper, javax.servlet.http.HttpServletRequest request) This method is called when adding a new AwardSponsorTerm.
protected AwardSponsorTerm	addSponsorTermFromDatabase(SponsorTermFormHelper formHelper, javax.servlet.http.HttpServletRequest request) This method adds sponsorTerm from a hardcoded sponsorCode in UI.
AwardSponsorTerm	addSponsorTermFromMutiValueLookup(SponsorTermFormHelper formHelper, SponsorTerm sponsorTerm, javax.servlet.http.HttpServletRequest request)
protected boolean	applyRulesToAwardSponsorTerm(AwardSponsorTerm newAwardSponsorTerm, SponsorTermFormHelper formHelper, javax.servlet.http.HttpServletRequest request) This method applies the rules to the award before adding.
protected boolean	applyRulesToAwardSponsorTermFromMultiValueLookup(AwardSponsorTerm newAwardSponsorTerm, SponsorTermFormHelper formHelper, javax.servlet.http.HttpServletRequest request, SponsorTerm sponsorTerm) This method applies the rules to the Award Sponsor Term before adding.
protected Collection<SponsorTerm>	getMatchingSponsorTermFromDatabase(SponsorTermFormHelper formHelper, String sponsorTermCode, int sponsorTermTypeCode) This method gets the Matching sponsorTerm from the database and returns a Collection of one SponsorTerm.
protected int	getSponsorTermTypeIndex(javax.servlet.http.HttpServletRequest request) This method reads the awardSponsorTermsTypeIndex from the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

SponsorTermActionHelper

public SponsorTermActionHelper()

Method Detail

addSponsorTerm

public AwardSponsorTerm addSponsorTerm(SponsorTermFormHelper formHelper,
                              javax.servlet.http.HttpServletRequest request)
                                throws Exception

This method is called when adding a new AwardSponsorTerm. It checks if the add is coming from a lookup or a hardcoded SponsorTermCode from the user and calls the corresponding add method.

Parameters:

formHelper -

Returns:

Throws:

Exception

addSponsorTermFromMutiValueLookup

public AwardSponsorTerm addSponsorTermFromMutiValueLookup(SponsorTermFormHelper formHelper,
                                                 SponsorTerm sponsorTerm,
                                                 javax.servlet.http.HttpServletRequest request)

addSponsorTermFromDatabase

protected AwardSponsorTerm addSponsorTermFromDatabase(SponsorTermFormHelper formHelper,
                                          javax.servlet.http.HttpServletRequest request)

This method adds sponsorTerm from a hardcoded sponsorCode in UI. Pulls the sponsorTerm data from database.

Returns:

new AwardSponsorTerm on success, null otherwise

applyRulesToAwardSponsorTerm

protected boolean applyRulesToAwardSponsorTerm(AwardSponsorTerm newAwardSponsorTerm,
                                   SponsorTermFormHelper formHelper,
                                   javax.servlet.http.HttpServletRequest request)

This method applies the rules to the award before adding.

Parameters:

newAwardSponsorTerm -

Returns:

applyRulesToAwardSponsorTermFromMultiValueLookup

protected boolean applyRulesToAwardSponsorTermFromMultiValueLookup(AwardSponsorTerm newAwardSponsorTerm,
                                                       SponsorTermFormHelper formHelper,
                                                       javax.servlet.http.HttpServletRequest request,
                                                       SponsorTerm sponsorTerm)

This method applies the rules to the Award Sponsor Term before adding.

Parameters:

newAwardSponsorTerm -

Returns:

addAwardSponsorTermFromMultiValueLookup

protected void addAwardSponsorTermFromMultiValueLookup(AwardSponsorTerm newAwardSponsorTerm,
                                           SponsorTermFormHelper formHelper,
                                           javax.servlet.http.HttpServletRequest request)

Helper method to add sponsorTerm to Award.

Parameters:

newAwardSponsorTerm -

addAwardSponsorTerm

protected void addAwardSponsorTerm(AwardSponsorTerm newAwardSponsorTerm,
                       SponsorTermFormHelper formHelper,
                       javax.servlet.http.HttpServletRequest request)

Helper method to add sponsorTerm to Award.

Parameters:

newAwardSponsorTerm -

getMatchingSponsorTermFromDatabase

protected Collection<SponsorTerm> getMatchingSponsorTermFromDatabase(SponsorTermFormHelper formHelper,
                                                         String sponsorTermCode,
                                                         int sponsorTermTypeCode)

This method gets the Matching sponsorTerm from the database and returns a Collection of one SponsorTerm.

Returns:

getSponsorTermTypeIndex

protected int getSponsorTermTypeIndex(javax.servlet.http.HttpServletRequest request)

This method reads the awardSponsorTermsTypeIndex from the request. It is specified in the tag file and is used for showing the validation errors while adding a new AwardSponsor object.

Parameters:

request -

Returns: