org.kuali.kra.protocol.protocol.funding

Interface ProtocolFundingSourceService

All Known Subinterfaces:

IacucProtocolFundingSourceService, ProtocolFundingSourceService

All Known Implementing Classes:

IacucProtocolFundingSourceServiceImpl, ProtocolFundingSourceServiceImpl, ProtocolFundingSourceServiceImplBase

public interface ProtocolFundingSourceService

Provides the required API for performing a multi-type lookup for funding sources, business rules used by the View, and business rule management for a protocol's funding source list.

Method Summary

Methods

Modifier and Type	Method and Description
Map.Entry<String,String>	getLookupParameters(String fundingSourceTypeCode) Returns lookup parameters to create a funding source lookup URL based its type.
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.
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.
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.

Method Detail

updateProtocolFundingSource

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

Updates the name and title for a ProtocolBase funding source.

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

isValidIdForType

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).

Parameters:

protocolFundingSource - the ProtocolBase funding source to validate

Returns:

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

getLookupParameters

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

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

Parameters:

fundingSourceTypeCode - the type code of the funding source

Returns:

a map of lookup parameters

updateLookupParameter

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

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

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

getViewProtocolFundingSourceUrl

String getViewProtocolFundingSourceUrl(ProtocolFundingSourceBase protocolFundingSource,
                                     ProtocolActionBase action)
                                       throws Exception

Creates a view URL for the ProtocolBase funding source.

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

isEditable

boolean isEditable(String fundingSourceTypeCode)

Returns whether the name attribute is editable according to fundingSourceTypeCode.

Parameters:

fundingSourceTypeCode - the type code of the funding source

Returns:

true if the name attribute is editable, false otherwise

isLookupable

boolean isLookupable(String fundingSourceTypeCode)

Returns whether a lookup can be performed according to fundingSourceTypeCode.

Parameters:

fundingSourceTypeCode - the type code of the funding source

Returns:

true if a lookup can be performed, false otherwise