org.kuali.kra.institutionalproposal.service.impl

Class InstitutionalProposalLookupableHelperServiceImpl

java.lang.Object

org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

org.kuali.kra.lookup.KraLookupableHelperServiceImpl

org.kuali.kra.institutionalproposal.service.impl.InstitutionalProposalLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.lookup.LookupableHelperService

public class InstitutionalProposalLookupableHelperServiceImpl
extends KraLookupableHelperServiceImpl

This class is used to control behavior of Institutional Proposal lookups. Depending on where the lookup is coming from, we may need to add custom action links and/or filter the lookup results.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.lookup.KraLookupableHelperServiceImpl

MEDUSA

Fields inherited from class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

LOG, searchUsingOnlyPrimaryKeyValues

Fields inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

ACTION_URLS_CHILDREN_END, ACTION_URLS_CHILDREN_SEPARATOR, ACTION_URLS_CHILDREN_STARTER, ACTION_URLS_EMPTY, ACTION_URLS_SEPARATOR, backLocation, businessObjectAuthorizationService, businessObjectClass, businessObjectDictionaryService, businessObjectMetaDataService, businessObjectService, configurationService, dataDictionaryService, docFormKey, docNum, encryptionService, fieldConversions, forceLookupResultFieldInquiryCache, inquirableClassCache, kualiInquirable, lookupResultsService, lookupService, maintenanceDocumentDictionaryService, noLookupResultFieldInquiryCache, parameters, parameterService, persistenceStructureService, readOnlyFieldsList, referencesToRefresh, resultColumns, RESULTS_DEFAULT_MAX_COLUMN_LENGTH, rows, sequenceAccessorService, TITLE_ACTION_URL_PREPENDTEXT_PROPERTY, TITLE_RETURN_URL_PREPENDTEXT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
InstitutionalProposalLookupableHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureCustomActions(Map<String,String> fieldValues)
protected void	filterAlreadyLinkedProposals(List<? extends org.kuali.rice.krad.bo.BusinessObject> searchResults, Map<String,String> fieldValues)
protected void	filterApprovedPendingSubmitProposals(List<? extends org.kuali.rice.krad.bo.BusinessObject> searchResults)
protected List<InstitutionalProposal>	filterForPermissions(List<InstitutionalProposal> results) This method filters results so that the person doing the lookup only gets back the documents he can view.
protected void	filterInvalidProposalStatus(List<? extends org.kuali.rice.krad.bo.BusinessObject> searchResults) This method is to filter out IP's not having codes in the valid funding proposal status codes parameter.
List<org.kuali.rice.kns.lookup.HtmlData>	getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames) create 'edit' link
protected Collection<DevelopmentProposal>	getDevelopmentProposals(InstitutionalProposal instProposal)
protected String	getDocumentTypeName() This method to set document type of the lookup bo's document
protected Map<String,Object>	getFieldValues(String key, Object value)
protected String	getHtmlAction() htmlaction for 'edit' link
protected InstitutionalProposalService	getInstitutionalProposalService()
protected String	getKeyFieldName() This method is set the key field to retrieve bo for editing.
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getOpenLink(org.kuali.rice.krad.document.Document document)
List<? extends org.kuali.rice.krad.bo.BusinessObject>	getSearchResults(Map<String,String> fieldValues)
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getSelectLink(InstitutionalProposal institutionalProposal)
protected boolean	isDevelopmentProposalAppPendingSubmitted(InstitutionalProposal ip) Find if any proposal associate with this INSP has 'Approval Pending Submitted' proposal state type
boolean	isResultReturnable(org.kuali.rice.krad.bo.BusinessObject object)
protected boolean	lookupIsFromAward(Map<String,String> fieldValues)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setInstitutionalProposalService(InstitutionalProposalService institutionalProposalService)

Methods inherited from class org.kuali.kra.lookup.KraLookupableHelperServiceImpl

addEditHtmlData, getCustomLink, getMedusaLink, getViewLink, performLookup, setBackLocationDocFormKey, updateLookupField

Methods inherited from class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

getExternalBusinessObjectProperty, getExternalizableBusinessObjectClass, getExternalizableBusinessObjectFieldValues, getExternalizableBusinessObjectProperties, getPrimaryKeyFieldLabels, getSearchResultsHelper, getSearchResultsUnbounded, hasExternalBusinessObjectProperty, isExternalBusinessObjectProperty, isSearchUsingOnlyPrimaryKeyValues, removeExternalizableBusinessObjectFieldValues

