Package org.kuali.rice.kns.lookup

Class KualiLookupableImpl

java.lang.Object
org.kuali.rice.kns.lookup.KualiLookupableImpl
All Implemented Interfaces:
Serializable, Lookupable
@Deprecated @Transactional public class KualiLookupableImpl extends Object implements Lookupable
Deprecated.
Kuali lookup implementation. Implements methods necessary to render the lookup and provides search and return methods.
See Also:

  • Field Details

    • IGNORE_LIST

      protected static final String[] IGNORE_LIST
      Deprecated.

    • businessObjectClass

      protected Class businessObjectClass
      Deprecated.

    • lookupableHelperService

      protected LookupableHelperService lookupableHelperService
      Deprecated.

    • extraOnLoad

      protected String extraOnLoad
      Deprecated.

  • Constructor Details

    • KualiLookupableImpl

      public KualiLookupableImpl()
      Deprecated.
      Default constructor initializes services from spring

  • Method Details

    • setBusinessObjectClass

      public void setBusinessObjectClass(Class boClass)
      Deprecated.
      Sets the business object class for the lookup instance, then rows can be set for search render.
      Specified by:
      setBusinessObjectClass in interface Lookupable
      Parameters:
      boClass - Class for the lookup business object

    • setParameters

      public void setParameters(Map<String,String[]> parameters)
      Deprecated.
      Initializes the lookup with the given Map of parameters.
      Specified by:
      setParameters in interface Lookupable
      Parameters:
      parameters -

    • getParameters

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

    • 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 Lookupable
      Returns:
      List of Column objects used to render the result table

    • validateSearchParameters

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

    • getSearchResultsUnbounded

      public List<? extends BusinessObject> getSearchResultsUnbounded(Map<String,String> fieldValues)
      Deprecated.
      Uses Lookup Service to provide a basic unbounded search.
      Specified by:
      getSearchResultsUnbounded in interface Lookupable
      Parameters:
      fieldValues - - Map containing prop name keys and search values
      Returns:
      List found business objects

    • getSearchResultsActualSizeKnown

      public boolean getSearchResultsActualSizeKnown()
      Deprecated.
      Description copied from interface: Lookupable
      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 Lookupable
      Returns:
      boolean

    • getSearchResults

      public List<? extends BusinessObject> getSearchResults(Map<String,String> fieldValues)
      Deprecated.
      Uses Lookup Service to provide a basic search.
      Specified by:
      getSearchResults in interface Lookupable
      Parameters:
      fieldValues - - Map containing prop name keys and search values
      Returns:
      List found business objects

    • getReturnUrl

      public HtmlData getReturnUrl(BusinessObject bo, Map fieldConversions, String lookupImpl, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      Description copied from interface: Lookupable
      Builds the return value url.
      Specified by:
      getReturnUrl in interface Lookupable
      Parameters:
      bo - - 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:
      the return url for each result row.

    • getCreateNewUrl

      public String getCreateNewUrl()
      Deprecated.
      Description copied from interface: Lookupable
      Builds the Url for a maintenance new document for the lookup business object class
      Specified by:
      getCreateNewUrl in interface Lookupable
      Returns:
      String rendered on Lookup screen for maintenance new document
      See Also:

    • getHtmlMenuBar

      public String getHtmlMenuBar()
      Deprecated.
      Specified by:
      getHtmlMenuBar in interface Lookupable
      Returns:
      the html to be displayed as a menu bar
      See Also:

    • getSupplementalMenuBar

      public String getSupplementalMenuBar()
      Deprecated.
      Specified by:
      getSupplementalMenuBar in interface Lookupable
      Returns:
      the html to be displayed as a supplemental menu bar
      See Also:

    • getRows

      public List<Row> getRows()
      Deprecated.
      Specified by:
      getRows in interface Lookupable
      Returns:
      List of Row objects used to render the search area
      See Also:

    • getTitle

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

    • getReturnLocation

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

    • getBusinessObjectClass

      public Class getBusinessObjectClass()
      Deprecated.
      Specified by:
      getBusinessObjectClass in interface Lookupable
      Returns:
      Returns the dataObjectClass.

    • getReturnKeys

      public List<String> getReturnKeys()
      Deprecated.
      Returns:
      a List of the names of fields which are marked in data dictionary as return fields.

    • getExtraButtonSource

      public String getExtraButtonSource()
      Deprecated.
      Specified by:
      getExtraButtonSource in interface Lookupable
      Returns:
      String providing source for optional extra button
      See Also:

    • getExtraButtonParams

      public String getExtraButtonParams()
      Deprecated.
      Specified by:
      getExtraButtonParams in interface Lookupable
      Returns:
      String providing return parameters for optional extra button
      See Also:

    • getDefaultSortColumns

      public List<String> getDefaultSortColumns()
      Deprecated.
      Description copied from interface: Lookupable
      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.
      Specified by:
      getDefaultSortColumns in interface Lookupable
      Returns:
      property names that will be used to sort on by default

    • checkForAdditionalFields

      public boolean checkForAdditionalFields(Map<String,String> fieldValues)
      Deprecated.
      Description copied from interface: Lookupable
      Determines if there should be more search fields rendered based on already entered search criteria.
      Specified by:
      checkForAdditionalFields in interface Lookupable
      Parameters:
      fieldValues - - Map of property/value pairs
      Returns:
      boolean
      See Also:

    • getBackLocation

      public String getBackLocation()
      Deprecated.
      Returns:
      Returns the backLocation.

    • setBackLocation

      public void setBackLocation(String backLocation)
      Deprecated.
      Parameters:
      backLocation - The backLocation to set.

    • getDocFormKey

      public String getDocFormKey()
      Deprecated.
      Returns:
      Returns the docFormKey.

    • setDocFormKey

      public void setDocFormKey(String docFormKey)
      Deprecated.
      // this method is public because unit tests depend upon it
      Parameters:
      docFormKey - The docFormKey to set.

    • getBusinessObjectDictionaryService

      protected BusinessObjectDictionaryService getBusinessObjectDictionaryService()
      Deprecated.
      Returns:
      Returns the businessObjectDictionaryService.

    • setFieldConversions

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

    • getDataDictionaryService

      protected DataDictionaryService getDataDictionaryService()
      Deprecated.
      Returns:
      Returns the dataDictionaryService.

    • setReadOnlyFieldsList

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

    • getLookupableHelperService

      public LookupableHelperService getLookupableHelperService()
      Deprecated.
      Description copied from interface: Lookupable
      Returns the LookupableHelperService designated to help this lookup
      Specified by:
      getLookupableHelperService in interface Lookupable
      Returns:

    • setLookupableHelperService

      public void setLookupableHelperService(LookupableHelperService lookupableHelperService)
      Deprecated.
      Sets the lookupableHelperService attribute value.
      Specified by:
      setLookupableHelperService in interface Lookupable
      Parameters:
      lookupableHelperService - The lookupableHelperService to set.

    • performLookup

      public Collection<? extends BusinessObject> performLookup(LookupForm lookupForm, List<ResultRow> resultTable, boolean bounded)
      Deprecated.
      Performs a lookup that can only return one row.
      Specified by:
      performLookup in interface Lookupable
      Parameters:
      lookupForm -
      resultTable -
      bounded -
      Returns:
      results of lookup
      See Also:

    • isSearchUsingOnlyPrimaryKeyValues

      public boolean isSearchUsingOnlyPrimaryKeyValues()
      Deprecated.
      Description copied from interface: Lookupable
      Returns whether this search was performed using the values of the primary keys only
      Specified by:
      isSearchUsingOnlyPrimaryKeyValues in interface Lookupable
      Returns:

    • getPrimaryKeyFieldLabels

      public String getPrimaryKeyFieldLabels()
      Deprecated.
      Description copied from interface: Lookupable
      Returns a comma delimited list of primary key field labels, as defined in the DD
      Specified by:
      getPrimaryKeyFieldLabels in interface Lookupable
      Returns:

    • performClear

      public void performClear(LookupForm lookupForm)
      Deprecated.
      calls the lookup helper service to do "clear" behaviors
      Specified by:
      performClear in interface Lookupable
      See Also:
      • invalid reference 
        Lookupable#performClear()

    • shouldDisplayHeaderNonMaintActions

      public boolean shouldDisplayHeaderNonMaintActions()
      Deprecated.
      calls the lookup helper service to check if non maintenance actions should be displayed
      Specified by:
      shouldDisplayHeaderNonMaintActions in interface Lookupable
      See Also:

    • shouldDisplayLookupCriteria

      public boolean shouldDisplayLookupCriteria()
      Deprecated.
      calls the lookup helper service to check if criteria should be displayed
      Specified by:
      shouldDisplayLookupCriteria in interface Lookupable
      See Also:

    • getCreateNewUrl

      protected String getCreateNewUrl(String url)
      Deprecated.

    • performCustomAction

      public boolean performCustomAction(boolean ignoreErrors)
      Deprecated.
      Description copied from interface: Lookupable
      This method is called from a custom action button or script
      Specified by:
      performCustomAction in interface Lookupable

    • getExtraField

      public Field getExtraField()
      Deprecated.
      Description copied from interface: Lookupable
      get extra field
      Specified by:
      getExtraField in interface Lookupable
      Returns:

    • applyFieldAuthorizationsFromNestedLookups

      public void applyFieldAuthorizationsFromNestedLookups(Field field)
      Deprecated.
      Specified by:
      applyFieldAuthorizationsFromNestedLookups in interface Lookupable

    • getExtraOnLoad

      public String getExtraOnLoad()
      Deprecated.
      This overridden 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.
      Specified by:
      getExtraOnLoad in interface Lookupable
      See Also:

    • setExtraOnLoad

      public void setExtraOnLoad(String extraOnLoad)
      Deprecated.
      Specified by:
      setExtraOnLoad in interface Lookupable
      Parameters:
      extraOnLoad - the extraOnLoad to set

    • applyConditionalLogicForFieldDisplay

      public void applyConditionalLogicForFieldDisplay()
      Deprecated.
      Description copied from interface: Lookupable
      Performs conditional logic (based on current search values or other parameters) to override field hidden, read-only, and required attributes previously set.
      Specified by:
      applyConditionalLogicForFieldDisplay in interface Lookupable
      See Also: