001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016
017package org.forgerock.json.resource;
018
019import org.forgerock.http.routing.Version;
020
021/**
022 * Common response object of all resource responses.
023 */
024public interface Response {
025
026    /**
027     * Sets the API version of the resource that the request was routed to.
028     *
029     * @param version The resource API version.
030     */
031    void setResourceApiVersion(Version version);
032
033    /**
034     * Gets the API version of the resource that the request was routed to.
035     *
036     * @return The resource API version.
037     */
038    Version getResourceApiVersion();
039}