Methods inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrlHref, getActionUrls, getActionUrlTitleText, getBackLocation, getBusinessObjectAuthorizationService, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getColumnMaxLength, getColumns, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, getDataDictionaryService, getDefaultSortColumns, getDocFormKey, getDocNum, getEmptyActionUrls, getEmptyAnchorHtmlData, getEncryptionService, getExtraField, getInquiryUrl, getKualiConfigurationService, getKualiInquirable, getLookupResultsService, getLookupService, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentTypeName, getMaintenanceUrl, getParameters, getParameters, getParameterService, getParametersFromPrimaryKey, getPersistenceStructureService, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getRows, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, maskValueIfNecessary, performClear, performCustomAction, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameters, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

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

Constructor Detail

InstitutionalProposalLookupableHelperServiceImpl

public InstitutionalProposalLookupableHelperServiceImpl()

Method Detail

setDocumentService

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

getSearchResults

public List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResults(Map<String,String> fieldValues)

Specified by:

getSearchResults in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

getSearchResults in class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

filterForPermissions

protected List<InstitutionalProposal> filterForPermissions(List<InstitutionalProposal> results)

This method filters results so that the person doing the lookup only gets back the documents he can view.

Parameters:

results -

Returns:

getCustomActionUrls

public List<org.kuali.rice.kns.lookup.HtmlData> getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject businessObject,
                                                           List pkNames)

Description copied from class: KraLookupableHelperServiceImpl

create 'edit' link

Specified by:

getCustomActionUrls in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

getCustomActionUrls in class KraLookupableHelperServiceImpl

See Also:

AbstractLookupableHelperServiceImpl.getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject, java.util.List)

getOpenLink

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getOpenLink(org.kuali.rice.krad.document.Document document)

getHtmlAction

protected String getHtmlAction()

Description copied from class: KraLookupableHelperServiceImpl

htmlaction for 'edit' link

Specified by:

getHtmlAction in class KraLookupableHelperServiceImpl

getDocumentTypeName

protected String getDocumentTypeName()

Description copied from class: KraLookupableHelperServiceImpl

This method to set document type of the lookup bo's document

Specified by:

getDocumentTypeName in class KraLookupableHelperServiceImpl

Returns:

getKeyFieldName

protected String getKeyFieldName()

Description copied from class: KraLookupableHelperServiceImpl

This method is set the key field to retrieve bo for editing. May change to a map if there are multiple fields.

Specified by:

getKeyFieldName in class KraLookupableHelperServiceImpl

Returns:

lookupIsFromAward

protected boolean lookupIsFromAward(Map<String,String> fieldValues)

filterAlreadyLinkedProposals

protected void filterAlreadyLinkedProposals(List<? extends org.kuali.rice.krad.bo.BusinessObject> searchResults,
                                Map<String,String> fieldValues)

filterApprovedPendingSubmitProposals

protected void filterApprovedPendingSubmitProposals(List<? extends org.kuali.rice.krad.bo.BusinessObject> searchResults)

filterInvalidProposalStatus

protected void filterInvalidProposalStatus(List<? extends org.kuali.rice.krad.bo.BusinessObject> searchResults)

This method is to filter out IP's not having codes in the valid funding proposal status codes parameter.

isDevelopmentProposalAppPendingSubmitted

protected boolean isDevelopmentProposalAppPendingSubmitted(InstitutionalProposal ip)

Find if any proposal associate with this INSP has 'Approval Pending Submitted' proposal state type

getDevelopmentProposals

protected Collection<DevelopmentProposal> getDevelopmentProposals(InstitutionalProposal instProposal)

getFieldValues

protected Map<String,Object> getFieldValues(String key,
                                Object value)

configureCustomActions

protected void configureCustomActions(Map<String,String> fieldValues)

getSelectLink

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getSelectLink(InstitutionalProposal institutionalProposal)

isResultReturnable

public boolean isResultReturnable(org.kuali.rice.krad.bo.BusinessObject object)

Specified by:

isResultReturnable in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

isResultReturnable in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getInstitutionalProposalService

protected InstitutionalProposalService getInstitutionalProposalService()

setInstitutionalProposalService

public void setInstitutionalProposalService(InstitutionalProposalService institutionalProposalService)