Interface DocumentSearchCriteriaTranslator

All Known Implementing Classes:
DocumentSearchCriteriaTranslatorImpl

public interface DocumentSearchCriteriaTranslator
Handles translating between parameters submitted to the document search and DocumentSearchCriteria.
Author:
Kuali Rice Team (rice.collab@kuali.org)
  • Method Summary

    Modifier and Type
    Method
    Description
    translateCriteriaToFields(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria criteria)
    Translates the given DocumentSearchCriteria into a map of fields values.
    org.kuali.rice.kew.api.document.search.DocumentSearchCriteria
    Translates the given map of fields values into a DocumentSearchCriteria.
  • Method Details

    • translateFieldsToCriteria

      org.kuali.rice.kew.api.document.search.DocumentSearchCriteria translateFieldsToCriteria(Map<String,String> fieldValues)
      Translates the given map of fields values into a DocumentSearchCriteria. The given map of field values is keyed based on the name of the field being submitted and the value represents that field value, which may contain wildcards and other logical operators supported by the KNS lookup framework.
      Parameters:
      fieldValues - the map of field names and values from which to populate the criteria
      Returns:
      populated document search criteria which contains the various criteria components populated based on the interpretation of the given field values
    • translateCriteriaToFields

      Map<String,String[]> translateCriteriaToFields(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria criteria)
      Translates the given DocumentSearchCriteria into a map of fields values. Reverse of translateFieldsToCriteria(java.util.Map)
      Parameters:
      criteria - document search criteria
      Returns:
      Map populated with the various criteria components