KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > webdav > lib > ResponseEntity


1 /*
2  * $Header: /home/cvs/jakarta-slide/webdavclient/clientlib/src/java/org/apache/webdav/lib/ResponseEntity.java,v 1.3 2004/07/28 09:31:39 ib Exp $
3  * $Revision: 1.3 $
4  * $Date: 2004/07/28 09:31:39 $
5  *
6  * ====================================================================
7  *
8  * Copyright 1999-2002 The Apache Software Foundation
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License");
11  * you may not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS,
18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  */
23
24
25 package org.apache.webdav.lib;
26
27
28 import java.util.Enumeration JavaDoc;
29
30 /**
31  * The interface for the response entity body formats that provide
32  * operations for the XML response documents.
33  *
34  * @version $Revision: 1.3 $ $Date: 2004/07/28 09:31:39 $
35  */
36
37 public interface ResponseEntity {
38
39     /**
40      * Get the href string in the response XML element.
41      *
42      * Each response XML element MUST contain an href XML element that gives
43      * the URI of the resource on which the properties in the prop XML
44      * element are defined.
45      *
46      * @return the href string.
47      */
48     public String JavaDoc getHref();
49
50
51     /**
52      * Get the status code for use with 207 (Multi-Status).
53      *
54      * Unless explicitly prohibited any 2/3/4/5xx series
55      * response code may be used in a Multi-Status response.
56      *
57      * @return the status code.
58      */
59     public int getStatusCode();
60
61
62     /**
63      * Get the properties in the response XML element.
64      *
65      * @return the properties.
66      */
67     public Enumeration JavaDoc getProperties();
68
69     /**
70      * Get the properties in the response XML element.
71      *
72      * @return the properties.
73      */
74     public Enumeration JavaDoc getHistories();
75
76     /**
77      * Get the properties in the response XML element.
78      *
79      * @return the properties.
80      */
81     public Enumeration JavaDoc getWorkspaces();
82
83 }
84
Popular Tags