src/net/pterodactylus/fcp/GetRequestStatus.java

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