/*
 *    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 AddressDetails type.</p>
 *
 * <p>This container defines the details of the address.
 * Can define multiple addresses including tracking address history.</p>
 *
 * <pre>
 * <xs:element name="AddressDetails" type="AddressDetails">...
 * </xs:element>
 *
 * <xs:complexType name="AddressDetails">
 *  <xs:sequence>
 *      <xs:element name="PostalServiceElements" minOccurs="0">...
 *      </xs:element>
 *      <xs:choice minOccurs="0">
 *          <xs:element name="Address">...
 *          </xs:element>
 *          <xs:element name="AddressLines" type="AddressLinesType">...
 *          </xs:element>
 *          <xs:element name="Country">...
 *          </xs:element>
 *          <xs:element ref="AdministrativeArea"/>
 *          <xs:element ref="Locality"/>
 *          <xs:element ref="Thoroughfare"/>
 *      </xs:choice>
 *      <xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
 *  </xs:sequence>
 *  <xs:attribute name="AddressType">...
 *  </xs:attribute>
 *  <xs:attribute name="CurrentStatus">...
 *  </xs:attribute>
 *  <xs:attribute name="ValidFromDate">...
 *  </xs:attribute>
 *  <xs:attribute name="ValidToDate">...
 *  </xs:attribute>
 *  <xs:attribute name="Usage">...
 *  </xs:attribute>
 *  <xs:attributeGroup ref="grPostal"/>
 *  <xs:attribute name="AddressDetailsKey">...
 *  </xs:attribute>
 *  <xs:anyAttribute namespace="##other"/>
 * </xs:complexType>
 * </pre>
 *
 * @author Samuel Andrés
 * @module
 */
public interface AddressDetails {

    /**
     *
     * @return
     */
    PostalServiceElements getPostalServiceElements();

    /**
     *
     * @param postalServiceElements
     */
    void setPostalServiceElements(PostalServiceElements postalServiceElements);

    /*
     * === CHOICE: ===
     * Use the most suitable option. Country contains the most detailed
     information while Locality is missing Country and AdminArea.
     */

    /**
     *
     * @return
     */
    GenericTypedGrPostal getAddress();

    /**
     * 
     * @param address
     */
    void setAddress(GenericTypedGrPostal address);

    /**
     *
     * @return
     */
    AddressLines getAddressLines();

    /**
     *
     * @param addressLines
     */
    void setAddressLines(AddressLines addressLines);

    /**
     *
     * @return
     */
    Country getCountry();

    /**
     * 
     * @param country
     */
    void setCountry(Country country);

    /**
     *
     * @return
     */
    AdministrativeArea getAdministrativeArea();

    /**
     * 
     * @param administrativeArea
     */
    void setAdministrativeArea(AdministrativeArea administrativeArea);

    /**
     *
     * @return
     */
    Locality getLocality();

    /**
     * 
     * @param locality
     */
    void setLocality(Locality locality);

    /**
     *
     * @return
     */
    Thoroughfare getThoroughfare();

    /**
     * 
     * @param throughfare
     */
    void setThoroughfare(Thoroughfare throughfare);

    /*
     * === END OF THE CHOICE ===
     *
     * === ATTRIBUTES: ===
     */

    /**
     * <p>Type of address. Example: Postal, residential,business, primary, secondary, etc.</p>
     * 
     * @return
     */
    String getAddressType();

    /**
     *
     * @param addressType
     */
    void setAddressType(String addressType);

    /**
     * <p>Moved, Living, Investment, Deceased, etc...</p>
     * @return
     */
    String getCurrentStatus();

    /**
     *
     * @param currentStatus
     */
    void setCurrentStatus(String currentStatus);

    /**
     * <p>Start Date of the validity of address</p>
     *
     * @return
     */
    String getValidFromDate();

    /**
     * 
     * @param validFromDate
     */
    void setValidFromDate(String validFromDate);

    /**
     * <p>End date of the validity of address</p>
     *
     * @return
     */
    String getValidToDate();

    /**
     * 
     * @param validToDate
     */
    void setValidToDate(String validToDate);

    /**
     * <p>Communication, Contact, etc.</p>
     * 
     * @return
     */
    String getUsage();

    /**
     * 
     * @param usage
     */
    void setUsage(String usage);

    /**
     *
     * @return
     */
    GrPostal getGrPostal();

    /**
     * 
     * @param grPostal
     */
    void setGrPostal(GrPostal grPostal);

    /**
     * <p>Key identifier for the element for not reinforced references
     * from other elements. Not required to be unique for the document
     * to be valid, but application may get confused if not unique.
     * Extend this schema adding unique contraint if needed.</p>
     *
     * @return
     */
    String getAddressDetailsKey();
    
    /**
     * 
     * @param addressDetailsKey
     */
    void setAddressDetailsKey(String addressDetailsKey);
}