KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ibm > webdav > impl > VersionedNamespaceManager


1 /*
2  * (C) Copyright Simulacra Media Ltd, 2004. All rights reserved.
3  *
4  * The program is provided "AS IS" without any warranty express or
5  * implied, including the warranty of non-infringement and the implied
6  * warranties of merchantibility and fitness for a particular purpose.
7  * Simulacra Media Ltd will not be liable for any damages suffered by you as a result
8  * of using the Program. In no event will Simulacra Media Ltd be liable for any
9  * special, indirect or consequential damages or lost profits even if
10  * Simulacra Media Ltd has been advised of the possibility of their occurrence.
11  * Simulacra Media Ltd will not be liable for any third party claims against you.
12  *
13  */
14 package com.ibm.webdav.impl;
15
16 import java.util.List JavaDoc;
17
18 import com.ibm.webdav.WebDAVException;
19
20 /**
21  * VersionedNamespaceManager implements all WebDAV namespace methods which deal with
22  * versioned resources that are dependent on a specific repository manager interface.
23  * This manager is used by ResourceImpl and its subclasses to interface with a particular
24  * repository manager for accessing and controlling versions of resources.
25  *
26  * @author Michael Bell
27  * @version $Revision: 1.1 $
28  * @since November 17, 2003
29  */
30 public interface VersionedNamespaceManager extends NamespaceManager {
31
32     /**
33      * Checks resource in and returns the verion URI for the checked in version
34      *
35      * @return
36      * @throws WebDAVException
37      */
38     public String JavaDoc checkin() throws WebDAVException;
39     
40     /**
41      * Checks out the current resource
42      *
43      * @throws WebDAVException
44      */
45     public void checkout() throws WebDAVException;
46     
47     /**
48      * Returns a <code>List</code> of versions of this resource
49      *
50      * @return
51      * @throws WebDAVException
52      */
53     public List JavaDoc getVersions() throws WebDAVException;
54
55     /**
56      * Uncheckouts trhe current resource
57      *
58      * @throws WebDAVException
59      */
60     public void uncheckout() throws WebDAVException;
61
62     /**
63      * Adds this resource to version control
64      */
65     public void versionControl() throws WebDAVException;
66     
67     /**
68      * Returns <code>true</code> if resource has a version history
69      *
70      * @return
71      * @throws WebDAVException
72      */
73     public boolean isVersioned() throws WebDAVException;
74     
75     /**
76      * Returns <code>true</code> if resource is checked in
77      *
78      * @return
79      * @throws WebDAVException
80      */
81     public boolean isCheckedInVersion() throws WebDAVException;
82     
83     /**
84      * Returns <code>true</code> if resource is checked out
85      *
86      * @return
87      * @throws WebDAVException
88      */
89     public boolean isCheckedOutVersion() throws WebDAVException;
90     
91     /**
92      * Returns <code>true</code> if the given url is a verion url
93      *
94      * @param parentURL
95      * @return
96      */
97     public boolean isVersionURL(String JavaDoc url);
98
99     /**
100      * Returns the resource URL for the resource, used if the url used to obtain
101      * the resource was a version url
102      *
103      * @return
104      */
105     public String JavaDoc getResourceURL() throws WebDAVException;
106     
107
108 }
109
Popular Tags