/**
    * Copyright 2005-2012 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.opensource.org/licenses/ecl2.php
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.rice.kew.impl.document.search;
  
  import org.kuali.rice.core.api.uif.RemotableAttributeError;
  import org.kuali.rice.core.api.uif.RemotableAttributeField;
  import org.kuali.rice.kew.api.document.search.DocumentSearchCriteria;
  import org.kuali.rice.kew.api.document.search.DocumentSearchResults;
  
  import java.sql.ResultSet;
  import java.sql.SQLException;
  import java.sql.Statement;
  import java.util.List;
  
  
  /**
   * Handles various functions related to generation and processing of document searches.
   * 
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public interface DocumentSearchGenerator {
  
      List<RemotableAttributeError> validateSearchableAttributes(DocumentSearchCriteria.Builder criteria);
  
      String generateSearchSql(DocumentSearchCriteria criteria, List<RemotableAttributeField> searchFields);
  
      DocumentSearchResults.Builder processResultSet(DocumentSearchCriteria criteria, boolean criteriaModified, Statement searchAttributeStatement, ResultSet resultSet, int actualMaxResults, int fetchLimit) throws SQLException;
      
      DocumentSearchCriteria clearSearch(DocumentSearchCriteria criteria);
  
  }