001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kew.impl.document.search;
017    
018    import org.kuali.rice.core.api.uif.RemotableAttributeError;
019    import org.kuali.rice.core.api.uif.RemotableAttributeField;
020    import org.kuali.rice.kew.api.document.search.DocumentSearchCriteria;
021    import org.kuali.rice.kew.api.document.search.DocumentSearchResults;
022    
023    import java.sql.ResultSet;
024    import java.sql.SQLException;
025    import java.sql.Statement;
026    import java.util.List;
027    
028    
029    /**
030     * Handles various functions related to generation and processing of document searches.
031     * 
032     * @author Kuali Rice Team (rice.collab@kuali.org)
033     */
034    public interface DocumentSearchGenerator {
035    
036        List<RemotableAttributeError> validateSearchableAttributes(DocumentSearchCriteria.Builder criteria);
037    
038        String generateSearchSql(DocumentSearchCriteria criteria, List<RemotableAttributeField> searchFields);
039    
040        DocumentSearchResults.Builder processResultSet(DocumentSearchCriteria criteria, boolean criteriaModified, Statement searchAttributeStatement, ResultSet resultSet, int actualMaxResults, int fetchLimit) throws SQLException;
041        
042        DocumentSearchCriteria clearSearch(DocumentSearchCriteria criteria);
043    
044    }