Coverage Report - org.kuali.rice.kew.framework.document.search.DocumentSearchResultValuesContract
 
Classes in this File Line Coverage Branch Coverage Complexity
DocumentSearchResultValuesContract
N/A
N/A
1
 
 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 java.util.List;
 19  
 
 20  
 /**
 21  
  * Defines the contract for an object containing result values that are used to customize document search results.
 22  
  * Defines a set of additional custom values for document search results that can be defined and returned by an
 23  
  * application which is customizing the document search for a specific document type.
 24  
  *
 25  
  * @author Kuali Rice Team (rice.collab@kuali.org)
 26  
  */
 27  
 public interface DocumentSearchResultValuesContract {
 28  
 
 29  
     /**
 30  
      * Returns an unmodifiable list of the result values, one for each customized document.
 31  
      *
 32  
      * @return the list of customized document search result values, will never be null but may be empty
 33  
      */
 34  
     List<? extends DocumentSearchResultValueContract> getResultValues();
 35  
 
 36  
 }