/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008 - 2009, 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.csw.xml.v202;

import java.util.Objects;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import org.geotoolkit.csw.xml.GetRecordsResponse;


/**
 * 
 * The response message for a GetRecords request. Some or all of the 
 * matching records may be included as children of the SearchResults 
 * element. The RequestId is only included if the client specified it.
 *          
 * 
 * <p>Java class for GetRecordsResponseType complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <complexType name="GetRecordsResponseType">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element name="RequestId" type="{http://www.w3.org/2001/XMLSchema}anyURI" minOccurs="0"/>
 *         <element name="SearchStatus" type="{http://www.opengis.net/cat/csw/2.0.2}RequestStatusType"/>
 *         <element name="SearchResults" type="{http://www.opengis.net/cat/csw/2.0.2}SearchResultsType"/>
 *       </sequence>
 *       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * </pre>
 * 
 * 
 * @module
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "GetRecordsResponseType", propOrder = {
    "requestId",
    "searchStatus",
    "searchResults"
})
@XmlRootElement(name = "GetRecordsResponse" )        
public class GetRecordsResponseType implements GetRecordsResponse {

    @XmlElement(name = "RequestId")
    @XmlSchemaType(name = "anyURI")
    private String requestId;
    @XmlElement(name = "SearchStatus", required = true)
    private RequestStatusType searchStatus;
    @XmlElement(name = "SearchResults", required = true)
    private SearchResultsType searchResults;
    @XmlAttribute
    private String version;

    /**
     * An empty constructor used by JAXB
     */
    GetRecordsResponseType() {
        
    }
    
    /**
     * Build a new response to a getRecords request
     */
    public GetRecordsResponseType(final String requestId, final long time, final String version, final SearchResultsType searchResults) {
        this.requestId     = requestId;
        this.searchStatus  = new RequestStatusType(time);
        this.version       = version;
        this.searchResults = searchResults;
        
    }
    
    /**
     * Gets the value of the requestId property.
     */
    @Override
    public String getRequestId() {
        return requestId;
    }

    /**
     * Gets the value of the searchStatus property.
     */
    @Override
    public RequestStatusType getSearchStatus() {
        return searchStatus;
    }

    /**
     * Gets the value of the searchResults property.
     */
    @Override
    public SearchResultsType getSearchResults() {
        return searchResults;
    }

    /**
     * Gets the value of the version property.
     */
    @Override
    public String getVersion() {
        return version;
    }
    
    @Override
    public void setRequestId(final String value) {
        this.requestId = value;
    }

    @Override
    public void setVersion(final String value) {
        this.version = value;
    }
    
    @Override
    public String toString() {
        StringBuilder s = new StringBuilder("[GetRecordsResponseType] version=").append(version).append(":").append('\n');
        if (requestId != null) {
            s.append("Request ID: ").append(requestId).append('\n');
        }
        if (searchStatus != null) {
            s.append("searchStatus: ").append(searchStatus).append('\n');
        }
        if (searchResults != null) {
            s.append("searchResult: ").append(searchResults).append('\n');
        }
        return s.toString();
    }

    @Override
    public boolean equals(final Object object) {
        if (object == this) {
            return true;
        }
        if (object instanceof GetRecordsResponseType) {
            final GetRecordsResponseType that = (GetRecordsResponseType) object;
            return Objects.equals(this.requestId,     that.requestId)     &&
                   Objects.equals(this.searchResults, that.searchResults) &&
                   Objects.equals(this.searchStatus,  that.searchStatus)  &&
                   Objects.equals(this.version,       that.version);
        }
        return false;
    }

    @Override
    public int hashCode() {
        int hash = 5;
        hash = 59 * hash + (this.requestId != null ? this.requestId.hashCode() : 0);
        hash = 59 * hash + (this.searchStatus != null ? this.searchStatus.hashCode() : 0);
        hash = 59 * hash + (this.searchResults != null ? this.searchResults.hashCode() : 0);
        hash = 59 * hash + (this.version != null ? this.version.hashCode() : 0);
        return hash;
    }
}