org.kuali.kra.lookup

Class KraLookupableHelperServiceImpl

java.lang.Object

org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

org.kuali.kra.lookup.KraLookupableHelperServiceImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

AwardPersonLookupableHelperServiceImpl, CoiDisclosureLookupableHelperBase, CoiDisclosureUndisclosedEventsLookupableHelper, CommitteeLookupableHelperServiceImplBase, DevelopmentProposalLookupableHelperServiceImpl, FinancialEntityLookupableHelper, InstitutionalProposalLookupableHelperServiceImpl, NegotiationLookupableHelperServiceImpl, ProtocolLookupableHelperServiceImplBase, ProtocolOnlineReviewLookupableHelperServiceImplBase, ProtocolSubmissionLookupableHelperServiceImplBase, ReportTrackingLookupableHelperServiceImpl, SubAwardLookupableHelperServiceImpl

public abstract class KraLookupableHelperServiceImpl
extends org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	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
KraLookupableHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEditHtmlData(List<org.kuali.rice.kns.lookup.HtmlData> htmlDataList, org.kuali.rice.krad.bo.BusinessObject businessObject)
List<org.kuali.rice.kns.lookup.HtmlData>	getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames) create 'edit' link
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getCustomLink(org.kuali.rice.krad.document.Document document, String methodToCall, String linkName, Boolean readOnly)
protected abstract String	getDocumentTypeName() This method to set document type of the lookup bo's document
protected abstract String	getHtmlAction() htmlaction for 'edit' link
protected abstract String	getKeyFieldName() This method is set the key field to retrieve bo for editing.
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getMedusaLink(org.kuali.rice.krad.document.Document document, Boolean readOnly)
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getViewLink(org.kuali.rice.krad.document.Document document)
Collection	performLookup(org.kuali.rice.kns.web.struts.form.LookupForm lookupForm, Collection resultTable, boolean bounded) To force to it to show action links, such as 'edit' if it is not 'lookup' to search of return value.
protected void	setBackLocationDocFormKey(Map<String,String> fieldValues) This method to set both fields if child class override getSearchResults
protected void	updateLookupField(org.kuali.rice.kns.web.ui.Field field, String keyName, String className) This method is to set up field definitions for lookup fields.

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

getExternalBusinessObjectProperty, getExternalizableBusinessObjectClass, getExternalizableBusinessObjectFieldValues, getExternalizableBusinessObjectProperties, getPrimaryKeyFieldLabels, getSearchResults, 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, isResultReturnable, 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

Field Detail

MEDUSA

protected static final String MEDUSA

See Also:

Constant Field Values

Constructor Detail

KraLookupableHelperServiceImpl

public KraLookupableHelperServiceImpl()

Method Detail

getCustomActionUrls

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

create 'edit' link

Specified by:

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

Overrides:

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

See Also:

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

addEditHtmlData

protected void addEditHtmlData(List<org.kuali.rice.kns.lookup.HtmlData> htmlDataList,
                   org.kuali.rice.krad.bo.BusinessObject businessObject)

Parameters:

businessObject -

getViewLink

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

getMedusaLink

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getMedusaLink(org.kuali.rice.krad.document.Document document,
                                                              Boolean readOnly)

getCustomLink

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getCustomLink(org.kuali.rice.krad.document.Document document,
                                                              String methodToCall,
                                                              String linkName,
                                                              Boolean readOnly)

Parameters:

document -

methodToCall - method to call on action

linkName -

readOnly - whether the document should be readOnly or not

Returns:

performLookup

public Collection performLookup(org.kuali.rice.kns.web.struts.form.LookupForm lookupForm,
                       Collection resultTable,
                       boolean bounded)

To force to it to show action links, such as 'edit' if it is not 'lookup' to search of return value.

Specified by:

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

Overrides:

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

See Also:

org.kuali.core.lookup.AbstractLookupableHelperServiceImpl#performLookup(org.kuali.core.web.struts.form.LookupForm, java.util.Collection, boolean)

setBackLocationDocFormKey

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

This method to set both fields if child class override getSearchResults

Parameters:

fieldValues -

updateLookupField

protected void updateLookupField(org.kuali.rice.kns.web.ui.Field field,
                     String keyName,
                     String className)

This method is to set up field definitions for lookup fields. These fields does not have a reference object defined for it in repository & bo.

Parameters:

field -

keyName -

className -

getHtmlAction

protected abstract String getHtmlAction()

htmlaction for 'edit' link

getDocumentTypeName

protected abstract String getDocumentTypeName()

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

Returns:

getKeyFieldName

protected abstract String getKeyFieldName()

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

Returns: