document_manager.h
Go to the documentation of this file.
1 /*
2  * Copyright 2006-2011 The FLWOR Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #ifndef ZORBA_DOCUMENTMANAGER_API_H
17 #define ZORBA_DOCUMENTMANAGER_API_H
18 
19 #include <zorba/config.h>
20 #include <zorba/api_shared_types.h>
21 
22 namespace zorba {
23 
24  /** \brief
25  *
26  */
27  class ZORBA_DLL_PUBLIC DocumentManager
28  {
29  public:
30  virtual void
31  put(const String& aURI, const Item& aDoc) = 0;
32 
33  virtual void
34  remove(const String& aURI) = 0;
35 
36  virtual Item
37  document(const String& aURI) const = 0;
38 
39  virtual ItemSequence_t
40  availableDocuments() const = 0;
41 
42  virtual bool
43  isAvailableDocument(const String& aURI) const = 0;
44 
45  virtual ~DocumentManager() {}
46 
47  }; /* class DocumentManager */
48 
49 } /* namespace zorba */
50 #endif
51 /* vim:set et sw=2 ts=2: */