SearchOSGiService.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.search;

import org.wso2.carbon.registry.core.exceptions.RegistryException;
import org.wso2.carbon.registry.core.session.UserRegistry;

import java.util.Map;

/**
 * API to perform a search through an OSGi service
 *
 * @param <Input> the input for the search
 * @param <Output> the output of the search operation
 */
public interface SearchOSGiService<Input, Output> {

    /**
     * Method to search for results matching the given parameters from the registry instance
     * provided.
     *
     * @param registry the registry instance to be used.
     * @param input    the input for the search
     *
     * @return search results.
     * @throws RegistryException if the operation failed.
     */
    public Output search(UserRegistry registry, Input input) throws RegistryException;

    /**
     * Method to search for results matching the given parameters for the given tenant.
     *
     * @param tenantId the identifier of the tenant.
     * @param input    the input for the search
     *
     * @return search results.
     * @throws RegistryException if the operation failed.
     */
    public Output search(int tenantId, Input input) throws RegistryException;

    /**
     * Method to search for results matching the given parameters.
     *
     * @param input the input for the search
     *
     * @return search results.
     * @throws RegistryException if the operation failed.
     */
    public Output search(Input input) throws RegistryException;

}