biweekly.property
Class RequestStatus

java.lang.Object
  biweekly.property.ICalProperty
      biweekly.property.RequestStatus

public class RequestStatus
extends ICalProperty

Represents a response to a scheduling request, describing whether the request was successfully processed or not.

Each property instance has a status code. The following status code families are defined:

• 1.x - The request has been received, but is still being processed.
• 2.x - The request was processed successfully.
• 3.x - There is a client-side problem with the request (such as some incorrect syntax).
• 4.x - A server-side error occurred.

Examples:

 RequestStatus requestStatus = new RequestStatus("2.0");
 requestStatus.setDescription("Success");
 

Author:

Michael Angstadt

Specification Reference:

RFC 5545 p.141-3

Field Summary

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

RequestStatus(String statusCode)
Creates a request status property.

Method Summary

String	getDescription() Gets the human-readable description of the status.
String	getExceptionText() Gets any additional data related to the response.
String	getLanguage() Gets the language that the property value is written in.
String	getStatusCode() Gets the status code.
void	setDescription(String description) Sets a human-readable description of the status.
void	setExceptionText(String exceptionText) Sets any additional data related to the response.
void	setLanguage(String language) Sets the language that the property value is written in.
void	setStatusCode(String statusCode) Sets a status code.
protected void	validate(List<ICalComponent> components, List<String> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestStatus

public RequestStatus(String statusCode)

Creates a request status property.

Parameters:

statusCode - the status code (e.g. "1.1.3")

Method Detail

getStatusCode

public String getStatusCode()

Gets the status code. The following status code families are defined:

• 1.x - The request has been received, but is still being processed.
• 2.x - The request was processed successfully.
• 3.x - There is a client-side problem with the request (such as some incorrect syntax).
• 4.x - A server-side error occurred.

Returns:

the status code (e.g. "1.1.3")

setStatusCode

public void setStatusCode(String statusCode)

Sets a status code. The following status code families are defined:

• 1.x - The request has been received, but is still being processed.
• 2.x - The request was processed successfully.
• 3.x - There is a client-side problem with the request (such as some incorrect syntax).
• 4.x - A server-side error occurred.

Parameters:

statusCode - the status code (e.g. "1.1.3")

getDescription

public String getDescription()

Gets the human-readable description of the status.

Returns:

the description (e.g. "Success") or null if not set

setDescription

public void setDescription(String description)

Sets a human-readable description of the status.

Parameters:

description - the description (e.g. "Success") or null to remove

getExceptionText

public String getExceptionText()

Gets any additional data related to the response.

Returns:

the additional data or null if not set

setExceptionText

public void setExceptionText(String exceptionText)

Sets any additional data related to the response.

Parameters:

exceptionText - the additional data or null to remove

getLanguage

public String getLanguage()

Description copied from class: ICalProperty

Gets the language that the property value is written in.

Returns:

the language (e.g. "en" for English) or null if not set

setLanguage

public void setLanguage(String language)

Description copied from class: ICalProperty

Sets the language that the property value is written in.

Parameters:

language - the language (e.g. "en" for English) or null to remove

validate

protected void validate(List<ICalComponent> components,
                        List<String> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

warnings - the list to add the warnings to