IContentBasedSearchService.java

/*
 *  Copyright (c) 2005-2009, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 *  WSO2 Inc. licenses this file to you 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.wso2.carbon.registry.admin.api.indexing;

import org.apache.axis2.AxisFault;

/**
 * Provides functionality to search inside resource content.
 *
 * @param <SearchResultsBean> The results of the executed search
 */
public interface IContentBasedSearchService<SearchResultsBean> {

    /**
     * Method to do a search of the given query in the content of the resources on the registry.
     *
     * @param searchQuery the search query, should contain a word (or phrase), you want to search
     *                    for.
     * @return            the search results
     *
     * @throws AxisFault if the operation failed.
     */
    SearchResultsBean getContentSearchResults(String searchQuery) throws AxisFault;
}