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 * Represents a response to a scheduling request, describing whether the request
034 * was successfully processed or not.
035 * @author Michael Angstadt
036 * @see <a href="http://tools.ietf.org/html/rfc5545#page-141">RFC 5545
037 * p.141-3</a>
038 */
039 public class RequestStatus extends ICalProperty {
040 private String statusCode, description, exceptionText;
041
042 /**
043 * Creates a request status property.
044 * @param statusCode the status code (e.g. "1.1.3")
045 */
046 public RequestStatus(String statusCode) {
047 setStatusCode(statusCode);
048 }
049
050 /**
051 * Gets the status code. The following status code families are defined:
052 * <ul>
053 * <li><b>1.x</b> - The request has been received, but is still being
054 * processed.</li>
055 * <li><b>2.x</b> - The request was processed successfully.</li>
056 * <li><b>3.x</b> - There is a client-side problem with the request (such as
057 * some incorrect syntax).</li>
058 * <li><b>4.x</b> - A server-side error occurred.</li>
059 * </ul>
060 * @return the status code (e.g. "1.1.3")
061 */
062 public String getStatusCode() {
063 return statusCode;
064 }
065
066 /**
067 * Sets a status code. The following status code families are defined:
068 * <ul>
069 * <li><b>1.x</b> - The request has been received, but is still being
070 * processed.</li>
071 * <li><b>2.x</b> - The request was processed successfully.</li>
072 * <li><b>3.x</b> - There is a client-side problem with the request (such as
073 * some incorrect syntax).</li>
074 * <li><b>4.x</b> - A server-side error occurred.</li>
075 * </ul>
076 * @param statusCode the status code (e.g. "1.1.3")
077 */
078 public void setStatusCode(String statusCode) {
079 this.statusCode = statusCode;
080 }
081
082 /**
083 * Gets the human-readable description of the status.
084 * @return the description (e.g. "Success") or null if not set
085 */
086 public String getDescription() {
087 return description;
088 }
089
090 /**
091 * Sets a human-readable description of the status.
092 * @param description the description (e.g. "Success") or null to remove
093 */
094 public void setDescription(String description) {
095 this.description = description;
096 }
097
098 /**
099 * Gets any additional data related to the response.
100 * @return the additional data or null if not set
101 */
102 public String getExceptionText() {
103 return exceptionText;
104 }
105
106 /**
107 * Sets any additional data related to the response.
108 * @param exceptionText the additional data or null to remove
109 */
110 public void setExceptionText(String exceptionText) {
111 this.exceptionText = exceptionText;
112 }
113
114 @Override
115 public String getLanguage() {
116 return super.getLanguage();
117 }
118
119 @Override
120 public void setLanguage(String language) {
121 super.setLanguage(language);
122 }
123
124 @Override
125 protected void validate(List<ICalComponent> components, List<String> warnings) {
126 if (statusCode == null) {
127 warnings.add("No status code is set.");
128 }
129 }
130 }