001 package biweekly.property;
002
003 import java.util.List;
004
005 import biweekly.component.ICalComponent;
006
007 /*
008 Copyright (c) 2013, Michael Angstadt
009 All rights reserved.
010
011 Redistribution and use in source and binary forms, with or without
012 modification, are permitted provided that the following conditions are met:
013
014 1. Redistributions of source code must retain the above copyright notice, this
015 list of conditions and the following disclaimer.
016 2. Redistributions in binary form must reproduce the above copyright notice,
017 this list of conditions and the following disclaimer in the documentation
018 and/or other materials provided with the distribution.
019
020 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030 */
031
032 /**
033 * <p>
034 * Represents a response to a scheduling request, describing whether the request
035 * was successfully processed or not.
036 * </p>
037 * <p>
038 * Each property instance has a status code. The following status code families
039 * are defined:
040 * <ul>
041 * <li><b>1.x</b> - The request has been received, but is still being processed.
042 * </li>
043 * <li><b>2.x</b> - The request was processed successfully.</li>
044 * <li><b>3.x</b> - There is a client-side problem with the request (such as
045 * some incorrect syntax).</li>
046 * <li><b>4.x</b> - A server-side error occurred.</li>
047 * </ul>
048 * </p>
049 * <p>
050 * <b>Examples:</b>
051 *
052 * <pre class="brush:java">
053 * RequestStatus requestStatus = new RequestStatus("2.0");
054 * requestStatus.setDescription("Success");
055 * </pre>
056 *
057 * </p>
058 * @author Michael Angstadt
059 * @rfc 5545 p.141-3
060 */
061 public class RequestStatus extends ICalProperty {
062 private String statusCode, description, exceptionText;
063
064 /**
065 * Creates a request status property.
066 * @param statusCode the status code (e.g. "1.1.3")
067 */
068 public RequestStatus(String statusCode) {
069 setStatusCode(statusCode);
070 }
071
072 /**
073 * Gets the status code. The following status code families are defined:
074 * <ul>
075 * <li><b>1.x</b> - The request has been received, but is still being
076 * processed.</li>
077 * <li><b>2.x</b> - The request was processed successfully.</li>
078 * <li><b>3.x</b> - There is a client-side problem with the request (such as
079 * some incorrect syntax).</li>
080 * <li><b>4.x</b> - A server-side error occurred.</li>
081 * </ul>
082 * @return the status code (e.g. "1.1.3")
083 */
084 public String getStatusCode() {
085 return statusCode;
086 }
087
088 /**
089 * Sets a status code. The following status code families are defined:
090 * <ul>
091 * <li><b>1.x</b> - The request has been received, but is still being
092 * processed.</li>
093 * <li><b>2.x</b> - The request was processed successfully.</li>
094 * <li><b>3.x</b> - There is a client-side problem with the request (such as
095 * some incorrect syntax).</li>
096 * <li><b>4.x</b> - A server-side error occurred.</li>
097 * </ul>
098 * @param statusCode the status code (e.g. "1.1.3")
099 */
100 public void setStatusCode(String statusCode) {
101 this.statusCode = statusCode;
102 }
103
104 /**
105 * Gets the human-readable description of the status.
106 * @return the description (e.g. "Success") or null if not set
107 */
108 public String getDescription() {
109 return description;
110 }
111
112 /**
113 * Sets a human-readable description of the status.
114 * @param description the description (e.g. "Success") or null to remove
115 */
116 public void setDescription(String description) {
117 this.description = description;
118 }
119
120 /**
121 * Gets any additional data related to the response.
122 * @return the additional data or null if not set
123 */
124 public String getExceptionText() {
125 return exceptionText;
126 }
127
128 /**
129 * Sets any additional data related to the response.
130 * @param exceptionText the additional data or null to remove
131 */
132 public void setExceptionText(String exceptionText) {
133 this.exceptionText = exceptionText;
134 }
135
136 @Override
137 public String getLanguage() {
138 return super.getLanguage();
139 }
140
141 @Override
142 public void setLanguage(String language) {
143 super.setLanguage(language);
144 }
145
146 @Override
147 protected void validate(List<ICalComponent> components, List<String> warnings) {
148 if (statusCode == null) {
149 warnings.add("No status code is set.");
150 }
151 }
152 }