src/main/java/net/pterodactylus/fcp/GetRequestStatus.java

   1 /*
   2  * jFCPlib - GetRequestStatus.java - Copyright © 2008 David Roden
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package net.pterodactylus.fcp;
  20
  21 /**
  22  * The “GetRequestStatus” message is used request status information about a
  23  * running request. It is also the only way to trigger a download of a
  24  * persisted completed {@link ClientGet} with a return type of
  25  * {@link ReturnType#direct}.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  */
  29 public class GetRequestStatus extends FcpMessage {
  30
  31         /**
  32          * Creates a new “GetRequestStatus” message.
  33          *
  34          * @param identifier
  35          *            The identifier of the request
  36          */
  37         public GetRequestStatus(String identifier) {
  38                 super("GetRequestStatus");
  39                 setField("Identifier", identifier);
  40         }
  41
  42         /**
  43          * Sets whether the request is on the global queue.
  44          *
  45          * @param global
  46          *            <code>true</code> if the request is on the global queue,
  47          *            <code>false</code> if it is on the client-local queue
  48          */
  49         public void setGlobal(boolean global) {
  50                 setField("Global", String.valueOf(global));
  51         }
  52
  53         /**
  54          * Sets whether the omit the transmission of the request data in a
  55          * {@link AllData} message.
  56          *
  57          * @param onlyData
  58          *            <code>true</code> to skip transmission of data,
  59          *            <code>false</code> to download data
  60          */
  61         public void setOnlyData(boolean onlyData) {
  62                 setField("OnlyData", String.valueOf(onlyData));
  63         }
  64
  65 }