<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.5.0_14) on Sun Aug 16 11:45:36 IDT 2009 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
Response (Apache Wink 0.1-incubating API) | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.wink.webdav.model.Response class"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="Response (Apache Wink 0.1-incubating API)"; | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Response.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/wink/webdav/model/Resourcetype.html" title="class in org.apache.wink.webdav.model"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/wink/webdav/model/Set.html" title="class in org.apache.wink.webdav.model"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/wink/webdav/model/Response.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="Response.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.wink.webdav.model</FONT> | |
<BR> | |
Class Response</H2> | |
<PRE> | |
java.lang.Object | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.wink.webdav.model.Response</B> | |
</PRE> | |
<HR> | |
<DL> | |
<DT><PRE>public class <B>Response</B><DT>extends java.lang.Object</DL> | |
</PRE> | |
<P> | |
The <code>response</code> XML element per the WebDAV specification [RFC 4918] | |
<pre> | |
Name: response | |
Namespace: DAV: | |
Purpose: Holds a single response describing the effect of a | |
method on resource and/or its properties. | |
Description: A particular href MUST NOT appear more than once as the | |
child of a response XML element under a multistatus XML element. | |
This requirement is necessary in order to keep processing costs for a | |
response to linear time. Essentially, this prevents having to search | |
in order to group together all the responses by href. There are, | |
however, no requirements regarding ordering based on href values. | |
<!ELEMENT response (href, ((href*, status)|(propstat+)), | |
responsedescription?) > | |
</pre> | |
<P> | |
<P> | |
<HR> | |
<P> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#error">error</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.util.List<java.lang.String></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#href">href</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.util.List<<A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#propstat">propstat</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#responsedescription">responsedescription</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#status">status</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
<A NAME="constructor_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Constructor Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#Response()">Response</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#Response(java.lang.String)">Response</A></B>(java.lang.String href)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getError()">getError</A></B>()</CODE> | |
<BR> | |
Gets the value of the error property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.util.List<java.lang.String></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getHref()">getHref</A></B>()</CODE> | |
<BR> | |
Gets the value of the href property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getOrCreatePropstat(int, java.lang.String, org.apache.wink.webdav.model.Error)">getOrCreatePropstat</A></B>(int status, | |
java.lang.String description, | |
<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> error)</CODE> | |
<BR> | |
Get a Propstat instance contained within this response that has the | |
provided criteria, or create a new Propstat instance with the provided | |
information if no propstat already exists.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.util.List<<A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getPropstat()">getPropstat</A></B>()</CODE> | |
<BR> | |
Gets the value of the propstat property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getPropstat(int, java.lang.String, org.apache.wink.webdav.model.Error)">getPropstat</A></B>(int status, | |
java.lang.String description, | |
<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> error)</CODE> | |
<BR> | |
Get a Propstat instance contained within this response that has the | |
provided criteria.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getResponsedescription()">getResponsedescription</A></B>()</CODE> | |
<BR> | |
Gets the value of the responsedescription property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#getStatus()">getStatus</A></B>()</CODE> | |
<BR> | |
Gets the value of the status property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setError(org.apache.wink.webdav.model.Error)">setError</A></B>(<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> value)</CODE> | |
<BR> | |
Sets the value of the error property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setProperty(java.lang.Object, int)">setProperty</A></B>(java.lang.Object property, | |
int status)</CODE> | |
<BR> | |
Add the provided property to the correct propstat element with the | |
specified Http status.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setProperty(java.lang.Object, int, java.lang.String, org.apache.wink.webdav.model.Error)">setProperty</A></B>(java.lang.Object property, | |
int status, | |
java.lang.String description, | |
<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> error)</CODE> | |
<BR> | |
Sets the provided property to the correct propstat element.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setPropertyNotFound(java.lang.Object)">setPropertyNotFound</A></B>(java.lang.Object property)</CODE> | |
<BR> | |
Add the provided property to the correct propstat element with an Http | |
status of NOT FOUND.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setPropertyOk(java.lang.Object)">setPropertyOk</A></B>(java.lang.Object property)</CODE> | |
<BR> | |
Add the provided property to the correct propstat element with an Http | |
status of OK.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setResponsedescription(java.lang.String)">setResponsedescription</A></B>(java.lang.String value)</CODE> | |
<BR> | |
Sets the value of the responsedescription property.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/wink/webdav/model/Response.html#setStatus(java.lang.String)">setStatus</A></B>(java.lang.String value)</CODE> | |
<BR> | |
Sets the value of the status property.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="href"><!-- --></A><H3> | |
href</H3> | |
<PRE> | |
protected java.util.List<java.lang.String> <B>href</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="status"><!-- --></A><H3> | |
status</H3> | |
<PRE> | |
protected java.lang.String <B>status</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="propstat"><!-- --></A><H3> | |
propstat</H3> | |
<PRE> | |
protected java.util.List<<A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A>> <B>propstat</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="error"><!-- --></A><H3> | |
error</H3> | |
<PRE> | |
protected <A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> <B>error</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="responsedescription"><!-- --></A><H3> | |
responsedescription</H3> | |
<PRE> | |
protected java.lang.String <B>responsedescription</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<!-- ========= CONSTRUCTOR DETAIL ======== --> | |
<A NAME="constructor_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Constructor Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="Response()"><!-- --></A><H3> | |
Response</H3> | |
<PRE> | |
public <B>Response</B>()</PRE> | |
<DL> | |
</DL> | |
<HR> | |
<A NAME="Response(java.lang.String)"><!-- --></A><H3> | |
Response</H3> | |
<PRE> | |
public <B>Response</B>(java.lang.String href)</PRE> | |
<DL> | |
</DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="getHref()"><!-- --></A><H3> | |
getHref</H3> | |
<PRE> | |
public java.util.List<java.lang.String> <B>getHref</B>()</PRE> | |
<DL> | |
<DD>Gets the value of the href property. | |
<p> | |
This accessor method returns a reference to the live list, not a | |
snapshot. Therefore any modification you make to the returned list will | |
be present inside the JAXB object. This is why there is not a | |
<CODE>set</CODE> method for the href property. | |
<p> | |
For example, to add a new item, do as follows: | |
<pre> | |
getHref().add(newItem); | |
</pre> | |
<p> | |
Objects of the following type(s) are allowed in the list <CODE>String</CODE> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getStatus()"><!-- --></A><H3> | |
getStatus</H3> | |
<PRE> | |
public java.lang.String <B>getStatus</B>()</PRE> | |
<DL> | |
<DD>Gets the value of the status property. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>possible object is <CODE>String</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setStatus(java.lang.String)"><!-- --></A><H3> | |
setStatus</H3> | |
<PRE> | |
public void <B>setStatus</B>(java.lang.String value)</PRE> | |
<DL> | |
<DD>Sets the value of the status property. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>value</CODE> - allowed object is <CODE>String</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getPropstat()"><!-- --></A><H3> | |
getPropstat</H3> | |
<PRE> | |
public java.util.List<<A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A>> <B>getPropstat</B>()</PRE> | |
<DL> | |
<DD>Gets the value of the propstat property. | |
<p> | |
This accessor method returns a reference to the live list, not a | |
snapshot. Therefore any modification you make to the returned list will | |
be present inside the JAXB object. This is why there is not a | |
<CODE>set</CODE> method for the propstat property. | |
<p> | |
For example, to add a new item, do as follows: | |
<pre> | |
getPropstat().add(newItem); | |
</pre> | |
<p> | |
Objects of the following type(s) are allowed in the list <A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model"><CODE>Propstat</CODE></A> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getPropstat(int, java.lang.String, org.apache.wink.webdav.model.Error)"><!-- --></A><H3> | |
getPropstat</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A> <B>getPropstat</B>(int status, | |
java.lang.String description, | |
<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> error)</PRE> | |
<DL> | |
<DD>Get a Propstat instance contained within this response that has the | |
provided criteria. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>status</CODE> - the Http status code of the propstat to retrieve<DD><CODE>description</CODE> - the description of the propstat to retrieve<DD><CODE>error</CODE> - the error of the propstat to retrieve. Note that when | |
searching for a matching propstat, errors are considered the | |
same only if both errors are null. | |
<DT><B>Returns:</B><DD>the Propstat instance if a match is found, or null if no | |
propstats matches all criteria</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getOrCreatePropstat(int, java.lang.String, org.apache.wink.webdav.model.Error)"><!-- --></A><H3> | |
getOrCreatePropstat</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/wink/webdav/model/Propstat.html" title="class in org.apache.wink.webdav.model">Propstat</A> <B>getOrCreatePropstat</B>(int status, | |
java.lang.String description, | |
<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> error)</PRE> | |
<DL> | |
<DD>Get a Propstat instance contained within this response that has the | |
provided criteria, or create a new Propstat instance with the provided | |
information if no propstat already exists. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>status</CODE> - the Http status code of the propstat to retrieve<DD><CODE>description</CODE> - the description of the propstat to retrieve<DD><CODE>error</CODE> - the error of the propstat to retrieve. Note that when | |
searching for a matching propstat, errors are considered the | |
same only if both errors are null. | |
<DT><B>Returns:</B><DD></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getError()"><!-- --></A><H3> | |
getError</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> <B>getError</B>()</PRE> | |
<DL> | |
<DD>Gets the value of the error property. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>possible object is <A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model"><CODE>Error</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setError(org.apache.wink.webdav.model.Error)"><!-- --></A><H3> | |
setError</H3> | |
<PRE> | |
public void <B>setError</B>(<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> value)</PRE> | |
<DL> | |
<DD>Sets the value of the error property. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>value</CODE> - allowed object is <A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model"><CODE>Error</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getResponsedescription()"><!-- --></A><H3> | |
getResponsedescription</H3> | |
<PRE> | |
public java.lang.String <B>getResponsedescription</B>()</PRE> | |
<DL> | |
<DD>Gets the value of the responsedescription property. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>possible object is <CODE>String</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setResponsedescription(java.lang.String)"><!-- --></A><H3> | |
setResponsedescription</H3> | |
<PRE> | |
public void <B>setResponsedescription</B>(java.lang.String value)</PRE> | |
<DL> | |
<DD>Sets the value of the responsedescription property. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>value</CODE> - allowed object is <CODE>String</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setPropertyOk(java.lang.Object)"><!-- --></A><H3> | |
setPropertyOk</H3> | |
<PRE> | |
public void <B>setPropertyOk</B>(java.lang.Object property)</PRE> | |
<DL> | |
<DD>Add the provided property to the correct propstat element with an Http | |
status of OK. | |
<P> | |
<DD><DL> | |
<DT><B>See Also:</B><DD><CODE>#setProperty(Object, int, String, Error)}</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setPropertyNotFound(java.lang.Object)"><!-- --></A><H3> | |
setPropertyNotFound</H3> | |
<PRE> | |
public void <B>setPropertyNotFound</B>(java.lang.Object property)</PRE> | |
<DL> | |
<DD>Add the provided property to the correct propstat element with an Http | |
status of NOT FOUND. | |
<P> | |
<DD><DL> | |
<DT><B>See Also:</B><DD><CODE>#setProperty(Object, int, String, Error)}</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setProperty(java.lang.Object, int)"><!-- --></A><H3> | |
setProperty</H3> | |
<PRE> | |
public void <B>setProperty</B>(java.lang.Object property, | |
int status)</PRE> | |
<DL> | |
<DD>Add the provided property to the correct propstat element with the | |
specified Http status. | |
<P> | |
<DD><DL> | |
<DT><B>See Also:</B><DD><CODE>#setProperty(Object, int, String, Error)}</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setProperty(java.lang.Object, int, java.lang.String, org.apache.wink.webdav.model.Error)"><!-- --></A><H3> | |
setProperty</H3> | |
<PRE> | |
public void <B>setProperty</B>(java.lang.Object property, | |
int status, | |
java.lang.String description, | |
<A HREF="../../../../../org/apache/wink/webdav/model/Error.html" title="class in org.apache.wink.webdav.model">Error</A> error)</PRE> | |
<DL> | |
<DD>Sets the provided property to the correct propstat element. The correct | |
propstat element is selected according to the provided status, | |
description and error parameters. | |
<p> | |
The following table details the possible Java types of every property | |
(note that the <code>DAV</code> namespace depicts the WebDAV namespace | |
"DAV:") | |
<p> | |
<table border="1"> | |
<tr> | |
<td>DAV:creationdate</td> | |
<td>org.apache.wink.webdav.model.Creationdate</td> | |
</tr> | |
<tr> | |
<td>DAV:displayname</td> | |
<td>org.apache.wink.webdav.model.Displayname</td> | |
</tr> | |
<tr> | |
<td>DAV:getcontentlanguage</td> | |
<td>org.apache.wink.webdav.model.Getcontentlanguage</td> | |
</tr> | |
<tr> | |
<td>DAV:getcontentlength</td> | |
<td>org.apache.wink.webdav.model.Getcontentlength</td> | |
</tr> | |
<tr> | |
<td>DAV:getcontenttype</td> | |
<td>org.apache.wink.webdav.model.Getcontenttype</td> | |
</tr> | |
<tr> | |
<td>DAV:getetag</td> | |
<td>org.apache.wink.webdav.model.Getetag</td> | |
</tr> | |
<tr> | |
<td>DAV:getlastmodified</td> | |
<td>org.apache.wink.webdav.model.Getlastmodified</td> | |
</tr> | |
<tr> | |
<td>DAV:lockdiscovery</td> | |
<td>org.apache.wink.webdav.model.Lockdiscovery</td> | |
</tr> | |
<tr> | |
<td>DAV:resourcetype</td> | |
<td>org.apache.wink.webdav.model.Resourcetype</td> | |
</tr> | |
<tr> | |
<td>DAV:supportedlock</td> | |
<td>org.apache.wink.webdav.model.Supportedlock</td> | |
</tr> | |
<tr> | |
<td>any other</td> | |
<td>org.w3c.dom.Element</td> | |
</tr> | |
</table> | |
<p> | |
for example, if the property to set is | |
<code>DAV:getcontentlanguage</code> then the property should be an | |
instance of org.apache.wink.webdav.model.Getcontentlanguage. | |
<p> | |
if the property is <code>K:myprop</code> then the property should be an | |
instance of org.w3c.dom.Element | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>property</CODE> - the property to add<DD><CODE>status</CODE> - the status of the property to add<DD><CODE>description</CODE> - the description of the property<DD><CODE>error</CODE> - the error of the property</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Response.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/wink/webdav/model/Resourcetype.html" title="class in org.apache.wink.webdav.model"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/wink/webdav/model/Set.html" title="class in org.apache.wink.webdav.model"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/wink/webdav/model/Response.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="Response.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
</BODY> | |
</HTML> |