KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/search/ISearchToken.java,v 1.3 2004/07/28 09:35:11 ib Exp $
3  * $Revision: 1.3 $
4  * $Date: 2004/07/28 09:35:11 $
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 org.apache.slide.common.SlideToken;
27 import org.apache.slide.common.Namespace;
28 import org.apache.slide.content.Content;
29 import org.apache.slide.structure.Structure;
30
31 /**
32  * Represents the context of a search requerst.
33  *
34  * @version $Revision: 1.3 $
35  */
36 public interface ISearchToken {
37     
38     
39     /**
40      * Method getNamespace
41      *
42      * @return the namespace
43      *
44      */
45     public Namespace getNamespace ();
46     
47     /**
48      * Method getSlideToken
49      *
50      * @return the slideToken
51      *
52      */
53     public SlideToken getSlideToken();
54     
55     /**
56      * Method getContentHelper
57      *
58      * @return the contentHelper
59      *
60      */
61     public Content getContentHelper();
62     
63     /**
64      * Method getStructureHelper
65      *
66      * @return the structureHelper
67      *
68      */
69     public Structure getStructureHelper();
70     
71     /**
72      * Method getMaxDepth
73      *
74      * @return max depth as configured in Domain.xml
75      *
76      */
77     public int getMaxDepth();
78     
79     /**
80      * Method getSlideContext
81      *
82      * @return a SlideUri
83      *
84      */
85     public SlideUri getSlideContext ();
86 }
87
88
Popular Tags