File src/de/openrat/client/util/CMSResponse.java

Last commit: Thu Nov 7 17:03:39 2019 +0100	Jan Dankert	Compare versions with special versions object.


     1 /*
     2 OpenRat Java-Client
     3 Copyright (C) 2009 Jan Dankert
     4  
     5 This library is free software; you can redistribute it and/or
     6 modify it under the terms of the GNU Library General Public
     7 License as published by the Free Software Foundation; either
     8 version 2 of the License, or (at your option) any later version.
     9 
    10 This library 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 GNU
    13 Library General Public License for more details.
    14 
    15 You should have received a copy of the GNU Library General Public
    16 License along with this library; if not, write to the
    17 Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
    18 Boston, MA  02110-1301, USA.
    19 
    20  */
    21 package de.openrat.client.util;
    22 
    23 import de.openrat.client.Version;
    24 
    25 import java.util.List;
    26 
    27 
    28 /**
    29  * @author Jan Dankert
    30  */
    31 public class CMSResponse
    32 {
    33 
    34 	private List<CMSNotice> notices;
    35 	private List<String> validationErrors;
    36 	private CMSNode output;
    37 	private CMSSession session;
    38 	private int httpStatus;
    39 
    40 	private Version api;
    41 	private Version version;
    42 
    43 	/**
    44 	 * Inhalt des Feldes <code>error</code>.
    45 	 * 
    46 	 * @return error
    47 	 */
    48 	public List<CMSNotice> getNotices()
    49 	{
    50 		return notices;
    51 	}
    52 
    53 	/**
    54 	 * Setzt das Feld <code>error</code>.
    55 	 * 
    56 	 * @param error
    57 	 *            error
    58 	 */
    59 	public void setNotices(List<CMSNotice> error)
    60 	{
    61 		this.notices = error;
    62 	}
    63 
    64 	
    65 	/**
    66 	 * List of input fields with validation errors.
    67 	 * @return
    68 	 */
    69 	public List<String> getValidationErrors()
    70 	{
    71 		return validationErrors;
    72 	}
    73 
    74 	/**
    75 	 * @param validationErrors
    76 	 */
    77 	public void setValidationErrors(List<String> validationErrors)
    78 	{
    79 		this.validationErrors = validationErrors;
    80 	}
    81 
    82 	/**
    83 	 * Inhalt des Feldes <code>output</code>.
    84 	 * 
    85 	 * @return output
    86 	 */
    87 	public CMSNode getOutput()
    88 	{
    89 		return output;
    90 	}
    91 
    92 	/**
    93 	 * Setzt das Feld <code>output</code>.
    94 	 * 
    95 	 * @param cmsNode
    96 	 *            output
    97 	 */
    98 	public void setOutput(CMSNode cmsNode)
    99 	{
   100 		this.output = cmsNode;
   101 	}
   102 
   103 	/**
   104 	 * the API version.
   105 	 * 
   106 	 * @return api
   107 	 */
   108 	public Version getApi()
   109 	{
   110 		return api;
   111 	}
   112 
   113 	/**
   114 	 * Setzt das Feld <code>api</code>.
   115 	 *
   116 	 * @param api
   117 	 *            api
   118 	 */
   119 	public void setApi(Version api)
   120 	{
   121 		this.api = api;
   122 	}
   123 
   124 	/**
   125 	 * Inhalt des Feldes <code>version</code>.
   126 	 * 
   127 	 * @return version
   128 	 */
   129 	public Version getVersion()
   130 	{
   131 		return version;
   132 	}
   133 
   134 	/**
   135 	 * Setzt das Feld <code>version</code>.
   136 	 *
   137 	 * @param version
   138 	 *            version
   139 	 */
   140 	public void setVersion(Version version)
   141 	{
   142 		this.version = version;
   143 	}
   144 
   145 	/**
   146 	 * Inhalt des Feldes <code>session</code>.
   147 	 * 
   148 	 * @return session
   149 	 */
   150 	public CMSSession getSession()
   151 	{
   152 		return session;
   153 	}
   154 
   155 	/**
   156 	 * Setzt das Feld <code>session</code>.
   157 	 * 
   158 	 * @param session
   159 	 *            session
   160 	 */
   161 	public void setSession(CMSSession session)
   162 	{
   163 		this.session = session;
   164 	}
   165 
   166 	/**
   167 	 * Inhalt des Feldes <code>httpStatus</code>.
   168 	 * 
   169 	 * @return httpStatus
   170 	 */
   171 	public int getHttpStatus()
   172 	{
   173 		return httpStatus;
   174 	}
   175 
   176 	/**
   177 	 * Setzt das Feld <code>httpStatus</code>.
   178 	 * 
   179 	 * @param httpStatus
   180 	 *            httpStatus
   181 	 */
   182 	public void setHttpStatus(int httpStatus)
   183 	{
   184 		this.httpStatus = httpStatus;
   185 	}
   186 }



Download src/de/openrat/client/util/CMSResponse.java


History
Thu, 7 Nov 2019 17:03:39 +0100	Jan Dankert	Compare versions with special versions object.
Wed, 12 Dec 2018 18:07:08 +0100	Jan Dankert	better encapsulation for action classes, new common CMSAction for a more low-level api.
Fri, 30 Sep 2016 23:38:24 +0200	dankert	Parsen der Server-Notices und füllen der CMSResponse. Weitere Doku mit JavaDoc.
Fri, 30 Sep 2016 22:45:01 +0200	dankert	first version of the java api.