001    /**
002     * Copyright 2005-2012 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.framework.document.search;
017    
018    import java.util.List;
019    
020    /**
021     * Defines the contract for an object containing result values that are used to customize document search results.
022     * Defines a set of additional custom values for document search results that can be defined and returned by an
023     * application which is customizing the document search for a specific document type.
024     *
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public interface DocumentSearchResultValuesContract {
028    
029        /**
030         * Returns an unmodifiable list of the result values, one for each customized document.
031         *
032         * @return the list of customized document search result values, will never be null but may be empty
033         */
034        List<? extends DocumentSearchResultValueContract> getResultValues();
035    
036    }