KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > slide > search > RequestedResource


1 /*
2  * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/search/RequestedResource.java,v 1.10 2004/07/28 09:35:10 ib Exp $
3  * $Revision: 1.10 $
4  * $Date: 2004/07/28 09:35:10 $
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.search;
25
26 // import list
27 import org.apache.slide.common.SlideException;
28 import org.apache.slide.common.PropertyName;
29
30 import org.apache.slide.content.NodeProperty;
31
32 import java.util.Iterator JavaDoc;
33
34 /**
35  * This interface provides access to the URI and the properties of a resource.
36  *
37  * @version $Revision: 1.10 $
38  *
39  **/
40 public interface RequestedResource {
41     
42     /**
43      * Returns the URI of the resource.
44      *
45      * @return the URI of the resource.
46      *
47      * @throws SlideException
48      */
49     public String JavaDoc getUri() throws SlideException;
50     
51     /**
52      * Returns the property with the given <code>name</code> and
53      * <code>namespace</code>.
54      *
55      * @param name the name of the property.
56      * @param namespace the namespace URI of the property.
57      *
58      * @return the property with the given <code>name</code> and
59      * <code>namespace</code>.
60      *
61      * @throws SlideException
62      */
63     public NodeProperty getProperty(String JavaDoc name, String JavaDoc namespace) throws SlideException;
64     
65     /**
66      * Returns the property with the given <code>propertyName</code>.
67      *
68      * @param propertyName the PropertyName of the property.
69      *
70      * @return the property with the given <code>npropertyNameame</code>.
71      *
72      * @throws SlideException
73      */
74     public NodeProperty getProperty(PropertyName propertyName) throws SlideException;
75     
76     /**
77      * Returns an Iterator of PropertyName of all properties.
78      *
79      * @return an Iterator of PropertyName.
80      *
81      * @throws SlideException
82      */
83     public Iterator JavaDoc getAllPropertiesNames() throws SlideException;
84     
85     /**
86      * Returns all properties as an Iterator of NodeProperty objects.
87      *
88      * @return all properties as an Iterator of NodeProperty objects.
89      *
90      * @throws SlideException
91      */
92     public Iterator JavaDoc getAllProperties() throws SlideException;
93     
94 }
95
96
97
Popular Tags