org.kuali.kra.protocol.protocol.funding

Class ProtocolFundingSourceServiceImplBase

java.lang.Object

org.kuali.kra.protocol.protocol.funding.ProtocolFundingSourceServiceImplBase

All Implemented Interfaces:

ProtocolFundingSourceService

Direct Known Subclasses:

IacucProtocolFundingSourceServiceImpl, ProtocolFundingSourceServiceImpl

public abstract class ProtocolFundingSourceServiceImplBase
extends Object
implements ProtocolFundingSourceService

Implements ProtocolFundingSourceBase.

Constructor Summary

Constructors

Constructor and Description
ProtocolFundingSourceServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ProtocolFundingSourceBase	creatNewProtocolFundingSourceInstanceHook(String fundingSourceNumber, String fundingSourceTypeCode, String fundingSourceName, String fundingSourceTitle)
AwardService	getAwardService()
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.krad.service.DocumentService	getDocumentService()
FundingSourceTypeService	getFundingSourceTypeService()
InstitutionalProposalService	getInstitutionalProposalService()
Map.Entry<String,String>	getLookupParameters(String fundingSourceTypeCode) Returns lookup parameters to create a funding source lookup URL based its type.
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
protected abstract Class<? extends ProtocolDocumentBase>	getProtocolDocumentBOClassHook()
org.kuali.rice.kns.lookup.LookupableHelperService	getProtocolLookupableHelperService()
SponsorService	getSponsorService()
UnitService	getUnitService()
String	getViewProtocolFundingSourceUrl(ProtocolFundingSourceBase protocolFundingSource, ProtocolActionBase action) Creates a view URL for the ProtocolBase funding source.
boolean	isEditable(String fundingSourceTypeCode) Returns whether the name attribute is editable according to fundingSourceTypeCode.
protected boolean	isLinkEnabled(String link) Returns whether a ProtocolBase can be linked to another transactional document in the system.
boolean	isLookupable(String fundingSourceTypeCode) Returns whether a lookup can be performed according to fundingSourceTypeCode.
boolean	isValidIdForType(ProtocolFundingSourceBase protocolFundingSource) Checks if the identifier contained in protocolFundingSource is valid for the type (e.g.
void	setAwardService(AwardService awardService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setFundingSourceTypeService(FundingSourceTypeService fundingSourceTypeService)
void	setInstitutionalProposalService(InstitutionalProposalService institutionalProposalService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setProtocolLookupableHelperService(org.kuali.rice.kns.lookup.LookupableHelperService protocolLookupableHelperService)
void	setSponsorService(SponsorService sponsorService)
void	setUnitService(UnitService unitService)
String	updateLookupParameter(String parameter, String boClassName, String fieldConversions) Modifies the generic lookup URL contained in parameter to include the boClassName and fieldConversions.
ProtocolFundingSourceBase	updateProtocolFundingSource(String fundingSourceTypeCode, String fundingSourceNumber, String fundingSourceName) Updates the name and title for a ProtocolBase funding source.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolFundingSourceServiceImplBase

public ProtocolFundingSourceServiceImplBase()

Method Detail

updateProtocolFundingSource

public ProtocolFundingSourceBase updateProtocolFundingSource(String fundingSourceTypeCode,
                                                    String fundingSourceNumber,
                                                    String fundingSourceName)

Updates the name and title for a ProtocolBase funding source.

Specified by:

updateProtocolFundingSource in interface ProtocolFundingSourceService

Parameters:

fundingSourceTypeCode - the type code of the funding source

fundingSourceNumber - the human-readable number of the funding source

fundingSourceName - the name of the funding source

Returns:

an instance of a ProtocolBase funding source

See Also:

ProtocolFundingSourceService.updateProtocolFundingSource(java.lang.String, java.lang.String, java.lang.String)

creatNewProtocolFundingSourceInstanceHook

protected abstract ProtocolFundingSourceBase creatNewProtocolFundingSourceInstanceHook(String fundingSourceNumber,
                                                                  String fundingSourceTypeCode,
                                                                  String fundingSourceName,
                                                                  String fundingSourceTitle)

isValidIdForType

public boolean isValidIdForType(ProtocolFundingSourceBase protocolFundingSource)

Checks if the identifier contained in protocolFundingSource is valid for the type (e.g. for type Unit, verifies whether it has a valid unit number).

Specified by:

isValidIdForType in interface ProtocolFundingSourceService

Parameters:

protocolFundingSource - the ProtocolBase funding source to validate

Returns:

true if the ProtocolBase funding source has a valid identifier, false otherwise

See Also:

ProtocolFundingSourceService.isValidIdForType(org.kuali.kra.protocol.protocol.funding.ProtocolFundingSourceBase)

getLookupParameters

public Map.Entry<String,String> getLookupParameters(String fundingSourceTypeCode)

Returns lookup parameters to create a funding source lookup URL based its type.

Specified by:

getLookupParameters in interface ProtocolFundingSourceService

Parameters:

fundingSourceTypeCode - the type code of the funding source

Returns:

a map of lookup parameters

See Also:

ProtocolFundingSourceService.getLookupParameters(java.lang.String)

updateLookupParameter

public String updateLookupParameter(String parameter,
                           String boClassName,
                           String fieldConversions)

Modifies the generic lookup URL contained in parameter to include the boClassName and fieldConversions.

Specified by:

updateLookupParameter in interface ProtocolFundingSourceService

Parameters:

parameter - the generic lookup URL

boClassName - the class name used in the lookup

fieldConversions - the field conversions between the lookup and the page

Returns:

a lookup URL specific to the given parameters

See Also:

ProtocolFundingSourceService.updateLookupParameter(java.lang.String, java.lang.String, java.lang.String)

getViewProtocolFundingSourceUrl

public String getViewProtocolFundingSourceUrl(ProtocolFundingSourceBase protocolFundingSource,
                                     ProtocolActionBase action)
                                       throws Exception

Creates a view URL for the ProtocolBase funding source.

Specified by:

getViewProtocolFundingSourceUrl in interface ProtocolFundingSourceService

Parameters:

protocolFundingSource - the funding source to view

action - a back reference back to the action

Returns:

a valid URL to view the funding source

Throws:

Exception

See Also:

org.kuali.kra.protocol.protocol.funding.ProtocolFundingSourceService#getViewProtocolFundingSourceUrl( org.kuali.kra.protocol.protocol.funding.ProtocolFundingSourceBase, org.kuali.kra.protocol.protocol.ProtocolProtocolAction)

isLinkEnabled

protected boolean isLinkEnabled(String link)

Returns whether a ProtocolBase can be linked to another transactional document in the system.

Parameters:

link - the parameter name

Returns:

true if the link is enabled, false otherwise

getProtocolDocumentBOClassHook

protected abstract Class<? extends ProtocolDocumentBase> getProtocolDocumentBOClassHook()

isEditable

public boolean isEditable(String fundingSourceTypeCode)

Returns whether the name attribute is editable according to fundingSourceTypeCode.

Specified by:

isEditable in interface ProtocolFundingSourceService

Parameters:

fundingSourceTypeCode - the type code of the funding source

Returns:

true if the name attribute is editable, false otherwise

See Also:

ProtocolFundingSourceService.isEditable(java.lang.String)

isLookupable

public boolean isLookupable(String fundingSourceTypeCode)

Returns whether a lookup can be performed according to fundingSourceTypeCode.

Specified by:

isLookupable in interface ProtocolFundingSourceService

Parameters:

fundingSourceTypeCode - the type code of the funding source

Returns:

true if a lookup can be performed, false otherwise

See Also:

ProtocolFundingSourceService.isLookupable(java.lang.String)

getFundingSourceTypeService

public FundingSourceTypeService getFundingSourceTypeService()

setFundingSourceTypeService

public void setFundingSourceTypeService(FundingSourceTypeService fundingSourceTypeService)

getSponsorService

public SponsorService getSponsorService()

setSponsorService

public void setSponsorService(SponsorService sponsorService)

getUnitService

public UnitService getUnitService()

setUnitService

public void setUnitService(UnitService unitService)

getInstitutionalProposalService

public InstitutionalProposalService getInstitutionalProposalService()

setInstitutionalProposalService

public void setInstitutionalProposalService(InstitutionalProposalService institutionalProposalService)

getAwardService

public AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)

getProtocolLookupableHelperService

public org.kuali.rice.kns.lookup.LookupableHelperService getProtocolLookupableHelperService()

setProtocolLookupableHelperService

public void setProtocolLookupableHelperService(org.kuali.rice.kns.lookup.LookupableHelperService protocolLookupableHelperService)

getDocumentService

public org.kuali.rice.krad.service.DocumentService getDocumentService()

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

getBusinessObjectService

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

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)