1 /**
2 * Copyright 2005-2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.framework.document.search;
17
18 import org.kuali.rice.kew.api.document.attribute.DocumentAttributeContract;
19
20 import java.util.List;
21 import java.util.Map;
22
23 /**
24 * Defines the contract for an object containing a customized result value for a specific document which is part of a
25 * set of document search results.
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 */
29 public interface DocumentSearchResultValueContract {
30
31 /**
32 * Returns the id of the document for which this customized result value applies.
33 *
34 * @return the document id of the customized document search result
35 */
36 String getDocumentId();
37
38 /**
39 * Returns the customized document attribute values for this document search result.
40 *
41 * @return the customized document attribute values for this document search result
42 */
43 List<? extends DocumentAttributeContract> getDocumentAttributes();
44
45 }