Response.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.nest.internal.messages;

/**
 * Base interface for all Nest API responses.
 *
 * @author John Cocula
 * @since 1.7.0
 */
public interface Response {

    /**
     * Return the response message, or <code>null</code> if there is none.
     * 
     * @return the response message
     */
    String getError();

    /**
     * Checks if this response contained an error.
     * 
     * @return <code>true</code> if the response contained an error instead of actual data.
     */
    boolean isError();
}