KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > slide > store > Store


1 /*
2  * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/store/Store.java,v 1.12 2004/07/28 09:34:39 ib Exp $
3  * $Revision: 1.12 $
4  * $Date: 2004/07/28 09:34: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 package org.apache.slide.store;
25
26 import org.apache.slide.common.*;
27
28 /**
29  * Represents a store which is used by the Slide API to access data.
30  *
31  * @version $Revision: 1.12 $
32  */
33 public interface Store extends ContentStore, LockStore, NodeStore,
34     RevisionDescriptorStore, RevisionDescriptorsStore, SecurityStore, SequenceStore {
35     
36     
37     // ------------------------------------------------------ Interface Methods
38
39     /**
40      * Set the scope of the store as specified in domain.xml.
41      */
42     void setScope(Scope scope);
43     
44     
45     
46     /**
47      * Set the name of the store as specified in domain.xml.
48      */
49     void setName(String JavaDoc name);
50     
51     
52     
53     /**
54      * Return the name of the store as specified in domain.xml.
55      */
56     String JavaDoc getName();
57     
58     /**
59      * Get parameter value for specified key
60      *
61      * @param key an Object
62      * @return an Object
63      */
64     Object JavaDoc getParameter( Object JavaDoc key );
65     
66     /**
67      * Set the node store associated with this store.
68      */
69     void setNodeStore(NodeStore nodeStore);
70     
71     
72     /**
73      * Set the security store associated with this store.
74      */
75     void setSecurityStore(SecurityStore securityStore);
76     
77     
78     /**
79      * Set the lock store associated with this store.
80      */
81     void setLockStore(LockStore lockStore);
82     
83     
84     /**
85      * Set the revision descriptors store associated with this store.
86      */
87     void setRevisionDescriptorsStore
88         (RevisionDescriptorsStore revisionDescriptorsStore);
89     
90     
91     /**
92      * Set the revision descriptor store associated with this store.
93      */
94     void setRevisionDescriptorStore
95         (RevisionDescriptorStore revisionDescriptorStore);
96     
97     
98     /**
99      * Set the content store associated with this store.
100      */
101     void setContentStore(ContentStore contentStore);
102     
103     
104     /**
105      * Set the descriptorIndex store associated with this store.
106      */
107     void setPropertiesIndexer(IndexStore contentStore);
108     
109     
110     /**
111      * Set the contentIndex store associated with this store.
112      */
113     void setContentIndexer(IndexStore contentStore);
114     
115     /**
116      * Sets the sequence store associated with this store.
117      */
118     void setSequenceStore(SequenceStore sequenceStore);
119     
120     /**
121      * Returns true if binding is supported an enabled for this store
122      */
123     boolean useBinding();
124
125     /**
126      * Acquires an exclusive access lock to a resource. This lock is transient, i.e. it will
127      * automatically be released when your transaction terminates.
128      *
129      * @param uri the URI of the resource you want to have exclusive access to
130      * @throws ServiceAccessException thrown if anything goes wrong, including the lock can not be acquired
131      */
132     void exclusiveTransientLock(String JavaDoc uri) throws ServiceAccessException;
133 }
134
Popular Tags