001/** 002 * 003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved. 004 * 005 * This library is free software; you can redistribute it and/or 006 * modify it under the terms of the GNU Lesser General Public 007 * License as published by the Free Software Foundation; either 008 * version 2.1 of the License, or (at your option) any later version. 009 * 010 * This library is distributed in the hope that it will be useful, 011 * but WITHOUT ANY WARRANTY; without even the implied warranty of 012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013 * Lesser General Public License for more details. 014 * 015 * You should have received a copy of the GNU Lesser General Public 016 * License along with this library. If not, see <http://www.gnu.org/licenses/>. 017 * 018 **/ 019package lucee.runtime.search; 020 021/** 022 * a singl result item 023 */ 024public interface SearchResulItem { 025 026 /** 027 * @return Returns the recordsSearched. 028 */ 029 public abstract int getRecordsSearched(); 030 031 /** 032 * @return Returns the score. 033 */ 034 public abstract float getScore(); 035 036 /** 037 * @return Returns the summary. 038 */ 039 public abstract String getSummary(); 040 041 /** 042 * @return Returns the title. 043 */ 044 public abstract String getTitle(); 045 046 /** 047 * @return Returns the id. 048 */ 049 public abstract String getId(); 050 051 /** 052 * @return Returns the key 053 */ 054 public abstract String getKey(); 055 056 /** 057 * @return Returns the url 058 */ 059 public abstract String getUrl(); 060 061 /** 062 * @deprecated use instead <code>getCustom(int index)</code> 063 * @return Returns the custom1. 064 */ 065 public abstract String getCustom1(); 066 067 /** 068 * @deprecated use instead <code>getCustom(int index)</code> 069 * @return Returns the custom2. 070 */ 071 public abstract String getCustom2(); 072 073 /** 074 * @deprecated use instead <code>getCustom(int index)</code> 075 * @return Returns the custom3. 076 */ 077 public abstract String getCustom3(); 078 079 /** 080 * @deprecated use instead <code>getCustom(int index)</code> 081 * @return Returns the custom4. 082 */ 083 public abstract String getCustom4(); 084 085 public abstract String getCustom(int index) throws SearchException; 086 087 088 089 /** 090 * @return the category 091 */ 092 public String getCategory(); 093 094 /** 095 * @return the categoryTree 096 */ 097 public String getCategoryTree(); 098 099 /** 100 * @return the mimeType 101 */ 102 public String getMimeType(); 103 /** 104 * @return the author 105 */ 106 public String getAuthor(); 107 108 /** 109 * @return the size 110 */ 111 public String getSize(); 112 113 114 /** 115 * @return the contextSummary 116 */ 117 public String getContextSummary(); 118 119}