01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.php
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package edu.iu.uis.eden.docsearch;
18:
19: import java.sql.ResultSet;
20: import java.sql.SQLException;
21: import java.util.List;
22:
23: import edu.iu.uis.eden.WorkflowServiceError;
24: import edu.iu.uis.eden.exception.EdenUserNotFoundException;
25: import edu.iu.uis.eden.user.WorkflowUser;
26:
27: /**
28: * TODO delyea - documentation
29: * @author delyea
30: */
31: public interface DocumentSearchGenerator {
32: public void setSearchableAttributes(List searchableAttributes);
33:
34: public void setSearchingUser(WorkflowUser searchingUser);
35:
36: public List<WorkflowServiceError> performPreSearchConditions(
37: WorkflowUser user, DocSearchCriteriaVO searchCriteria);
38:
39: public List<WorkflowServiceError> validateSearchableAttributes(
40: DocSearchCriteriaVO searchCriteria);
41:
42: public String generateSearchSql(DocSearchCriteriaVO searchCriteria)
43: throws EdenUserNotFoundException;
44:
45: public List<DocSearchVO> processResultSet(ResultSet resultSet,
46: DocSearchCriteriaVO searchCriteria)
47: throws EdenUserNotFoundException, SQLException;
48:
49: public DocSearchCriteriaVO clearSearch(
50: DocSearchCriteriaVO searchCriteria);
51: }
|