Class AbstractLookupableHelperServiceImpl

java.lang.Object
org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
All Implemented Interfaces:
Serializable, LookupableHelperService
Direct Known Subclasses:
KualiLookupableHelperServiceImpl

@Deprecated public abstract class AbstractLookupableHelperServiceImpl extends Object implements LookupableHelperService
Deprecated.
Use LookupableImpl.
This class declares many of the common spring injected properties, the get/set-ers for them, and some common util methods that require the injected services
See Also:
  • Field Details

    • TITLE_RETURN_URL_PREPENDTEXT_PROPERTY

      protected static final String TITLE_RETURN_URL_PREPENDTEXT_PROPERTY
      Deprecated.
      See Also:
    • TITLE_ACTION_URL_PREPENDTEXT_PROPERTY

      protected static final String TITLE_ACTION_URL_PREPENDTEXT_PROPERTY
      Deprecated.
      See Also:
    • ACTION_URLS_CHILDREN_SEPARATOR

      protected static final String ACTION_URLS_CHILDREN_SEPARATOR
      Deprecated.
      See Also:
    • ACTION_URLS_CHILDREN_STARTER

      protected static final String ACTION_URLS_CHILDREN_STARTER
      Deprecated.
      See Also:
    • ACTION_URLS_CHILDREN_END

      protected static final String ACTION_URLS_CHILDREN_END
      Deprecated.
      See Also:
    • ACTION_URLS_SEPARATOR

      protected static final String ACTION_URLS_SEPARATOR
      Deprecated.
      See Also:
    • ACTION_URLS_EMPTY

      protected static final String ACTION_URLS_EMPTY
      Deprecated.
      See Also:
    • LOG

      protected static final org.apache.logging.log4j.Logger LOG
      Deprecated.
    • businessObjectClass

      protected Class businessObjectClass
      Deprecated.
    • parameters

      protected Map<String,String[]> parameters
      Deprecated.
    • businessObjectDictionaryService

      protected BusinessObjectDictionaryService businessObjectDictionaryService
      Deprecated.
    • businessObjectMetaDataService

      protected BusinessObjectMetaDataService businessObjectMetaDataService
      Deprecated.
    • dataDictionaryService

      protected org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService
      Deprecated.
    • persistenceStructureService

      protected PersistenceStructureService persistenceStructureService
      Deprecated.
    • encryptionService

      protected org.kuali.rice.core.api.encryption.EncryptionService encryptionService
      Deprecated.
    • readOnlyFieldsList

      protected List<String> readOnlyFieldsList
      Deprecated.
    • backLocation

      protected String backLocation
      Deprecated.
    • docFormKey

      protected String docFormKey
      Deprecated.
    • fieldConversions

      protected Map fieldConversions
      Deprecated.
    • lookupService

      protected org.kuali.rice.krad.service.LookupService lookupService
      Deprecated.
    • rows

      protected List<Row> rows
      Deprecated.
    • referencesToRefresh

      protected String referencesToRefresh
      Deprecated.
    • sequenceAccessorService

      protected SequenceAccessorService sequenceAccessorService
      Deprecated.
    • businessObjectService

      protected BusinessObjectService businessObjectService
      Deprecated.
    • lookupResultsService

      protected LookupResultsService lookupResultsService
      Deprecated.
    • docNum

      protected String docNum
      Deprecated.
    • configurationService

      protected org.kuali.rice.core.api.config.property.ConfigurationService configurationService
      Deprecated.
    • parameterService

      protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService
      Deprecated.
    • businessObjectAuthorizationService

      protected BusinessObjectAuthorizationService businessObjectAuthorizationService
      Deprecated.
    • maintenanceDocumentDictionaryService

      protected MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService
      Deprecated.
    • kualiInquirable

      protected Inquirable kualiInquirable
      Deprecated.
    • noLookupResultFieldInquiryCache

      protected HashMap<String,Boolean> noLookupResultFieldInquiryCache
      Deprecated.
    • inquirableClassCache

      protected HashMap<Class,Class> inquirableClassCache
      Deprecated.
    • forceLookupResultFieldInquiryCache

      protected HashMap<String,Boolean> forceLookupResultFieldInquiryCache
      Deprecated.
    • resultColumns

      protected org.kuali.rice.core.api.util.cache.CopiedObject<ArrayList<Column>> resultColumns
      Deprecated.
    • RESULTS_DEFAULT_MAX_COLUMN_LENGTH

      protected static Integer RESULTS_DEFAULT_MAX_COLUMN_LENGTH
      Deprecated.
  • Constructor Details

    • AbstractLookupableHelperServiceImpl

      public AbstractLookupableHelperServiceImpl()
      Deprecated.
  • Method Details

    • getDocNum

      public String getDocNum()
      Deprecated.
      Specified by:
      getDocNum in interface LookupableHelperService
      Returns:
      the docNum
    • setDocNum

      public void setDocNum(String docNum)
      Deprecated.
      Specified by:
      setDocNum in interface LookupableHelperService
      Parameters:
      docNum - the docNum to set
    • checkForAdditionalFields

      public boolean checkForAdditionalFields(Map<String,String> fieldValues)
      Deprecated.
      This implementation always returns false.
      Specified by:
      checkForAdditionalFields in interface LookupableHelperService
      Parameters:
      fieldValues - - Map of property/value pairs
      Returns:
      boolean
      See Also:
    • getBusinessObjectClass

      public Class getBusinessObjectClass()
      Deprecated.
      Specified by:
      getBusinessObjectClass in interface LookupableHelperService
      Returns:
      Returns the dataObjectClass this lookupable is representing
      See Also:
    • setBusinessObjectClass

      public void setBusinessObjectClass(Class businessObjectClass)
      Deprecated.
      Description copied from interface: LookupableHelperService
      Initializes the lookup with a business object class. This is set via the LookupableHelperService's consumer, namely the Lookupable implementation (or in cases of nesting a wrapping LookupableHelperService). The Lookupable in turn receives this value from the UI via LookupForm population.
      Specified by:
      setBusinessObjectClass in interface LookupableHelperService
      Parameters:
      businessObjectClass -
      See Also:
    • getParameters

      public Map<String,String[]> getParameters()
      Deprecated.
      Specified by:
      getParameters in interface LookupableHelperService
      Returns:
      Returns the parameters passed to this lookup
      See Also:
    • setParameters

      public void setParameters(Map<String,String[]> parameters)
      Deprecated.
      Description copied from interface: LookupableHelperService
      Initializes the lookup with the given Map of parameters.
      Specified by:
      setParameters in interface LookupableHelperService
      Parameters:
      parameters -
      See Also:
    • getDataDictionaryService

      public org.kuali.rice.krad.service.DataDictionaryService getDataDictionaryService()
      Deprecated.
      Gets the dataDictionaryService attribute.
      Specified by:
      getDataDictionaryService in interface LookupableHelperService
      Returns:
      Returns the dataDictionaryService.
    • setDataDictionaryService

      public void setDataDictionaryService(org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService)
      Deprecated.
      Sets the dataDictionaryService attribute value.
      Parameters:
      dataDictionaryService - The dataDictionaryService to set.
    • getBusinessObjectDictionaryService

      public BusinessObjectDictionaryService getBusinessObjectDictionaryService()
      Deprecated.
      Gets the businessObjectDictionaryService attribute.
      Specified by:
      getBusinessObjectDictionaryService in interface LookupableHelperService
      Returns:
      Returns the businessObjectDictionaryService.
    • setBusinessObjectDictionaryService

      public void setBusinessObjectDictionaryService(BusinessObjectDictionaryService businessObjectDictionaryService)
      Deprecated.
      Sets the businessObjectDictionaryService attribute value.
      Parameters:
      businessObjectDictionaryService - The businessObjectDictionaryService to set.
    • getBusinessObjectMetaDataService

      public BusinessObjectMetaDataService getBusinessObjectMetaDataService()
      Deprecated.
      Gets the businessObjectMetaDataService attribute.
      Returns:
      Returns the businessObjectMetaDataService.
    • setBusinessObjectMetaDataService

      public void setBusinessObjectMetaDataService(BusinessObjectMetaDataService businessObjectMetaDataService)
      Deprecated.
      Sets the businessObjectMetaDataService attribute value.
      Parameters:
      businessObjectMetaDataService - The businessObjectMetaDataService to set.
    • getPersistenceStructureService

      protected PersistenceStructureService getPersistenceStructureService()
      Deprecated.
      Gets the persistenceStructureService attribute.
      Returns:
      Returns the persistenceStructureService.
    • setPersistenceStructureService

      public void setPersistenceStructureService(PersistenceStructureService persistenceStructureService)
      Deprecated.
      Sets the persistenceStructureService attribute value.
      Parameters:
      persistenceStructureService - The persistenceStructureService to set.
    • getEncryptionService

      protected org.kuali.rice.core.api.encryption.EncryptionService getEncryptionService()
      Deprecated.
      Gets the encryptionService attribute.
      Returns:
      Returns the encryptionService.
    • setEncryptionService

      public void setEncryptionService(org.kuali.rice.core.api.encryption.EncryptionService encryptionService)
      Deprecated.
      Sets the encryptionService attribute value.
      Parameters:
      encryptionService - The encryptionService to set.
    • getMaintenanceDocumentDictionaryService

      public MaintenanceDocumentDictionaryService getMaintenanceDocumentDictionaryService()
      Deprecated.
    • getBusinessObjectAuthorizationService

      public BusinessObjectAuthorizationService getBusinessObjectAuthorizationService()
      Deprecated.
    • getKualiInquirable

      public Inquirable getKualiInquirable()
      Deprecated.
    • setMaintenanceDocumentDictionaryService

      public void setMaintenanceDocumentDictionaryService(MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService)
      Deprecated.
    • setKualiInquirable

      public void setKualiInquirable(Inquirable kualiInquirable)
      Deprecated.
    • getKualiConfigurationService

      public org.kuali.rice.core.api.config.property.ConfigurationService getKualiConfigurationService()
      Deprecated.
    • setParameterService

      public void setParameterService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)
      Deprecated.
    • getParameterService

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

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

      public boolean allowsMaintenanceNewOrCopyAction()
      Deprecated.
      Determines if underlying lookup bo has associated maintenance document that allows new or copy maintenance actions.
      Specified by:
      allowsMaintenanceNewOrCopyAction in interface LookupableHelperService
      Returns:
      true if bo has maint doc that allows new or copy actions
    • allowsMaintenanceEditAction

      protected boolean allowsMaintenanceEditAction(org.kuali.rice.krad.bo.BusinessObject businessObject)
      Deprecated.
    • getMaintenanceUrl

      public final String getMaintenanceUrl(org.kuali.rice.krad.bo.BusinessObject businessObject, HtmlData htmlData, List pkNames, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      Build a maintenance url.
      Specified by:
      getMaintenanceUrl in interface LookupableHelperService
      Parameters:
      businessObject -
      htmlData -
      pkNames -
      Returns:
    • getActionUrls

      public final String getActionUrls(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      This method is called by performLookup method to generate action urls. It calls the method getCustomActionUrls to get html data, calls getMaintenanceUrl to get the actual html tag, and returns a formatted/concatenated string of action urls.
      Specified by:
      getActionUrls in interface LookupableHelperService
      Parameters:
      businessObject - - Instance of a business object containing the return values
      pkNames - - List of primary key names
      Returns:
      String rendered in actions column of result set
    • getCustomActionUrls

      public List<HtmlData> getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames)
      Deprecated.
      Child classes should override this method if they want to return some other action urls.
      Specified by:
      getCustomActionUrls in interface LookupableHelperService
      Parameters:
      businessObject -
      pkNames -
      Returns:
    • allowsMaintenanceDeleteAction

      protected boolean allowsMaintenanceDeleteAction(org.kuali.rice.krad.bo.BusinessObject businessObject)
      Deprecated.
      for KULRice 3070
    • getUrlData

      protected HtmlData.AnchorHtmlData getUrlData(org.kuali.rice.krad.bo.BusinessObject businessObject, String methodToCall, String displayText, List pkNames)
      Deprecated.
      This method constructs an AnchorHtmlData. This method can be overridden by child classes if they want to construct the html data in a different way. Foe example, if they want different type of html tag, like input/image.
      Parameters:
      businessObject -
      methodToCall -
      displayText -
      pkNames -
      Returns:
    • getUrlData

      protected HtmlData.AnchorHtmlData getUrlData(org.kuali.rice.krad.bo.BusinessObject businessObject, String methodToCall, List pkNames)
      Deprecated.
      This method calls its overloaded method with displayText as methodToCall
      Parameters:
      businessObject -
      methodToCall -
      pkNames -
      Returns:
    • getEmptyActionUrls

      protected List<HtmlData> getEmptyActionUrls()
      Deprecated.
      A utility method that returns an empty list of action urls.
      Returns:
    • getEmptyAnchorHtmlData

      protected HtmlData getEmptyAnchorHtmlData()
      Deprecated.
    • getActionUrlHref

      protected String getActionUrlHref(org.kuali.rice.krad.bo.BusinessObject businessObject, String methodToCall, List pkNames)
      Deprecated.
      This method generates and returns href for the given parameters. This method can be overridden by child classes if they have to generate href differently. For example, refer to IntendedIncumbentLookupableHelperServiceImpl
      Parameters:
      businessObject -
      methodToCall -
      pkNames -
      Returns:
    • getParametersFromPrimaryKey

      protected Properties getParametersFromPrimaryKey(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames)
      Deprecated.
    • getActionUrlTitleText

      protected String getActionUrlTitleText(org.kuali.rice.krad.bo.BusinessObject businessObject, String displayText, List pkNames, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      This method generates and returns title text for action urls. Child classes can override this if they want to generate the title text differently. For example, refer to BatchJobStatusLookupableHelperServiceImpl
      Parameters:
      businessObject -
      displayText -
      pkNames -
      Returns:
    • getMaintenanceDocumentTypeName

      protected String getMaintenanceDocumentTypeName()
      Deprecated.
      Returns the maintenance document type associated with the business object class or null if one does not exist.
      Returns:
      String representing the maintenance document type name
    • getReadOnlyFieldsList

      public List<String> getReadOnlyFieldsList()
      Deprecated.
      Gets the readOnlyFieldsList attribute.
      Specified by:
      getReadOnlyFieldsList in interface LookupableHelperService
      Returns:
      Returns the readOnlyFieldsList.
    • setReadOnlyFieldsList

      public void setReadOnlyFieldsList(List<String> readOnlyFieldsList)
      Deprecated.
      Sets the readOnlyFieldsList attribute value.
      Specified by:
      setReadOnlyFieldsList in interface LookupableHelperService
      Parameters:
      readOnlyFieldsList - The readOnlyFieldsList to set.
    • getInquiryUrl

      public HtmlData getInquiryUrl(org.kuali.rice.krad.bo.BusinessObject bo, String propertyName)
      Deprecated.
      Returns the inquiry url for a field if one exist.
      Specified by:
      getInquiryUrl in interface LookupableHelperService
      Parameters:
      bo - the business object instance to build the urls for
      propertyName - the property which links to an inquirable
      Returns:
      String url to inquiry
    • getColumns

      public List<Column> getColumns()
      Deprecated.
      Constructs the list of columns for the search results. All properties for the column objects come from the DataDictionary.
      Specified by:
      getColumns in interface LookupableHelperService
      Returns:
      List of Column objects used to render the result table
    • getColumnMaxLength

      protected int getColumnMaxLength(String attributeName)
      Deprecated.
    • getBackLocation

      public String getBackLocation()
      Deprecated.
      Specified by:
      getBackLocation in interface LookupableHelperService
      Returns:
      Returns the backLocation.
    • setBackLocation

      public void setBackLocation(String backLocation)
      Deprecated.
      Specified by:
      setBackLocation in interface LookupableHelperService
      Parameters:
      backLocation - The backLocation to set.
    • getReturnLocation

      public String getReturnLocation()
      Deprecated.
      Specified by:
      getReturnLocation in interface LookupableHelperService
      Returns:
      String url for the location to return to after the lookup
      See Also:
    • getReturnUrl

      public final HtmlData getReturnUrl(org.kuali.rice.krad.bo.BusinessObject businessObject, Map fieldConversions, String lookupImpl, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      This method is for lookupable implementations
      Specified by:
      getReturnUrl in interface LookupableHelperService
      Parameters:
      businessObject - - Instance of a business object containing the return values
      fieldConversions - - Map of conversions mapping bo names to caller field names.
      lookupImpl - - Current lookup impl name
      returnKeys - - Keys to return
      Returns:
      String url called when selecting a row from the result set
    • getReturnHref

      protected final String getReturnHref(org.kuali.rice.krad.bo.BusinessObject businessObject, Map fieldConversions, String lookupImpl, List returnKeys)
      Deprecated.
      This method is for lookupable implementations
      Parameters:
      businessObject -
      fieldConversions -
      lookupImpl -
      returnKeys -
      Returns:
    • getReturnUrl

      public HtmlData getReturnUrl(org.kuali.rice.krad.bo.BusinessObject businessObject, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      Description copied from interface: LookupableHelperService
      This method builds the return url
      Specified by:
      getReturnUrl in interface LookupableHelperService
      Parameters:
      businessObject -
      lookupForm -
      returnKeys -
      Returns:
    • getReturnInputHtmlData

      protected HtmlData getReturnInputHtmlData(org.kuali.rice.krad.bo.BusinessObject businessObject, Properties parameters, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
    • getReturnAnchorHtmlData

      protected HtmlData getReturnAnchorHtmlData(org.kuali.rice.krad.bo.BusinessObject businessObject, Properties parameters, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
    • getReturnHref

      protected String getReturnHref(Properties parameters, LookupForm lookupForm, List returnKeys)
      Deprecated.
    • addToReturnHref

      protected String addToReturnHref(String href, LookupForm lookupForm)
      Deprecated.
    • getParameters

      protected Properties getParameters(org.kuali.rice.krad.bo.BusinessObject bo, Map<String,String> fieldConversions, String lookupImpl, List returnKeys)
      Deprecated.
    • getReturnKeys

      public List<String> getReturnKeys()
      Deprecated.
      Description copied from interface: LookupableHelperService
      This method is public because some unit tests depend on it.
      Specified by:
      getReturnKeys in interface LookupableHelperService
      Returns:
      a List of the names of fields which are marked in data dictionary as return fields.
    • getDocFormKey

      public String getDocFormKey()
      Deprecated.
      Gets the docFormKey attribute.
      Specified by:
      getDocFormKey in interface LookupableHelperService
      Returns:
      Returns the docFormKey.
    • setDocFormKey

      public void setDocFormKey(String docFormKey)
      Deprecated.
      Sets the docFormKey attribute value.
      Specified by:
      setDocFormKey in interface LookupableHelperService
      Parameters:
      docFormKey - The docFormKey to set.
    • setFieldConversions

      public void setFieldConversions(Map fieldConversions)
      Deprecated.
      Description copied from interface: LookupableHelperService
      Sets the requested fields conversions in the lookupable
      Specified by:
      setFieldConversions in interface LookupableHelperService
      Parameters:
      fieldConversions -
      See Also:
    • getLookupService

      protected org.kuali.rice.krad.service.LookupService getLookupService()
      Deprecated.
      Gets the lookupService attribute.
      Returns:
      Returns the lookupService.
    • setLookupService

      public void setLookupService(org.kuali.rice.krad.service.LookupService lookupService)
      Deprecated.
      Sets the lookupService attribute value.
      Parameters:
      lookupService - The lookupService to set.
    • getDefaultSortColumns

      public List<String> getDefaultSortColumns()
      Deprecated.
      Uses the DD to determine which is the default sort order.
      Specified by:
      getDefaultSortColumns in interface LookupableHelperService
      Returns:
      property names that will be used to sort on by default
    • validateSearchParameters

      public void validateSearchParameters(Map<String,String> fieldValues)
      Deprecated.
      Checks that any required search fields have value.
      Specified by:
      validateSearchParameters in interface LookupableHelperService
      Parameters:
      fieldValues - - Map of property/value pairs
      See Also:
    • validateSearchParameterWildcardAndOperators

      protected void validateSearchParameterWildcardAndOperators(String attributeName, String attributeValue)
      Deprecated.
    • setRows

      protected void setRows()
      Deprecated.
      Constructs the list of rows for the search fields. All properties for the field objects come from the DataDictionary. To be called by setBusinessObject
    • getRows

      public List<Row> getRows()
      Deprecated.
      Description copied from interface: LookupableHelperService
      Returns a list of Row objects to be used to generate the search query screen Generally, setDataObjectClass needs to be called with a non-null value for proper operation
      Specified by:
      getRows in interface LookupableHelperService
      Returns:
    • getSearchResults

      public abstract List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResults(Map<String,String> fieldValues)
      Deprecated.
      Description copied from interface: LookupableHelperService
      Performs a search and returns result list.
      Specified by:
      getSearchResults in interface LookupableHelperService
      Parameters:
      fieldValues - - Map of property/value pairs
      Returns:
      List of business objects found by the search
    • getSearchResultsUnbounded

      public List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResultsUnbounded(Map<String,String> fieldValues)
      Deprecated.
      This implementation of this method throws an UnsupportedOperationException, since not every implementation may actually want to use this operation. Subclasses desiring other behaviors will need to override this.
      Specified by:
      getSearchResultsUnbounded in interface LookupableHelperService
      Parameters:
      fieldValues -
      Returns:
      See Also:
    • getSearchResultsActualSizeKnown

      public boolean getSearchResultsActualSizeKnown()
      Deprecated.
      Description copied from interface: LookupableHelperService
      Determines if the actual size of search results (without limiting) is known. This should be false if search results are limited in SQL and there is post-SQL filtering of search results.
      Specified by:
      getSearchResultsActualSizeKnown in interface LookupableHelperService
      Returns:
      boolean
    • performLookup

      public Collection<? extends org.kuali.rice.krad.bo.BusinessObject> performLookup(LookupForm lookupForm, Collection<ResultRow> resultTable, boolean bounded)
      Deprecated.
      Performs the lookup and returns a collection of lookup items
      Specified by:
      performLookup in interface LookupableHelperService
      Parameters:
      lookupForm -
      resultTable -
      bounded -
      Returns:
    • getPropertyClass

      protected Class getPropertyClass(org.kuali.rice.krad.bo.BusinessObject element, String propertyName)
      Deprecated.
      Gets the Class for the property in the given BusinessObject instance, if property is not accessible then runtime exception is thrown
      Parameters:
      element - BusinessObject instance that contains property
      propertyName - Name of property in BusinessObject to get class for
      Returns:
      Type for property as Class
    • maskValueIfNecessary

      protected String maskValueIfNecessary(Class businessObjectClass, String propertyName, String propertyValue, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
    • setReferencesToRefresh

      protected void setReferencesToRefresh(String referencesToRefresh)
      Deprecated.
    • getReferencesToRefresh

      public String getReferencesToRefresh()
      Deprecated.
    • getSequenceAccessorService

      protected SequenceAccessorService getSequenceAccessorService()
      Deprecated.
    • setSequenceAccessorService

      public void setSequenceAccessorService(SequenceAccessorService sequenceAccessorService)
      Deprecated.
    • getBusinessObjectService

      public BusinessObjectService getBusinessObjectService()
      Deprecated.
    • setBusinessObjectService

      public void setBusinessObjectService(BusinessObjectService businessObjectService)
      Deprecated.
    • getLookupResultsService

      protected LookupResultsService getLookupResultsService()
      Deprecated.
    • setLookupResultsService

      public void setLookupResultsService(LookupResultsService lookupResultsService)
      Deprecated.
    • isSearchUsingOnlyPrimaryKeyValues

      public boolean isSearchUsingOnlyPrimaryKeyValues()
      Deprecated.
      Description copied from interface: LookupableHelperService
      This method returns whether the previously executed getSearchResults used the primary key values to search, ignoring all non key values
      Specified by:
      isSearchUsingOnlyPrimaryKeyValues in interface LookupableHelperService
      Returns:
      false always, subclasses should override to do something smarter
      See Also:
    • getPrimaryKeyFieldLabels

      public String getPrimaryKeyFieldLabels()
      Deprecated.
      Returns "N/A"
      Specified by:
      getPrimaryKeyFieldLabels in interface LookupableHelperService
      Returns:
      "N/A"
      See Also:
    • isResultReturnable

      public boolean isResultReturnable(org.kuali.rice.krad.bo.BusinessObject object)
      Deprecated.
      Description copied from interface: LookupableHelperService
      Determines whether a given BusinessObject that's returned as one of the lookup's results is considered returnable, which means that for single-value lookups, a "return value" link may be rendered, and for multiple value lookups, a checkbox is rendered. Note that this can be part of an authorization mechanism, but not the complete authorization mechanism. The component that invoked the lookup/ lookup caller (e.g. document, nesting lookup, etc.) needs to check that the object that was passed to it was returnable as well because there are ways around this method (e.g. crafting a custom return URL).
      Specified by:
      isResultReturnable in interface LookupableHelperService
      Parameters:
      object - an object from the search result set
      Returns:
    • performClear

      public void performClear(LookupForm lookupForm)
      Deprecated.
      This method does the logic for the clear action.
      Specified by:
      performClear in interface LookupableHelperService
    • shouldDisplayHeaderNonMaintActions

      public boolean shouldDisplayHeaderNonMaintActions()
      Deprecated.
      Specified by:
      shouldDisplayHeaderNonMaintActions in interface LookupableHelperService
      See Also:
    • shouldDisplayLookupCriteria

      public boolean shouldDisplayLookupCriteria()
      Deprecated.
      Specified by:
      shouldDisplayLookupCriteria in interface LookupableHelperService
      See Also:
    • getSupplementalMenuBar

      public String getSupplementalMenuBar()
      Deprecated.
      Description copied from interface: LookupableHelperService
      This method gets the supplemental lookup menu if any
      Specified by:
      getSupplementalMenuBar in interface LookupableHelperService
      Returns:
      supplemental menu bar
      See Also:
    • getTitle

      public String getTitle()
      Deprecated.
      Specified by:
      getTitle in interface LookupableHelperService
      Returns:
      String displayed as title for the lookup
      See Also:
    • performCustomAction

      public boolean performCustomAction(boolean ignoreErrors)
      Deprecated.
      Description copied from interface: LookupableHelperService
      performs custom actions. return true to reperform search
      Specified by:
      performCustomAction in interface LookupableHelperService
      Parameters:
      ignoreErrors -
      Returns:
      boolean to reperform search
      See Also:
    • getExtraField

      public Field getExtraField()
      Deprecated.
      Description copied from interface: LookupableHelperService
      get an extra field
      Specified by:
      getExtraField in interface LookupableHelperService
      Returns:
      See Also:
    • allowsNewOrCopyAction

      public boolean allowsNewOrCopyAction(String documentTypeName)
      Deprecated.
      Description copied from interface: LookupableHelperService
      Determines if underlying lookup bo has associated document that allows new or copy maintenance actions.
      Specified by:
      allowsNewOrCopyAction in interface LookupableHelperService
      Returns:
      true if bo has doc that allows new or copy actions
    • applyFieldAuthorizationsFromNestedLookups

      public void applyFieldAuthorizationsFromNestedLookups(Field field)
      Deprecated.
      Functional requirements state that users are able to perform searches using criteria values that they are not allowed to view.
      Specified by:
      applyFieldAuthorizationsFromNestedLookups in interface LookupableHelperService
    • applyConditionalLogicForFieldDisplay

      public void applyConditionalLogicForFieldDisplay()
      Deprecated.
      Calls methods that can be overridden by child lookupables to implement conditional logic for setting read-only, required, and hidden attributes. Called in the last part of the lookup lifecycle so the fields values that will be sent will be correctly reflected in the rows (like after a clear).
      Specified by:
      applyConditionalLogicForFieldDisplay in interface LookupableHelperService
      See Also:
    • getConditionallyReadOnlyPropertyNames

      public Set<String> getConditionallyReadOnlyPropertyNames()
      Deprecated.
      Returns:
      Set of property names that should be set as read only based on the current search contents, note request parms containing search field values can be retrieved with getParameters()
    • getConditionallyRequiredPropertyNames

      public Set<String> getConditionallyRequiredPropertyNames()
      Deprecated.
      Returns:
      Set of property names that should be set as required based on the current search contents, note request parms containing search field values can be retrieved with getParameters()
    • getConditionallyHiddenPropertyNames

      public Set<String> getConditionallyHiddenPropertyNames()
      Deprecated.
      Returns:
      Set of property names that should be set as hidden based on the current search contents, note request parms containing search field values can be retrieved with getParameters()
    • getCurrentSearchFieldValue

      protected String getCurrentSearchFieldValue(String propertyName)
      Deprecated.
      Helper method to get the value for a property out of the row-field graph. If property is multi-value then the values will be joined by a semi-colon.
      Parameters:
      propertyName - - name of property to retrieve value for
      Returns:
      current property value as a String