001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.jsp.search.config.parser.simplesearch.daterestrictions; 029 030/** 031 * Interface for date restrictions used in list configurations.<p> 032 */ 033public interface I_CmsDateRestriction { 034 035 /** 036 * Enum representing a direction in time (past / future). 037 */ 038 enum TimeDirection { 039 /** Going backward in time. */ 040 past, 041 042 /** Going forward in time. */ 043 future 044 } 045 046 /** 047 * Enum representing a time unit.<p> 048 */ 049 enum TimeUnit { 050 /** Days. */ 051 DAYS, 052 053 /** Weeks. */ 054 WEEKS, 055 056 /** Months. */ 057 MONTHS, 058 059 /** Years. */ 060 YEARS; 061 062 /** 063 * Formats a positive integer amount of the given unit for use in Solr range queries.<p> 064 * 065 * @param count the number 066 * 067 * @return the formatted value 068 */ 069 public String formatForRange(int count) { 070 071 if (this == WEEKS) { 072 return (7 * count) + "DAYS"; 073 } else { 074 return "" + count + toString(); 075 } 076 } 077 } 078 079 /** 080 * Gets the formatted range expression for this restriction, for use in Solr date range queries.<p> 081 * 082 * @return the date range expression 083 */ 084 String getRange(); 085 086}