Package org.kuali.rice.kns.lookup

Interface Lookupable

All Superinterfaces:
Serializable
All Known Implementing Classes:
KualiLookupableImpl
@Deprecated public interface Lookupable extends Serializable
Deprecated.
Use Lookupable.
This class defines an interface for lookupables. They should act as facades for LookupableHelperServices and also expose bean handlers (getCreateNewUrl, getHtmlMenuBar, getTitle, getRows, getExtraButton{Source,Params})

  • Method Details

    • setBusinessObjectClass

      void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass)
      Deprecated.
      Initializes the lookup with a businss object class. This value originates from the UI via LookupForm population. It is required that implementations of this method will initialize the search area used by the UI to provide the search form. In particular, it will ensure that getRows() will return valid results
      Parameters:
      boClass -

    • getBusinessObjectClass

      Class<? extends BusinessObject> getBusinessObjectClass()
      Deprecated.
      Returns:
      Returns the dataObjectClass this lookupable is representing

    • setParameters

      void setParameters(Map<String,String[]> parameters)
      Deprecated.
      Initializes the lookup with the given Map of parameters.
      Parameters:
      parameters -

    • getParameters

      Map<String,String[]> getParameters()
      Deprecated.
      Returns:
      Returns the parameters passed to this lookup

    • getHtmlMenuBar

      String getHtmlMenuBar()
      Deprecated.
      Returns:
      the html to be displayed as a menu bar

    • getSupplementalMenuBar

      String getSupplementalMenuBar()
      Deprecated.
      Returns:
      the html to be displayed as a supplemental menu bar

    • getRows

      List<Row> getRows()
      Deprecated.
      Returns:
      List of Row objects used to render the search area

    • getTitle

      String getTitle()
      Deprecated.
      Returns:
      String displayed as title for the lookup

    • getReturnLocation

      String getReturnLocation()
      Deprecated.
      Returns:
      String url for the location to return to after the lookup

    • getColumns

      List<Column> getColumns()
      Deprecated.
      Returns:
      List of Column objects used to render the result table

    • validateSearchParameters

      void validateSearchParameters(Map<String,String> fieldValues)
      Deprecated.
      Validates the values filled in as search criteria, also checks for required field values.
      Parameters:
      fieldValues - - Map of property/value pairs

    • performLookup

      Collection<? extends BusinessObject> performLookup(LookupForm lookupForm, List<ResultRow> resultTable, boolean bounded)
      Deprecated.
      This method performs the lookup and returns a collection of lookup items
      Parameters:
      lookupForm -
      resultTable -
      bounded -
      Returns:
      results of lookup

    • getSearchResults

      List<? extends BusinessObject> getSearchResults(Map<String,String> fieldValues)
      Deprecated.
      Performs a search and returns result list.
      Parameters:
      fieldValues - - Map of property/value pairs
      Returns:
      List of business objects found by the search
      Throws:
      Exception

    • getSearchResultsUnbounded

      List<? extends BusinessObject> getSearchResultsUnbounded(Map<String,String> fieldValues)
      Deprecated.
      Similar to getSearchResults, but the number of returned rows is not bounded
      Parameters:
      fieldValues -
      Returns:

    • getSearchResultsActualSizeKnown

      boolean getSearchResultsActualSizeKnown()
      Deprecated.
      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.
      Returns:
      boolean

    • getExtraButtonSource

      String getExtraButtonSource()
      Deprecated.
      Returns:
      String providing source for optional extra button

    • getExtraButtonParams

      String getExtraButtonParams()
      Deprecated.
      Returns:
      String providing return parameters for optional extra button

    • checkForAdditionalFields

      boolean checkForAdditionalFields(Map<String,String> fieldValues)
      Deprecated.
      Determines if there should be more search fields rendered based on already entered search criteria.
      Parameters:
      fieldValues - - Map of property/value pairs
      Returns:
      boolean

    • getReturnUrl

      HtmlData getReturnUrl(BusinessObject businessObject, Map<String,String> fieldConversions, String lookupImpl, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      Builds the return value url.
      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
      Returns:
      String url called when selecting a row from the result set

    • getCreateNewUrl

      String getCreateNewUrl()
      Deprecated.
      Builds the Url for a maintenance new document for the lookup business object class
      Parameters:
      businessObject -
      Returns:
      String rendered on Lookup screen for maintenance new document

    • setFieldConversions

      void setFieldConversions(Map<String,String> fieldConversions)
      Deprecated.
      Sets the requested fields conversions in the lookupable
      Parameters:
      fieldConversions -

    • setReadOnlyFieldsList

      void setReadOnlyFieldsList(List<String> readOnlyFieldsList)
      Deprecated.
      Sets the requested read only fields list in the lookupable
      Parameters:
      readOnlyFieldsList -

    • setLookupableHelperService

      void setLookupableHelperService(LookupableHelperService helper)
      Deprecated.
      Sets the helper service for instance
      Parameters:
      helper - the helper service

    • getLookupableHelperService

      LookupableHelperService getLookupableHelperService()
      Deprecated.
      Returns the LookupableHelperService designated to help this lookup
      Returns:

    • isSearchUsingOnlyPrimaryKeyValues

      boolean isSearchUsingOnlyPrimaryKeyValues()
      Deprecated.
      Returns whether this search was performed using the values of the primary keys only
      Returns:

    • getPrimaryKeyFieldLabels

      String getPrimaryKeyFieldLabels()
      Deprecated.
      Returns a comma delimited list of primary key field labels, as defined in the DD
      Returns:

    • getDefaultSortColumns

      List<String> getDefaultSortColumns()
      Deprecated.
      This method returns a list of the default columns used to sort the result set. For multiple value lookups, this method does not change when different columns are sorted.
      Returns:

    • performClear

      void performClear(LookupForm lookupForm)
      Deprecated.
      This method allows for customization of the lookup clear

    • shouldDisplayHeaderNonMaintActions

      boolean shouldDisplayHeaderNonMaintActions()
      Deprecated.
      This method checks whether the header non maint actions should be shown

    • shouldDisplayLookupCriteria

      boolean shouldDisplayLookupCriteria()
      Deprecated.
      This method checks whether the criteria should be shown

    • performCustomAction

      boolean performCustomAction(boolean ignoreErrors)
      Deprecated.
      This method is called from a custom action button or script

    • getExtraField

      Field getExtraField()
      Deprecated.
      get extra field
      Returns:

    • getExtraOnLoad

      String getExtraOnLoad()
      Deprecated.
      method returns the extraOnLoad variable. The varible is currently accessed in page.tag and is called in the onLoad. it allows us to inject javascript onload.

    • setExtraOnLoad

      void setExtraOnLoad(String extraOnLoad)
      Deprecated.

    • applyFieldAuthorizationsFromNestedLookups

      void applyFieldAuthorizationsFromNestedLookups(Field field)
      Deprecated.

    • applyConditionalLogicForFieldDisplay

      void applyConditionalLogicForFieldDisplay()
      Deprecated.
      Performs conditional logic (based on current search values or other parameters) to override field hidden, read-only, and required attributes previously set.