/*
 * $Header: /home/cvspublic/jakarta-slide/src/share/org/apache/slide/search/ISearchToken.java,v 1.3 2004/07/28 09:35:11 ib Exp $
 * $Revision: 1.3 $
 * $Date: 2004/07/28 09:35:11 $
 *
 * ====================================================================
 *
 * Copyright 1999-2002 The Apache Software Foundation 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.apache.slide.search;

import org.apache.slide.common.SlideToken;
import org.apache.slide.common.Namespace;
import org.apache.slide.content.Content;
import org.apache.slide.structure.Structure;

/**
 * Represents the context of a search requerst.
 *
 * @version $Revision: 1.3 $
 */
public interface ISearchToken {
    
    
    /**
     * Method getNamespace
     *
     * @return   the namespace
     *
     */
    public Namespace getNamespace ();
    
    /**
     * Method getSlideToken
     *
     * @return   the slideToken
     *
     */
    public SlideToken getSlideToken();
    
    /**
     * Method getContentHelper
     *
     * @return   the contentHelper
     *
     */
    public Content getContentHelper();
    
    /**
     * Method getStructureHelper
     *
     * @return   the structureHelper
     *
     */
    public Structure getStructureHelper();
    
    /**
     * Method getMaxDepth
     *
     * @return   max depth as configured in Domain.xml
     *
     */
    public int getMaxDepth();
    
    /**
     * Method getSlideContext
     *
     * @return   a SlideUri
     *
     */
    public SlideUri getSlideContext ();
}

