001    /*
002     * Copyright 2011-2012 UnboundID Corp.
003     *
004     * This program is free software; you can redistribute it and/or modify
005     * it under the terms of the GNU General Public License (GPLv2 only)
006     * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
007     * as published by the Free Software Foundation.
008     *
009     * This program is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012     * GNU General Public License for more details.
013     *
014     * You should have received a copy of the GNU General Public License
015     * along with this program; if not, see <http://www.gnu.org/licenses>.
016     */
017    
018    package com.unboundid.scim.sdk;
019    
020    
021    import com.unboundid.scim.marshal.Marshaller;
022    
023    import java.io.OutputStream;
024    
025    /**
026     * This class represents the response to a SCIM request.
027     */
028    public interface SCIMResponse
029    {
030      /**
031       * Marshals this response using the specified <code>Marshaller</code> to the
032       * specified <code>OutputStream</code>.
033       *
034       * @param marshaller The <code>Marshaller</code> to use.
035       * @param outputStream The <code>OutputStream</code> to write to.
036       * @throws Exception if an error occurs while performing the marshaling.
037       */
038      void marshal(Marshaller marshaller, OutputStream outputStream)
039          throws Exception;
040    }