001/**
002 * Copyright 2005-2017 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 */
016package org.kuali.rice.kew.framework.document.search;
017
018import org.kuali.rice.kew.api.document.attribute.DocumentAttributeContract;
019
020import java.util.List;
021import java.util.Map;
022
023/**
024 * Defines the contract for an object containing a customized result value for a specific document which is part of a
025 * set of document search results.
026 *
027 * @author Kuali Rice Team (rice.collab@kuali.org)
028 */
029public interface DocumentSearchResultValueContract {
030
031    /**
032     * Returns the id of the document for which this customized result value applies.
033     *
034     * @return the document id of the customized document search result
035     */
036    String getDocumentId();
037
038    /**
039     * Returns the customized document attribute values for this document search result.
040     *
041     * @return the customized document attribute values for this document search result
042     */
043    List<? extends DocumentAttributeContract> getDocumentAttributes();
044
045}