001/* ***** BEGIN LICENSE BLOCK *****
002 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
003 *
004 * The contents of this file are subject to the Mozilla Public License Version
005 * 1.1 (the "License"); you may not use this file except in compliance with
006 * the License. You may obtain a copy of the License at
007 * http://www.mozilla.org/MPL/
008 *
009 * Software distributed under the License is distributed on an "AS IS" basis,
010 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
011 * for the specific language governing rights and limitations under the
012 * License.
013 *
014 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
015 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
016 *
017 * The Initial Developer of the Original Code is
018 * Agfa Healthcare.
019 * Portions created by the Initial Developer are Copyright (C) 2011
020 * the Initial Developer. All Rights Reserved.
021 *
022 * Contributor(s):
023 * See @authors listed below
024 *
025 * Alternatively, the contents of this file may be used under the terms of
026 * either the GNU General Public License Version 2 or later (the "GPL"), or
027 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
028 * in which case the provisions of the GPL or the LGPL are applicable instead
029 * of those above. If you wish to allow use of your version of this file only
030 * under the terms of either the GPL or the LGPL, and not to allow others to
031 * use your version of this file under the terms of the MPL, indicate your
032 * decision by deleting the provisions above and replace them with the notice
033 * and other provisions required by the GPL or the LGPL. If you do not delete
034 * the provisions above, a recipient may use your version of this file under
035 * the terms of any one of the MPL, the GPL or the LGPL.
036 *
037 * ***** END LICENSE BLOCK ***** */
038
039package org.dcm4che3.net;
040
041import java.io.IOException;
042
043import org.dcm4che3.data.Attributes;
044
045/**
046 * @author Gunter Zeilinger <gunterze@gmail.com>
047 *
048 */
049public interface DimseRSP {
050
051    /**
052     * Send the next response, returning false when complete.
053     * 
054     * @return boolean True if there are more responses to send.
055     * @throws IOException If there was a problem in the network interaction.
056     * @throws InterruptedException If the thread was interrupted.
057     */
058    boolean next() throws IOException, InterruptedException;
059
060    /**
061     * Get the response command object.
062     * 
063     * @return Attributes The command object.
064     */
065    Attributes getCommand();
066
067    /**
068     * Get the dataset contained within this response, null if there is no
069     * dataset.
070     * 
071     * @return Attributes The dataset contained in this response, if any.
072     */
073    Attributes getDataset();
074
075    /**
076     * Cancel the operation, if this is a DIMSE action that can be cancelled
077     * (such as C-FIND).
078     * 
079     * @param a Association The active association object.
080     * @throws IOException If there was a problem in the network interaction.
081     */
082    void cancel(Association a) throws IOException;
083}