Package org.kuali.rice.kns.lookup

Interface LookupableHelperService

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractLookupableHelperServiceImpl, KualiLookupableHelperServiceImpl
@Deprecated public interface LookupableHelperService extends Serializable
Deprecated.
Only used in KNS classes, use KRAD.

  • Method Details

    • setBusinessObjectClass

      void setBusinessObjectClass(Class businessObjectClass)
      Deprecated.
      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.
      Parameters:
      businessObjectClass -

    • getBusinessObjectClass

      Class 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

    • 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

    • 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

    • 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 fieldConversions, String lookupImpl, List returnKeys, 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
      returnKeys - - Keys to return
      Returns:
      String url called when selecting a row from the result set

    • getReturnUrl

      HtmlData getReturnUrl(BusinessObject businessObject, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      This method builds the return url
      Parameters:
      businessObject -
      lookupForm -
      returnKeys -
      Returns:

    • getActionUrls

      String getActionUrls(BusinessObject businessObject, List pkNames, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      Builds string of action urls that can take place for a result row
      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

      List<HtmlData> getCustomActionUrls(BusinessObject businessObject, List pkNames)
      Deprecated.
      This method is a template method that allows child classes to return their own custom action html data.
      Parameters:
      businessObject -
      pkNames -
      Returns:

    • getInquiryUrl

      HtmlData getInquiryUrl(BusinessObject businessObject, String propertyName)
      Deprecated.
      Builds string an inquiry url for drill down on a result field
      Parameters:
      businessObject - - Instance of a business object containing the return values
      propertyName - - Name of the property in the business object
      Returns:
      String url called on selection of the result field

    • setFieldConversions

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

    • getReadOnlyFieldsList

      List<String> getReadOnlyFieldsList()
      Deprecated.
      Gets the readOnlyFieldsList attribute.
      Returns:
      Returns the readOnlyFieldsList.

    • setReadOnlyFieldsList

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

    • getReturnKeys

      List<String> getReturnKeys()
      Deprecated.
      This method is public because some unit tests depend on it.
      Returns:
      a List of the names of fields which are marked in data dictionary as return fields.

    • getDocFormKey

      String getDocFormKey()
      Deprecated.

    • setDocFormKey

      void setDocFormKey(String docFormKey)
      Deprecated.

    • getDocNum

      String getDocNum()
      Deprecated.

    • setDocNum

      void setDocNum(String docNum)
      Deprecated.

    • getMaintenanceUrl

      String getMaintenanceUrl(BusinessObject businessObject, HtmlData htmlData, List pkNames, BusinessObjectRestrictions businessObjectRestrictions)
      Deprecated.
      This method builds a maintenance url.
      Parameters:
      businessObject -
      htmlData -
      pkNames -
      Returns:

    • allowsMaintenanceNewOrCopyAction

      boolean allowsMaintenanceNewOrCopyAction()
      Deprecated.
      Determines if underlying lookup bo has associated maintenance document that allows new or copy maintenance actions.
      Returns:
      true if bo has maint doc that allows new or copy actions

    • allowsNewOrCopyAction

      boolean allowsNewOrCopyAction(String documentTypeName)
      Deprecated.
      Determines if underlying lookup bo has associated document that allows new or copy maintenance actions.
      Returns:
      true if bo has doc that allows new or copy actions

    • getRows

      List<Row> getRows()
      Deprecated.
      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
      Returns:

    • getDataDictionaryService

      DataDictionaryService getDataDictionaryService()
      Deprecated.
      This method returns the DataDictionaryService used to initialize this helper service and is used by Lookupable implementations to retrieve the proper service.
      Returns:

    • getBusinessObjectDictionaryService

      BusinessObjectDictionaryService getBusinessObjectDictionaryService()
      Deprecated.
      This method returns the BusinessObjectDictionaryService used to initialize this helper service and is used by Lookupable implementations to retrieve the proper service.
      Returns:

    • setBackLocation

      void setBackLocation(String backLocation)
      Deprecated.

    • getBackLocation

      String getBackLocation()
      Deprecated.

    • performLookup

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

    • 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:

    • isSearchUsingOnlyPrimaryKeyValues

      boolean isSearchUsingOnlyPrimaryKeyValues()
      Deprecated.
      This method returns whether the previously executed getSearchResults used the primary key values to search, ignoring all non key values
      Returns:
      See Also:

    • getPrimaryKeyFieldLabels

      String getPrimaryKeyFieldLabels()
      Deprecated.
      Returns a comma delimited list of primary key field labels, to be used on the UI to tell the user which fields were used to search
      Returns:
      See Also:

    • isResultReturnable

      boolean isResultReturnable(BusinessObject object)
      Deprecated.
      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).
      Parameters:
      object - an object from the search result set
      Returns:

    • performClear

      void performClear(LookupForm lookupForm)
      Deprecated.
      This method allows for overriding the clear behavior

    • shouldDisplayHeaderNonMaintActions

      boolean shouldDisplayHeaderNonMaintActions()
      Deprecated.

    • shouldDisplayLookupCriteria

      boolean shouldDisplayLookupCriteria()
      Deprecated.

    • getSupplementalMenuBar

      String getSupplementalMenuBar()
      Deprecated.
      This method gets the supplemental lookup menu if any
      Returns:
      supplemental menu bar

    • getTitle

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

    • performCustomAction

      boolean performCustomAction(boolean ignoreErrors)
      Deprecated.
      performs custom actions. return true to reperform search
      Parameters:
      ignoreErrors -
      Returns:
      boolean to reperform search

    • getExtraField

      Field getExtraField()
      Deprecated.
      get an extra field
      Returns:

    • 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.