/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2010, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.xal.model;

/**
 * <p>This interface maps premiseNumberRange element.</p>
 *
 * <p>Specification for defining the premise number range. Some premises have number as Building C1-C7.</p>
 *
 * <pre>
 * <xs:element name="PremiseNumberRange">
 *  <xs:complexType>
 *      <xs:sequence>
 *          <xs:element name="PremiseNumberRangeFrom">...
 *          </xs:element>
 *          <xs:element name="PremiseNumberRangeTo">...
 *          </xs:element>
 *      </xs:sequence>
 *      <xs:attribute name="RangeType">...
 *      </xs:attribute>
 *      <xs:attribute name="Indicator">...
 *      </xs:attribute>
 *      <xs:attribute name="Separator">...
 *      </xs:attribute>
 *      <xs:attribute name="Type"/>
 *      <xs:attribute name="IndicatorOccurence">...
 *      </xs:attribute>
 *      <xs:attribute name="NumberRangeOccurence">...
 *      </xs:attribute>
 *  </xs:complexType>
 * </xs:element>
 * </pre>
 *
 * @author Samuel Andrés
 * @module
 */
public interface PremiseNumberRange {

    /**
     *
     * @return
     */
    PremiseNumberRangeFrom getPremiseNumberRangeFrom();
    
    /**
     * 
     * @return
     */
    PremiseNumberRangeTo getPremiseNumberRangeTo();
    
    /**
     * <p>Eg. Odd or even number range.</p>
     * 
     * @return
     */
    String getRangeType();
    
    /**
     * <p>Eg. No. in Building No:C1-C5</p>
     * 
     * @return
     */
    String getIndicator();
    
    /**
     * <p>"-" in 12-14  or "Thru" in 12 Thru 14 etc.</p>
     * 
     * @return
     */
    String getSeparator();
    
    /**
     * 
     * @return
     */
    String getType();
    
    /**
     * <p>No.12-14 where "No." is before actual street number.</p>
     * 
     * @return
     */
    AfterBeforeEnum getIndicatorOccurrence();
    
    /**
     * <p>Building 23-25 where the number occurs after building name.</p>
     * 
     * @return
     */
    AfterBeforeTypeNameEnum getNumberRangeOccurrence();

    /**
     *
     * @param premiseNumberRangeFrom
     */
    void setPremiseNumberRangeFrom(PremiseNumberRangeFrom premiseNumberRangeFrom);

    /**
     *
     * @param premiseNumberRangeTo
     */
    void setPremiseNumberRangeTo(PremiseNumberRangeTo premiseNumberRangeTo);

    /**
     *
     * @param rangeType
     */
    void setRangeType(String rangeType);

    /**
     * 
     * @param indicator
     */
    void setIndicator(String indicator);

    /**
     *
     * @param separator
     */
    void getSeparator(String separator);

    /**
     *
     * @param type
     */
    void getType(String type);

    /**
     *
     * @param indicatorOccurrence
     */
    void setIndicatorOccurrence(AfterBeforeEnum indicatorOccurrence);

    /**
     *
     * @param numberRangeOccurrence
     */
    void setNumberRangeOccurrence(AfterBeforeTypeNameEnum numberRangeOccurrence);
}